Docs For Class sbVfs

Описание

Класс работы с файловой системой сервера

Данный класс работает с файловой системой сервера либо локально, либо через FTP в зависимости от настроек системы (config.inc.php). После обявления класса вызывается конструктор класса и ссылка на класс сохраняется в глобальной переменной $GLOBALS['sbVfs'].

author: Казбек Елекоев <elekoev@binn.ru>
version: 4.0
copyright: Copyright (c) 2007, OOO "СИБИЭС Групп"
see: config.inc.php
see: $GLOBALS['sbVfs']

Располагается в /lib/sbVfs.inc.php (строка 29)

Переменные (список)

resource $mDirHandle

octal $mDirMode

string $mDomain

resource $mFileHandle

octal $mFileMode

bool $mLocal

Методы (список)

sbVfs __construct (string $ftp_host, string $ftp_basedir, [string $ftp_user = array()], [string $ftp_password = array()])

bool chmod (string $path, int $mode)

bool closedir ([resource $handle = false])

bool copy (string $src, string $dest_real, [bool $overwrite = false])

bool delete (string $path)

bool exists (string $path)

bool fclose ([resource $handle = false])

bool feof ([resource $handle = false])

char fgetc ([resource $handle = false])

array fgetcsv ([resource $handle = false], [int $length = 1024], [char $del = ';'])

string fgets ([int $length = -1], [resource $handle = false])

array file (string $path)

int filectime (string $path)

mixed fileperms (string $path)

int filesize (string $path)

string file_get_contents (string $path)

int file_put_contents (string $path, mixed $data)

resource fopen (string $path, string $mode)

int fpassthru ([resource $handle = false])

string fread (int $length, [resource $handle = false])

int fseek (int $offset, [resource $handle = false])

int ftell ([resource $handle = false])

int fwrite (string $str, [resource $handle = false])

mixed getimagesize (string $path)

mixed imagecreatefromgif (string $path)

mixed imagecreatefromjpeg (string $path)

mixed imagecreatefrompng (string $path)

bool imagegif (handle $img, string $path)

bool imagejpeg (handle $img, string $path, [int $quality = 100])

bool imagepng (handle $img, string $path, [int $quality = 0])

bool is_dir (string $path)

bool is_file (string $path)

bool is_readable (string $path)

bool is_writable (string $path)

bool mkdir (string $path)

bool move_uploaded_file (string $tmp_name, string $file_name)

resource opendir (string $path)

string readdir ([resource $handle = false])

bool rename (string $old_path, string $new_path)

array scandir (string $path)

Переменные

resource $mDirHandle = false (строка 54)

Дескриптор последней открытой c помощью метода opendir() директории

access: public

octal $mDirMode (строка 47)

Права на создаваемые директории

Восьмиричное число. Например, для установки прав 755, присвойте данной переменной значение octdec(755);

access: public

string $mDomain = SB_COOKIE_DOMAIN (строка 75)

Домен, для которого используется соединение

access: public

resource $mFileHandle = false (строка 61)

Дескриптор последнего открытого c помощью метода fopen() файла

access: public

octal $mFileMode (строка 38)

Права на создаваемые файлы

Восьмиричное число. Например, для установки прав 755, присвойте данной переменной значение octdec(755);

access: public

bool $mLocal = false (строка 68)

Ведется работа с локальной файловой системой или с удаленной

access: public

Методы

Конструктор __construct (строка 145)

Конструктор класса

Переменные класса mFileMode и mDirMode получают значения octdec(755).

see: sbVfs::$mFileMode
see: sbVfs::$mDirMode
access: public

sbVfs __construct (string $ftp_host, string $ftp_basedir, [string $ftp_user = array()], [string $ftp_password = array()])

string $ftp_host: Хост и порт для FTP (local для локальной работы)
string $ftp_basedir: Абсолютный путь до рутовой директории FTP-аккаунта
string $ftp_user: Имя пользователя для FTP
string $ftp_password: Пароль для FTP

chmod (строка 1003)

Меняет атрибуты доступа к файлу

Только при работе с файловой системой локально.

return: TRUE, если удалось сменить атрибуты, и FALSE в ином случае.
access: public

bool chmod (string $path, int $mode)

string $path: Путь к файлу
int $mode: Десятичное число, задающее права доступа (например 755).

closedir (строка 193)

Закрывает директорию

Если передан параметр $handle и он является дескриптором открытой директории, то закрывается эта директория. Иначе используется переменная класса mDirHandle.

return: TRUE в случае успеха и FALSE в случае неудачи.
access: public

bool closedir ([resource $handle = false])

resource $handle: Дескриптор директории.

copy (строка 238)

Копирует файл или директорию

Если в качестве параметра $src передается имя файла, то параметр $dest_real также обязательно должен быть именем файла. С помощью данного метода можно также переименовывать файлы. Если в качестве параметра $src передается имя директории, то параметр $dest_real также обязательно должен быть именем директории. В этом случае в директории $dest_real будет создана поддиректория.

return: TRUE в случае успешного копирования, FALSE в случае неудачи
access: public

bool copy (string $src, string $dest_real, [bool $overwrite = false])

string $src: Путь к копируемому файлу или директории.
string $dest_real: Путь к новому файлу (копии) или директории.
bool $overwrite: Перезаписывать файл или нет (TRUE - перезаписывать, FALSE - нет

delete (строка 610)

Удаляет файл или директорию

return: TRUE - если удаление прошло успешно и FALSE в ином случае
access: public

bool delete (string $path)

string $path: Путь к удаляемому файлу или директории.

exists (строка 447)

Проверяет, существует ли файл или директория

return: TRUE, если файл существует, FALSE в ином случае.
access: public

bool exists (string $path)

string $path: Путь к файлу или директории.

fclose (строка 794)

Закрывает файл

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

return: TRUE в случае успеха и FALSE в противном случае.
access: public

bool fclose ([resource $handle = false])

resource $handle: Дескриптор файла. Если не передан, используется дескриптор, возвращенный последним вызовом метода fopen.

feof (строка 815)

Определяет, находится ли внутренний указатель файла в конце файла

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

return: TRUE, если указатель в конце файла и FALSE в ином случае.
access: public

bool feof ([resource $handle = false])

resource $handle: Дескриптор файла. Если не передан, используется дескриптор, возвращенный последним вызовом метода fopen.

fgetc (строка 832)

Считывает следующий символ из файла

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

return: Считанный символ или FALSE, если указатель в конце файла.
access: public

char fgetc ([resource $handle = false])

resource $handle: Дескриптор файла. Если не передан, используется дескриптор, возвращенный последним вызовом метода fopen.

fgetcsv (строка 850)

Считывает строку из файла и парсит ее как CSV-формат

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

return: Массив считанных полей или FALSE в случае возникновения ошибки.
access: public

array fgetcsv ([resource $handle = false], [int $length = 1024], [char $del = ';'])

resource $handle: Дескриптор файла. Если не передан, используется дескриптор, возвращенный последним вызовом метода fopen.
int $length: Максимальная длина считываемой строки.
char $del: Разделитель полей CSV-формата.

fgets (строка 867)

Считывает строку из файла

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

return: Считанная строка или FALSE в случае возникновения ошибки.
access: public

string fgets ([int $length = -1], [resource $handle = false])

int $length: Максимальное кол-во символов в считываемой строке.
resource $handle: Дескриптор файла. Если не передан, используется дескриптор, возвращенный последним вызовом метода fopen.

file (строка 929)

Считывает содержимое файла в массив

return: Массив строк из файла или FALSE в случае ошибки.
access: public

array file (string $path)

string $path: Путь к файлу.

filectime (строка 966)

Возвращает время последнего изменения файла

return: Время последнего изменения файла (UNIX TIMESTAMP) или FALSE в случае ошибки.
access: public

int filectime (string $path)

string $path: Путь к файлу.

fileperms (строка 1484)

Возвращает атрибуты файла или директории

return: Число, соотв. атрибутам файла или директории, или FALSE в случае ошибки.
access: public

mixed fileperms (string $path)

string $path: Путь к файлу или директории.

filesize (строка 942)

Возвращает размер файла в байтах

return: Размер файла в байтах или FALSE в случае ошибки.
access: public

int filesize (string $path)

string $path: Путь к файлу.

file_get_contents (строка 884)

Возвращает содержимое всего файла в виде строки

return: Содержимое файла или FALSE в случае возникновения ошибки.
access: public

string file_get_contents (string $path)

string $path: Путь к файлу.

file_put_contents (строка 900)

Заменяет содержимое файла переданными данными

Если файл не существует, он будет создан.

return: Кол-во записанных в файл байт или FALSE в случае ошибки
access: public

int file_put_contents (string $path, mixed $data)

string $path: Путь к файлу.
mixed $data: Строка или массив с данными, которые следует записать в файл.

fopen (строка 753)

Открывает файл на чтение или запись

return: Дескриптор файла или FALSE, если файл открыть не удалось.
access: public

resource fopen (string $path, string $mode)

string $path: Путь к файлу.
string $mode: Режим открытия файла (r - чтение, w - запись).

fpassthru (строка 986)

Выводит содержимое файла в браузер пользователя

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

return: Кол-во выведенных символов или FALSE в случае ошибки.
access: public

int fpassthru ([resource $handle = false])

resource $handle: Дескриптор файла. Если не передан, используется дескриптор, возвращенный последним вызовом метода fopen.

fread (строка 1023)

Считывает заданное кол-во байтов из файла

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

return: Считанная строка или FALSE в случае возникновения ошибки.
access: public

string fread (int $length, [resource $handle = false])

int $length: Кол-во символов, которое необходимо считать.
resource $handle: Дескриптор файла. Если не передан, используется дескриптор, возвращенный последним вызовом метода fopen.

fseek (строка 1041)

Устанавливает внутренний указатель файла в нужную позицию

Только при работе с файловой системой локально.

return: 0 в случае успешного выполнения и -1 в случае ошибки.
access: public

int fseek (int $offset, [resource $handle = false])

int $offset: Позиция указателя, относительно начала файла.
resource $handle: Дескриптор файла. Если не передан, используется дескриптор, возвращенный последним вызовом метода fopen.

ftell (строка 1059)

Возвращает пощицию внутреннего указателя файла

return: Позиция внутреннего указателя или FALSE в случае возникновения ошибки.
access: public

int ftell ([resource $handle = false])

resource $handle: Дескриптор файла. Если не передан, используется дескриптор, возвращенный последним вызовом метода fopen.

fwrite (строка 1074)

Записывает строку в файл

return: Кол-во записанных байт или FALSE в случае возникновения ошибки.
access: public

int fwrite (string $str, [resource $handle = false])

string $str: Строка, которую необходимо записать.
resource $handle: Дескриптор файла. Если не передан, используется дескриптор, возвращенный последним вызовом метода fopen.

getimagesize (строка 1229)

Возвращает информацию об изображении

return: Информация об изображении или FALSE в случае ошибки.
access: public

mixed getimagesize (string $path)

string $path: Путь к файлу с изображением.

imagecreatefromgif (строка 1268)

Возвращает идентификатор изображения, сформированного из файла

return: Идентификатор изображения или FALSE в случае ошибки.
access: public

mixed imagecreatefromgif (string $path)

string $path: Путь к файлу.

imagecreatefromjpeg (строка 1242)

Возвращает идентификатор изображения, сформированного из файла

return: Идентификатор изображения или FALSE в случае ошибки.
access: public

mixed imagecreatefromjpeg (string $path)

string $path: Путь к файлу.

imagecreatefrompng (строка 1255)

Возвращает идентификатор изображения, сформированного из файла

return: Идентификатор изображения или FALSE в случае ошибки.
access: public

mixed imagecreatefrompng (string $path)

string $path: Путь к файлу.

imagegif (строка 1420)

Генерирует файл с изображением по дескриптору изображения

return: TRUE, если файл сгенерирован, и FALSE в ином случае.
access: public

bool imagegif (handle $img, string $path)

handle $img: Дескриптор изображения.
string $path: Путь и имя генерируемого файла.

imagejpeg (строка 1289)

Генерирует файл с изображением по дескриптору изображения

return: TRUE, если файл сгенерирован, и FALSE в ином случае.
access: public

bool imagejpeg (handle $img, string $path, [int $quality = 100])

handle $img: Дескриптор изображения.
string $path: Путь и имя генерируемого файла.
int $quality: Качество файла (от 0 до 100).

imagepng (строка 1355)

Генерирует файл с изображением по дескриптору изображения

return: TRUE, если файл сгенерирован, и FALSE в ином случае.
access: public

bool imagepng (handle $img, string $path, [int $quality = 0])

handle $img: Дескриптор изображения.
string $path: Путь и имя генерируемого файла.
int $quality: Сжатие файла (от 0 до 9).

is_dir (строка 565)

Проверяет, является ли переданный параметр директорией

return: TRUE, если директория и FALSE в ином случае.
access: public

bool is_dir (string $path)

string $path: Путь к директории.

is_file (строка 545)

Проверяет, является ли переданный параметр файлом

return: TRUE, если файл и FALSE в ином случае.
access: public

bool is_file (string $path)

string $path: Путь к файлу.

is_readable (строка 1090)

Проверяет, существует ли файл и доступен ли он для чтения

Только при работе с файловой системой локально.

return: TRUE если файл существует и доступен для чтения и FALSE в ином случае.
access: public

bool is_readable (string $path)

string $path: Путь к файлу.

is_writable (строка 1108)

Проверяет, существует ли файл и доступен ли он для записи

Только при работе с файловой системой локально.

return: TRUE если файл существует и доступен для записи и FALSE в ином случае.
access: public

bool is_writable (string $path)

string $path: Путь к файлу.

mkdir (строка 496)

Создает полностью путь

return: TRUE, если путь создан корректно, FALSE в ином случае.
access: public

bool mkdir (string $path)

string $path: Путь, который надо создать.

move_uploaded_file (строка 1155)

Перемещает загруженный файл из темповой директории в указанное место

return: TRUE, если файл перемещен успешно, FALSE в ином случае.
access: public

bool move_uploaded_file (string $tmp_name, string $file_name)

string $tmp_name: Имя темпового файла.
string $file_name: Путь к файлу с именем файла, куда сохраняем темповый файл.

opendir (строка 162)

Открывает директорию для последующих операций с ней

return: Дескриптор открытой директории или FALSE.
access: public

resource opendir (string $path)

string $path: Путь к директории, которую следует открыть.

readdir (строка 212)

Возвращает следующее имя файла или директории

Если параметр $handle является дескриптором открытой директории, то чтение идет из этой директории. Иначе используется переменная класса mDirHandle.

return: Имя файла или директории или FALSE в случае неудачи.
access: public

string readdir ([resource $handle = false])

resource $handle: Дескриптор открытой директории.

rename (строка 528)

Переименовывает директорию или файл

return: TRUE, если переименование прошло успешно, FALSE в ином случае.
access: public

bool rename (string $old_path, string $new_path)

string $old_path: Путь к директории или файлу.
string $new_path: Путь к переименованной директории или файлу.

scandir (строка 675)

Считывает содержимое директории

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

return: Список директорий и файлов, расположенных в указанной директории.
access: public

array scandir (string $path)

string $path: Путь к директории.

Техническая поддержка:

Сайт: http://www.sbuilder.ru/tec_support.php
E-mail: support@sbuilder.ru