Files Library GameAP: различия между версиями

Материал из HLDM Wiki
Перейти к навигации Перейти к поиску
(→‎Основные функции)
Строка 89: Строка 89:
 
Список файлов.
 
Список файлов.
 
  list_files( string $path = '.' [, bool $recursive = false])
 
  list_files( string $path = '.' [, bool $recursive = false])
−
:path
+
:'''path'''
 
::Директория, файлы в которой необходимо получить.
 
::Директория, файлы в которой необходимо получить.
−
:recursive
+
:'''recursive'''
 
::Рекурсивно в подкаталогах
 
::Рекурсивно в подкаталогах
  
Строка 97: Строка 97:
 
Список файлов с информацией о последнем изменении и размере.
 
Список файлов с информацией о последнем изменении и размере.
 
  list_files_full_info( string $path = '.' [, array $extensions])
 
  list_files_full_info( string $path = '.' [, array $extensions])
−
:path
+
:'''path'''
 
::Директория, файлы в которой необходимо получить.
 
::Директория, файлы в которой необходимо получить.
−
:extensions
+
:'''extensions'''
 
::Массив с расширениями файлов. Если задан, то будут получены лишь указанные типы файлов.
 
::Массив с расширениями файлов. Если задан, то будут получены лишь указанные типы файлов.
  
 
=== mkdir ===
 
=== mkdir ===
 
Создание директории.
 
Создание директории.
 +
mkdir ( string $dir )
 +
:'''dir'''
 +
::Директория
  
 
=== move ===
 
=== move ===
−
Перемещение.
+
Перемещение файла или директории.
 +
move(string $old_file, string $new_file)
 +
:'''old_file'''
 +
::Старый путь
 +
:'''new_file'''
 +
::Новый путь
  
 
=== read_file ===
 
=== read_file ===
 
Чтение файла.
 
Чтение файла.
 +
read_file ( string $remfile )
 +
:'''remfile'''
 +
::Путь к файлу
  
 
=== write_file ===
 
=== write_file ===
 
Запись файла.
 
Запись файла.
 +
write_file( string $remfile, string $data = '')
 +
:'''remfile'''
 +
::Путь к файлу
 +
:data
 +
::Текстовые данные
  
 
=== rename ===
 
=== rename ===
−
Переименование.
+
Переименование файла.
 +
rename(string $old_file, string $new_file [, bool $move])
 +
:'''old_file'''
 +
::Старое имя
 +
:'''new_file'''
 +
::Новое имя
 +
:'''move'''
 +
::Перемещение файла
  
 
=== search ===
 
=== search ===
−
Поиск.
+
Поиск файла. Возвращает путь к первому найденному вхождению.
 +
search(string $file [ , string $dir = '/' ] [ , array $exclude_dirs = array() ] [ , int $depth = 4 ] )
 +
:'''file'''
 +
::Имя файла, который необходимо найти
 +
:'''dir'''
 +
::Директория, в которой будет происходить поиск
 +
:'''exclude_dirs'''
 +
::Директории, которые будут игнорироваться
 +
:'''depth'''
 +
::Глубина рекурсии
  
 
=== upload ===
 
=== upload ===
 
Загрузка файла на сервер.
 
Загрузка файла на сервер.
 +
upload(string $locpath, string $rempath)
 +
 +
:'''locpath'''
 +
::Локальный путь
 +
:'''rempath'''
 +
::Путь на сервере
  
 
{{Категория:Документация_для_разработчиков}}
 
{{Категория:Документация_для_разработчиков}}

Версия 16:10, 15 мая 2014


Библиотека для работы с файлами на выделенном сервере.

Расположение

application/libraries/Files/

Загрузка библиотеки

$this->load->driver('files');

Задание данных

set_driver

Задает значение протокола управления файлами. 

set_driver ( string $driver )

Список доступных опций:

Название Описание
local Локальный протокол.
ftp FTP протокол управления файлами.
sftp SFTP протокол управления файлами.

Основные функции

connect

Соединение с сервером. Если используется локальный протокол управления, то всегда вернет true. 

connect(array $config)
config
Массив с параметрами для соединения с сервером.
Значение Описание
hostname Хост
port Порт
username Логин
password Пароль

Примеры: 

$config['hostname'] = '127.0.0.1';
$config['port'] = 21;
$config['username'] = 'ftp_user';
$congif['password'] = 'pass123';

try {
    $this->files->connect($config);
} catch (Exception $e) {
    exit('Ошибка: ' . $e->getMessage());
}

delete_dir

Удаление директории. 

delete_dir ( string $path )

delete_file

Удаление файла. 

delete_file ( string $path )

download

Загружает файлы с сервера. 

download ( string $rempath, string $locpath )
rempath
Путь на сервере
locpath
Локальный путь

Пример: 

 $this->files->download('/public_html/myfile.html', '/local/path/to/myfile.html');

list_files

Список файлов. 

list_files( string $path = '.' [, bool $recursive = false])
path
Директория, файлы в которой необходимо получить.
recursive
Рекурсивно в подкаталогах

list_files_full_info

Список файлов с информацией о последнем изменении и размере. 

list_files_full_info( string $path = '.' [, array $extensions])
path
Директория, файлы в которой необходимо получить.
extensions
Массив с расширениями файлов. Если задан, то будут получены лишь указанные типы файлов.

mkdir

Создание директории. 

mkdir ( string $dir )
dir
Директория

move

Перемещение файла или директории. 

move(string $old_file, string $new_file)
old_file
Старый путь
new_file
Новый путь

read_file

Чтение файла. 

read_file ( string $remfile )
remfile
Путь к файлу

write_file

Запись файла. 

write_file( string $remfile, string $data = )
remfile
Путь к файлу
data
Текстовые данные

rename

Переименование файла. 

rename(string $old_file, string $new_file [, bool $move])
old_file
Старое имя
new_file
Новое имя
move
Перемещение файла

search

Поиск файла. Возвращает путь к первому найденному вхождению. 

search(string $file [ , string $dir = '/' ] [ , array $exclude_dirs = array() ] [ , int $depth = 4 ] )
file
Имя файла, который необходимо найти
dir
Директория, в которой будет происходить поиск
exclude_dirs
Директории, которые будут игнорироваться
depth
Глубина рекурсии

upload

Загрузка файла на сервер. 

upload(string $locpath, string $rempath)
locpath
Локальный путь
rempath
Путь на сервере
Источник — https://wiki.hldm.org/index.php?title=Files_Library_GameAP&oldid=1477