Класс Folder

__construct()source public

__construct( string $path false , boolean $create false , string|boolean $mode false )

Конструктор.

Параметры

string $path optional false

Путь к папке

boolean $create optional false

Создать папку, если она не найдена

string|boolean $mode optional false

Режим (CHMOD) для применения к созданной папке, false для игнорирования

Ссылка

https://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#Folder

_findRecursive()source protected

_findRecursive( string $pattern , boolean $sort false )

Вспомогательная приватная функция для findRecursive.

Параметры

string $pattern

Шаблон для сопоставления

boolean $sort optional false

Нужно ли сортировать результаты.

Возвращает

массив
Файлы, соответствующие шаблону

addPathElement()source public static

addPathElement( string $path , string|array $element )

Возвращает $path с добавленным $element и правильным слешем между ними.

Параметры

string $path

Путь

string|array $element

Элемент, который нужно добавить в конец пути

Возвращает

строка
Объединенный путь

Ссылка

https://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#Folder::addPathElement

cd()source public

cd( string $path )

Изменить текущую директорию на $path.

Параметры

строка $path

Путь к директории, на которую необходимо перейти

Возвращает

строка
Новый путь. Возвращает false при ошибке

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::cd

chmod()source public

chmod( string $path , integer $mode false , boolean $recursive true , array $exceptions array() )

Рекурсивно изменить права доступа на структуру директорий. Это включает в себя изменение прав доступа на файлы.

Параметры

строка $path

Путь к директории для изменения прав.

целое число $mode необязательно false

Восьмеричное значение, например, 0755.

булево $recursive необязательно true

Изменять права рекурсивно, установить в false, чтобы изменить только текущую директорию.

массив $exceptions необязательно array()

Массив файлов и директорий, которые нужно пропустить.

Возвращает

булево
Успех.

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::chmod

copy()source public

copy( array|string $options )

Рекурсивное копирование директорий.

Параметры

• to Директория для копирования.
• from Директория для копирования из. Это приведет к вызову cd(), изменив результаты pwd().
• mode Режим копирования файлов/директорий в виде целого числа, например, 0775.
• skip Файлы/директории для пропуска.
• scheme Folder::MERGE, Folder::OVERWRITE, Folder::SKIP

Параметры

массив|строка $options

Либо массив параметров (см. выше), либо строка с целевой директорией.

Возвращает

булево
Успех.

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::copy

correctSlashFor()source public static

correctSlashFor( string $path )

Возвращает правильный набор слешей для заданного $path. (\ для путей Windows и / для других путей).

Параметры

строка $path

Путь для проверки

Возвращает

строка
Набор слешей ("\" или "/")

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::correctSlashFor

create()source public

create( string $pathname , integer $mode false )

Рекурсивно создать структуру директорий.

Может использоваться для создания глубоких структур путей, например, /foo/bar/baz/shoe/horn

Параметры

строка $pathname

Структура директорий для создания. Абсолютный или относительный путь. Если путь относительный и существует в текущем каталоге процесса, он не будет создан. В противном случае относительные пути будут добавлены к текущему pwd().

целое число $mode необязательно false

восьмеричное значение 0755

Возвращает

булево
Возвращает TRUE при успехе, FALSE при ошибке

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::create

delete()source public

delete( string $path null )

Рекурсивно удалить директории, если система это позволяет.

Параметры

строка $path необязательно null

Путь к директории для удаления

Возвращает

булево
Успех

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::delete

dirsize()source public

dirsize( )

Возвращает размер текущей директории и её содержимого в байтах.

Возвращает

целое число
Размер текущей директории в байтах

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::dirsize

errors()source public

errors( boolean $reset true )

Получить ошибки от последнего метода

Параметры

булево $reset необязательно true

Сбросить стек ошибок после чтения

Возвращает

массив

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::errors

find()source public

find( string $regexpPattern '.*' , boolean $sort false )

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

Параметры

строка $regexpPattern необязательно '.*'

Шаблон preg_match (По умолчанию: .*)

булево $sort необязательно false

Должны ли результаты сортироваться.

Возвращает

массив
Файлы, соответствующие заданному шаблону

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::find

findRecursive()source public

findRecursive( string $pattern '.*' , boolean $sort false )

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

Параметры

строка $pattern необязательно '.*'

Шаблон preg_match (По умолчанию: .*)

булево $sort необязательно false

Должны ли результаты сортироваться.

Возвращает

массив
Файлы, соответствующие шаблону $pattern

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::findRecursive

inCakePath()source public

inCakePath( string $path '' )

Возвращает true, если папка находится в указанном пути Cake.

Параметры

строка $path необязательно ''

Путь для проверки.

Возвращает

булево

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::inCakePath

inPath()source public

inPath( string $path '' , boolean $reverse false )

Возвращает true, если папка находится в указанном пути.

Параметры

строка $path необязательно ''

Абсолютный путь для проверки, находится ли текущая pwd() внутри.

булево $reverse необязательно false

Перевернуть поиск, проверить, находится ли заданный $path внутри текущей pwd().

Возвращает

булево

Исключения

InvalidArgumentException
Когда переданный $path аргумент не является абсолютным путем.

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::inPath

isAbsolute()source public static

isAbsolute( string $path )

Возвращает true, если заданный $path — абсолютный путь.

Параметры

string $path

Путь для проверки

Возвращает

boolean
true, если путь абсолютный.

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::isAbsolute

isRegisteredStreamWrapper()source public static

isRegisteredStreamWrapper( string $path )

Возвращает true, если заданный $path — зарегистрированный обработчик потоков.

Параметры

string $path

Путь для проверки

Возвращает

boo
true, если путь зарегистрированный обработчик потоков.

isSlashTerm()source public static

isSlashTerm( string $path )

Возвращает true, если заданный $path оканчивается на слеш (т.е. имеет терминирующий слеш).

Параметры

string $path

Путь для проверки

Возвращает

boolean
true, если путь заканчивается на слеш, иначе false

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::isSlashTerm

isWindowsPath()source public static

isWindowsPath( string $path )

Возвращает true, если заданный $path — путь Windows.

Параметры

string $path

Путь для проверки

Возвращает

boolean
true, если путь Windows, иначе false

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::isWindowsPath

messages()source public

messages( boolean $reset true )

Получить сообщения из последнего метода

Параметры

boolean $reset опционально true

Сбросить стек сообщений после чтения

Возвращает

array

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::messages

move()source public

move( array $options )

Рекурсивное перемещение каталога.

Опции

• to Каталог назначения.
• from Каталог источника, это вызовет cd(), изменив результат pwd().
• chmod Режим копирования файлов/каталогов.
• skip Файлы/каталоги для пропуска.
• scheme Folder::MERGE, Folder::OVERWRITE, Folder::SKIP

Параметры

array $options

(to, from, chmod, skip, scheme)

Возвращает

boolean
Успех

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::move

normalizePath()source public static

normalizePath( string $path )

Возвращает правильный набор слешей для заданного $path. (\ для путей Windows и / для других путей.)

Параметры

string $path

Путь для проверки

Возвращает

string
Набор слешей ("\" или "/")

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::normalizePath

pwd()source public

pwd( )

Возвращает текущий путь.

Возвращает

string
Текущий путь

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::pwd

read()source public

read( string|boolean $sort self::SORT_NAME , array|boolean $exceptions false , boolean $fullPath false )

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

Параметры

string|boolean $sort опционально self::SORT_NAME

Требуется ли сортировка результатов, установите это и свойство sort в false, чтобы получить несортированные результаты.

array|boolean $exceptions опционально false

Массив или boolean true не будут брать точки файлов

boolean $fullPath опционально false

True возвращает полный путь

Возвращает

mixed
Содержимое текущего каталога в виде массива, пустой массив при ошибке

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::read

realpath()source public

realpath( string $path )

Получить реальный путь (учитывая "..", и т.д.)

Параметры

string $path

Путь для разрешения

Возвращает

string
Разрешенный путь

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::realpath

slashTerm()source public static

slashTerm( string $path )

Возвращает $path с добавленным терминирующим слэшем (корректируется для Windows или других ОС).

Параметры

string $path

Путь для проверки

Возвращает

string
Путь с конечным слэшем

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::slashTerm

tree()source public

tree( string $path null , array|boolean $exceptions false , string $type null )

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

Параметры

string $path опционально null

путь каталога для построения дерева

array|boolean $exceptions опционально false

Массив исключаемых файлов/каталогов или boolean true, чтобы не брать точки файлов/каталогов

string $type опционально null

либо 'file', либо 'dir'. null возвращает оба файла и каталоги

Возвращает

mixed
массив вложенных каталогов и файлов в каждом каталоге

Ссылка

https://book.cakephp.org/2.0/ru/core-utility-libraries/file-folder.html#Folder::tree

array()

array(
    self::SORT_NAME => 'getPathname',
    self::SORT_TIME => 'getCTime'
)

array()

0755

null

false