Класс 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 для игнорирования

Ссылка

http://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

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

Возвращает

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

Ссылка

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

cd()source public

cd( string $path )

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

Параметры

string $path

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

Возвращает

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

Ссылка

http://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() )

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

Параметры

string $path

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

integer $mode необязательно false

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

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

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

array $exceptions необязательно array()

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

Возвращает

boolean
Успех.

Ссылка

http://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

Параметры

array|string $options

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

Возвращает

boolean
Успех.

Ссылка

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

correctSlashFor()source public static

correctSlashFor( string $path )

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

Параметры

string $path

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

Возвращает

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

Ссылка

http://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

Параметры

string $pathname

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

integer $mode необязательно false

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

Возвращает

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

Ссылка

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

delete()source public

delete( string $path null )

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

Параметры

string $path необязательно null

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

Возвращает

boolean
Успех

Ссылка

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

dirsize()source public

dirsize( )

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

Возвращает

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

Ссылка

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

errors()source public

errors( boolean $reset true )

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

Параметры

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

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

Возвращает

array

Ссылка

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

find()source public

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

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

Параметры

string $regexpPattern необязательно '.*'

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

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

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

Возвращает

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

Ссылка

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

findRecursive()source public

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

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

Параметры

string $pattern необязательно '.*'

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

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

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

Возвращает

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

Ссылка

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

inCakePath()source public

inCakePath( string $path '' )

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

Параметры

string $path необязательно ''

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

Возвращает

boolean

Ссылка

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

inPath()source public

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

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

Параметры

string $path необязательно ''

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

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

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

Возвращает

boolean

Исключения

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

Ссылка

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

isAbsolute()source 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

isRegisteredStreamWrapper()source public static

isRegisteredStreamWrapper( string $path )

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

Параметры

строка $path

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

Возвращает

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

isSlashTerm()source 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

isWindowsPath()source 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

messages()source public

messages( boolean $reset true )

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

Параметры

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

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

Возвращает

массив

Ссылка

http://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

Параметры

массив $options

(to, from, chmod, skip, scheme)

Возвращает

boolean
Успех

Ссылка

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

normalizePath()source public static

normalizePath( string $path )

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

Параметры

строка $path

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

Возвращает

строка
Набор косых черт ("\" или "/")

Ссылка

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

pwd()source public

pwd( )

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

Возвращает

строка
Текущий путь

Ссылка

http://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 )

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

Параметры

строка|boolean $sort необязательно self::SORT_NAME

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

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

Массив или boolean true, чтобы не брать файлы с точкой.

boolean $fullPath необязательно false

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

Возвращает

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

Ссылка

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

realpath()source public

realpath( string $path )

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

Параметры

строка $path

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

Возвращает

строка
Разрешенный путь

Ссылка

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

slashTerm()source public static

slashTerm( string $path )

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

Параметры

строка $path

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

Возвращает

строка
Путь с завершающим слешем

Ссылка

http://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 )

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

Параметры

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

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

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

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

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

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

Возвращает

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

Ссылка

http://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