Класс Folder

__constructисходный код public

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

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

Параметры

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

Путь к папке

логическое значение $create необязательно false

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

строка|логическое значение $mode необязательно false

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

Ссылка

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

_findRecursiveисходный код protected

_findRecursive( string $pattern , boolean $sort false )

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

Параметры

строка $pattern

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

логическое значение $sort необязательно false

Требуется ли сортировка результатов.

Возвращает

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

addPathElementисходный код public static

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

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

Параметры

строка $path

Путь

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

Элемент для добавления в конец пути

Возвращает

string
Объединенный путь

Ссылка

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

cdисходный код public

cd( string $path )

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

Параметры

строка $path

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

Возвращает

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

Ссылка

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

chmodисходный код public

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

Рекурсивно изменить режим каталога. Это включает изменение режима файлов тоже.

Параметры

строка $path

Путь к папке, для которой необходимо изменить режим.

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

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

логическое значение $recursive необязательно true

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

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

Массив файлов и директорий для пропуска.

Возвращает

boolean
Успех.

Ссылка

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

copyисходный код public

copy( array|string $options )

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

Параметры

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

Параметры

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

Либо массив параметров (см. выше), либо строка назначения каталога.

Возвращает

boolean
Успех.

Ссылка

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

correctSlashForисходный код public static

correctSlashFor( string $path )

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

Параметры

строка $path

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

Возвращает

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

Ссылка

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

createисходный код public

create( string $pathname , integer $mode false )

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

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

Параметры

строка $pathname

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

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

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

Возвращает

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

Ссылка

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

deleteисходный код public

delete( string $path null )

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

Параметры

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

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

Возвращает

boolean
Успех

Ссылка

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

dirsizeисходный код public

dirsize( )

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

Возвращает

integer
Размер в байтах текущей папки

Ссылка

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

errorsисходный код public

errors( boolean $reset true )

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

Параметры

логическое значение $reset необязательно true

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

Возвращает

array
массив

Ссылка

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

findисходный код public

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

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

Параметры

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

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

логическое значение $sort необязательно false

Требуется ли сортировка результатов.

Возвращает

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

Ссылка

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

findRecursivesource public

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

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

Параметры

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

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

логическое значение $sort необязательно false

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

Возвращаемое значение

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

Ссылка

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

inCakePathsource public

inCakePath( string $path '' )

Возвращает true, если файл находится в заданном CakePath.

Параметры

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

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

Возвращаемое значение

boolean
bool

Ссылка

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

inPathsource public

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

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

Параметры

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

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

логическое значение $reverse необязательно false

Инвертировать поиск, проверить, что pwd() находится внутри $path.

Возвращаемое значение

boolean
bool

Ссылка

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

isAbsolutesource public static

isAbsolute( string $path )

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

Параметры

строка $path

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

Возвращаемое значение

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

Ссылка

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

isRegisteredStreamWrappersource public static

isRegisteredStreamWrapper( string $path )

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

Параметры

строка $path

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

Возвращаемое значение

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

isSlashTermsource public static

isSlashTerm( string $path )

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

Параметры

строка $path

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

Возвращаемое значение

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

Ссылка

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

isWindowsPathsource public static

isWindowsPath( string $path )

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

Параметры

строка $path

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

Возвращаемое значение

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

Ссылка

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

messagessource public

messages( boolean $reset true )

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

Параметры

логическое значение $reset необязательно true

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

Возвращаемое значение

array
массив

Ссылка

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

movesource public

move( array $options )

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

Опции

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

Параметры

массив $options

(to, from, chmod, skip, scheme)

Возвращаемое значение

boolean
Успех

Ссылка

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

normalizePathsource public static

normalizePath( string $path )

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

Параметры

строка $path

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

Возвращаемое значение

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

Ссылка

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

pwdsource public

pwd( )

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

Возвращаемое значение

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

Ссылка

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

readsource public

read( boolean $sort true , array|boolean $exceptions false , boolean $fullPath false )

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

Параметры

логическое значение $sort необязательно true

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

массив или логическое значение $exceptions необязательно false

Массив или логическое значение true для игнорирования файлов, начинающихся с точки (".")

логическое значение $fullPath необязательно false

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

Возвращаемое значение

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

Ссылка

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

realpathsource public

realpath( string $path )

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

Параметры

строка $path

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

Возвращаемое значение

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

Ссылка

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

slashTermsource public static

slashTerm( string $path )

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

Параметры

строка $path

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

Возвращаемое значение

string
Путь с заключительным слешем

Ссылка

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

treesource public

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

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

Параметры

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

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

массив|логическое $exceptions необязательно false

Массив файлов/каталогов для исключения или логическое значение true, чтобы не брать точки файлов/каталогов

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

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

Возвращает

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

Ссылка

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

array()

array()

0755

null

false