Класс Folder

__construct()source public

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

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

Параметры

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

Путь к папке

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

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

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

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

_findRecursive()source protected

_findRecursive( string $pattern , boolean $sort false )

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

Параметры

string $pattern

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

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

Сортировать ли результаты.

Возвращает

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

addPathElement()source public static

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

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

Параметры

string $path

Путь

string|array $element

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

Возвращает

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

cd()source public

cd( string $path )

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

Параметры

string $path

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

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

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

chmod()source public

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

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

Параметры

string $path

Путь к файлам/директориям, права доступа которых необходимо изменить.

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

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

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

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

array $exceptions необязательно []

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

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

boolean
Успешно.

copy()source public

copy( array|string $options )

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

Параметры

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

Параметры

array|string $options

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

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

boolean
Успешно.

correctSlashFor()source public static

correctSlashFor( string $path )

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

Параметры

string $path

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

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

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

create()source public

create( string $pathname , integer|boolean $mode false )

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

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

Параметры

string $pathname

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

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

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

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

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

delete()source public

delete( string|null $path null )

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

Параметры

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

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

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

boolean
Успешно

dirsize()source public

dirsize( )

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

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

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

errors()source public

errors( boolean $reset true )

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

Параметры

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

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

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

array

find()source public

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

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

Параметры

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

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

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

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

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

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

findRecursive()source public

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

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

Параметры

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

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

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

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

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

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

inCakePath()source public

inCakePath( string $path '' )

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

Устаревший

3.2.12 Этот метод будет удален в версии 4.0.0. Используйте вместо него inPath().

Параметры

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

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

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

boolean

inPath()source public

inPath( string $path , boolean $reverse false )

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

Параметры

string $path

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

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

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

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

boolean

Исключения

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

isAbsolute()source public static

isAbsolute( string $path )

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

Параметры

string $path

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

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

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

isRegisteredStreamWrapper()source public static

isRegisteredStreamWrapper( string $path )

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

Параметры

string $path

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

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

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

isSlashTerm()source public static

isSlashTerm( string $path )

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

Параметры

string $path

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

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

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

isWindowsPath()source public static

isWindowsPath( string $path )

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

Параметры

string $path

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

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

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

messages()source public

messages( boolean $reset true )

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

Параметры

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

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

Возвращает

array

move()source public

move( array|string $options )

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

Параметры

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

Параметры

array|string $options

(to, from, chmod, skip, scheme)

Возвращает

boolean
Успех

normalizePath()source public static

normalizePath( string $path )

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

Параметры

string $path

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

Возвращает

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

pwd()source public

pwd( )

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

Возвращает

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

read()source public

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

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

Параметры

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

Необходимо ли сортировать результаты, установите это и свойство сортировки в false, чтобы получить несортированные результаты.

array|boolean $exceptions необязательно false

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

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

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

Возвращает

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

realpath()source public

realpath( string $path )

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

Параметры

string $path

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

Возвращает

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

slashTerm()source public static

slashTerm( string $path )

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

Параметры

string $path

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

Возвращает

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

subdirectories()source public

subdirectories( string|null $path null , boolean $fullPath true )

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

Параметры

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

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

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

Возвращать полный путь или только имя директории.

Возвращает

array
Массив подкаталогов для указанного или текущего пути.

tree()source public

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

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

Параметры

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

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

array|boolean $exceptions необязательно false

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

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

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

Возвращает

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

[]

[
    self::SORT_NAME => 'getPathname',
    self::SORT_TIME => 'getCTime'
]

[]

0755

false