File Helper

Файл File Helper содержит функции, которые помогают работать с файлами.

• Загрузка этого помощника
• Доступные функции

Загрузка этого помощника

Этот помощник загружается с помощью следующего кода:

$this->load->helper('file');

Доступные функции

Следующие функции доступны:

read_file($file)

Параметры:	$file (string) – Путь к файлу
Возвращает:	Содержимое файла или FALSE при ошибке
Тип возвращаемого значения:	string

Возвращает данные, содержащиеся в файле, указанном в пути.

Пример:

$string = read_file('./path/to/file.php');

Путь может быть относительным или полным серверным путем. Возвращает FALSE (boolean) при ошибке.

Примечание

Путь относительный к вашему главному файлу index.php сайта, а НЕ к вашим контроллерам или представлениям. CodeIgniter использует фронт-контроллер, поэтому пути всегда относительны к главному сайту index.

Примечание

Эта функция устаревшая. Используйте встроенную функцию file_get_contents() вместо неё.

Важно

Если на вашем сервере установлено ограничение open_basedir, эта функция может не работать, если вы пытаетесь получить доступ к файлу выше, чем вызывающий скрипт.

write_file($path, $data[, $mode = 'wb'])

Параметры:	$path (string) – Путь к файлу $data (string) – Данные для записи в файл $mode (string) – fopen() режим
Возвращает:	TRUE, если запись прошла успешно, FALSE в случае ошибки
Тип возвращаемого значения:	bool

Записывает данные в файл, указанный в пути. Если файл не существует, функция создаст его.

Пример:

$data = 'Some file data';
if ( ! write_file('./path/to/file.php', $data))
{
        echo 'Unable to write the file';
}
else
{
        echo 'File written!';
}

Вы можете дополнительно установить режим записи через третий параметр:

write_file('./path/to/file.php', $data, 'r+');

По умолчанию режим ‘wb’. Обратитесь к руководству пользователя PHP для вариантов режимов.

Примечание

Путь относительный к вашему главному файлу index.php сайта, а НЕ к вашим контроллерам или представлениям. CodeIgniter использует фронт-контроллер, поэтому пути всегда относительны к главному сайту index.

Примечание

Функция приобретает эксклюзивную блокировку файла во время записи в него.

delete_files($path[, $del_dir = FALSE[, $htdocs = FALSE]])

Параметры:	$path (string) – Путь к каталогу $del_dir (bool) – Удалять ли также каталоги $htdocs (bool) – Пропустить удаление файлов .htaccess и index
Возвращает:	TRUE при успехе, FALSE в случае ошибки
Тип возвращаемого значения:	bool

Удаляет ВСЕ файлы, содержащиеся в указанном пути.

Пример:

delete_files('./path/to/directory/');

Если второй параметр установлен в TRUE, все каталоги, содержащиеся в указанном корневом пути, будут удалены также.

Пример:

delete_files('./path/to/directory/', TRUE);

Примечание

Файлы должны быть доступны для записи или принадлежать системе, чтобы их можно было удалить.

get_filenames($source_dir[, $include_path = FALSE])

Параметры:	$source_dir (string) – Путь к каталогу $include_path (bool) – Включать ли путь как часть имён файлов
Возвращает:	Массив имён файлов
Тип возвращаемого значения:	array

Принимает серверный путь в качестве входных данных и возвращает массив, содержащий имена всех файлов, содержащихся в нём. Путь к файлу можно добавить к именам файлов, установив второй параметр в TRUE.

Пример:

$controllers = get_filenames(APPPATH.'controllers/');

get_dir_file_info($source_dir, $top_level_only)

Параметры:	$source_dir (string) – Путь к каталогу $top_level_only (bool) – Искать только в указанном каталоге (исключая подкаталоги)
Возвращает:	Массив, содержащий информацию о содержимом указанного каталога
Тип возвращаемого значения:	array

Считывает указанный каталог и создаёт массив, содержащий имена файлов, размер файлов, даты и разрешения. Подкаталоги, содержащиеся в указанном пути, считываются только если принудительно задан второй параметр в FALSE, так как это может быть ресурсоёмкая операция.

Пример:

$models_info = get_dir_file_info(APPPATH.'models/');

get_file_info($file[, $returned_values = array('name', 'server_path', 'size', 'date')])

Параметры:	$file (string) – Путь к файлу $returned_values (array) – Какой тип информации вернуть
Возвращает:	Массив, содержащий информацию об указанном файле или FALSE при ошибке
Тип возвращаемого значения:	array

По заданному файлу и пути возвращает (по желанию) атрибуты информации о файле: имя, путь, размер и последнюю дату изменения. Второй параметр позволяет явно указать, какую информацию нужно вернуть.

Допустимые $returned_values значения: name, size, date, readable, writeable, executable и fileperms.

get_mime_by_extension($filename)

Параметры:	$filename (string) – Имя файла
Возвращает:	Строка MIME-типа или FALSE при ошибке
Тип возвращаемого значения:	string

Преобразует расширение имени файла в MIME-тип на основе config/mimes.php. Возвращает FALSE, если тип не может быть определён или файл MIME-конфигурации не может быть прочитан.

$file = 'somefile.png';
echo $file.' is has a mime type of '.get_mime_by_extension($file);

Примечание

Это ненадёжный способ определения MIME-типов файлов и используется здесь только для удобства. Не следует использовать для целей безопасности.

symbolic_permissions($perms)

Параметры:	$perms (int) – Разрешения
Возвращает:	Строка символьных разрешений
Тип возвращаемого значения:	string

Принимает числовые разрешения (например, возвращаемые функцией fileperms()) и возвращает стандартную символьную запись разрешений файла.

echo symbolic_permissions(fileperms('./index.php'));  // -rw-r--r--

octal_permissions($perms)

Параметры:	$perms (int) – Разрешения
Возвращает:	Строка восьмеричных разрешений
Тип возвращаемого значения:	string

Принимает числовые разрешения (например, возвращаемые функцией fileperms()) и возвращает трёхзначную восьмеричную запись разрешений файла.

echo octal_permissions(fileperms('./index.php')); // 644