Spec-Zone.ru › CakePHP 2.9

Класс Folder

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

Пакет: Cake\Utility
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Utility/Folder.php

Резюме констант

  • string

    MERGE
    'merge'

  • string

    OVERWRITE
    'overwrite'

  • string

    SKIP
    'skip'

  • string

    SORT_NAME
    'name'

  • string

    SORT_TIME
    'time'

Резюме свойств

  • $_directories protected
    array
    Содержит массив полных путей к каталогам.
  • $_errors protected
    array
    Содержит ошибки последнего метода.
  • $_files protected
    array
    Содержит массив полных путей к файлам.
  • $_fsorts protected
    array
    Массив функций, которые будут вызваны в зависимости от выбранного типа сортировки.
  • $_messages protected
    array
    Содержит сообщения последнего метода.
  • $mode public
    integer
    Режим, который будет использоваться при создании. Ничего не делает в платформах Windows.
  • $path public
    string
    Путь к папке.
  • $sort public
    boolean

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

Резюме методов

  • __construct() public
    Конструктор.
  • _findRecursive() protected
    Вспомогательная функция для findRecursive.
  • addPathElement() public static
    Возвращает $path с добавленным $element, с правильным слешем между ними.
  • cd() public
    Изменение каталога на $path.
  • chmod() public
    Изменение режима структуры каталогов рекурсивно. Это также включает изменение режима файлов.
  • copy() public
    Рекурсивное копирование каталога.
  • correctSlashFor() public static
    Возвращает правильный набор слешей для заданного $path. (\ для путей Windows и / для других путей.)
  • create() public
    Рекурсивное создание структуры каталога.
  • delete() public
    Рекурсивное удаление каталогов, если система позволяет.
  • dirsize() public
    Возвращает размер в байтах этой папки и ее содержимого.
  • errors() public
    Получение ошибки из последнего метода
  • find() public
    Возвращает массив всех соответствующих файлов в текущем каталоге.
  • findRecursive() public
    Возвращает массив всех соответствующих файлов в и ниже текущего каталога.
  • inCakePath() public
    Возвращает true, если папка находится в заданном пути Cake.
  • inPath() public
    Возвращает true, если папка находится в заданном пути.
  • isAbsolute() public static
    Возвращает true, если заданный $path — абсолютный путь.
  • isRegisteredStreamWrapper() public static
    Возвращает true, если заданный $path — зарегистрированный обработчик потоков.
  • isSlashTerm() public static
    Возвращает true, если заданный $path заканчивается слешем (т.е. заканчивается слешем).
  • isWindowsPath() public static
    Возвращает true, если заданный $path — путь Windows.
  • messages() public
    Получение сообщений из последнего метода
  • move() public
    Рекурсивное перемещение каталога.
  • normalizePath() public static
    Возвращает правильный набор слешей для заданного $path. (\ для путей Windows и / для других путей.)
  • pwd() public
    Возвращение текущего пути.
  • read() public

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

  • realpath() public
    Получить реальный путь (учитывая ".." и т. п.)
  • slashTerm() public static
    Возвращает $path с добавленным завершающим слешем (исправлено для Windows или других ОС).
  • tree() public
    Возвращает массив вложенных каталогов и файлов в каждом каталоге

Подробное описание метода

__construct()source public 

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

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

Параметры

string $path необязательный false
Путь к папке
boolean $create необязательный false
Создать папку, если она не найдена
string|boolean $mode необязательный 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 необязательный 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
END_OF_DOCUMENT_MARKER

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 optional false
Восьмеричное значение, например, 0755.
boolean $recursive optional true
Рекурсивное изменение прав доступа, установите в значение false, чтобы изменить только текущую директорию.
array $exceptions optional 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 )

Возвращает правильный набор слешей для данного пути. (\ для путей 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

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

integer $mode optional 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 optional 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 optional 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 optional '.*'
Шаблон preg_match (По умолчанию: .*)
boolean $sort optional 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 optional '.*'
Шаблон preg_match (По умолчанию: .*)
boolean $sort optional 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 optional ''
Путь для проверки.

Возвращает

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 optional ''
Абсолютный путь для проверки, что текущая pwd() находится внутри.
boolean $reverse optional 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
Сбросить стек сообщений после чтения

Возвращает

array

Ссылка

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

Подробное описание свойств

$_directoriessource

protected массив

Содержит массив полных путей к каталогам.

$_errorssource

protected массив

Содержит ошибки последнего метода.

array()

$_filessource

protected массив

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

$_fsortssource

protected массив

Массив функций, вызываемых в зависимости от выбранного типа сортировки.

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

$_messagessource

protected array

Содержит сообщения из последнего метода.

array()

$modesource

public integer

Режим, используемый при создании. Не имеет эффекта на платформах Windows.

0755

$pathsource

public string

Путь к папке.

Ссылка

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

$sortsource

public boolean

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

Ссылка

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

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.9/class-Folder.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API