API Documentation
\
Pop
Acl
Assertion
Policy
Audit
Adapter
Model
Auth
Cache
Adapter
Code
Generator
Traits
Reflection
Config
Console
Controller
Cookie
Css
Color
Csv
Db
Adapter
Profiler
Gateway
Record
Relationships
Sql
Migration
Parser
Predicate
Schema
Formatter
Seeder
Debug
Handler
Storage
Dir
Dom
Event
Filter
Form
Element
Input
Select
Ftp
Http
Client
Server
Request
I18n
Format
Image
Adapter
Adjust
Color
Draw
Effect
Filter
Layer
Type
Kettle
Controller
Event
Model
Loader
Log
Writer
Mail
Client
Message
Transport
Smtp
Auth
Stream
Byte
Filter
Mime
Part
Model
Module
Nav
Paginator
Pdf
Build
Font
Standard
TrueType
Table
Cmap
Html
Image
PdfObject
Document
Page
Annotation
Color
Field
Text
Queue
Adapter
Processor
Jobs
Router
Match
Service
Session
Utils
Validator
View
Template
Stream
Popcorn

\Pop\DirDir

Directory class

Summary

Methods
Properties
Constants
__construct()
count()
getIterator()
setAbsolute()
setRelative()
setRecursive()
setFilesOnly()
isAbsolute()
isRelative()
isRecursive()
isFilesOnly()
getPath()
getFiles()
getTree()
copyTo()
fileExists()
deleteFile()
emptyDir()
__get()
__isset()
__set()
__unset()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
No public properties found
No constants found
traverse()
traverseRecursively()
buildTree()
$path
$files
$tree
$absolute
$relative
$recursive
$filesOnly
N/A
No private methods found
No private properties found
N/A

Properties

$path

$path : string

The directory path

Type

string

$files

$files : array

The files within the directory

Type

array

$tree

$tree : array

The nested tree map of the directory and its files

Type

array

$absolute

$absolute : boolean

Flag to store the absolute path.

Type

boolean

$relative

$relative : boolean

Flag to store the relative path.

Type

boolean

$recursive

$recursive : boolean

Flag to dig recursively.

Type

boolean

$filesOnly

$filesOnly : boolean

Flag to include only files and no directories

Type

boolean

Methods

__construct()

__construct(string  $dir, array  $options = array())

Constructor

Instantiate a directory object

Parameters

string $dir
array $options

Throws

\Pop\Dir\Exception

count()

count() : integer

Method to get the count of files in the directory

Returns

integer

getIterator()

getIterator() : \ArrayIterator

Method to iterate over the files

Returns

\ArrayIterator

setAbsolute()

setAbsolute(boolean  $absolute) : \Pop\Dir\Dir

Set absolute

Parameters

boolean $absolute

Returns

\Pop\Dir\Dir

setRelative()

setRelative(boolean  $relative) : \Pop\Dir\Dir

Set relative

Parameters

boolean $relative

Returns

\Pop\Dir\Dir

setRecursive()

setRecursive(boolean  $recursive) : \Pop\Dir\Dir

Set recursive

Parameters

boolean $recursive

Returns

\Pop\Dir\Dir

setFilesOnly()

setFilesOnly(boolean  $filesOnly) : \Pop\Dir\Dir

Set files only

Parameters

boolean $filesOnly

Returns

\Pop\Dir\Dir

isAbsolute()

isAbsolute() : boolean

Is absolute

Returns

boolean

isRelative()

isRelative() : boolean

Is relative

Returns

boolean

isRecursive()

isRecursive() : boolean

Is recursive

Returns

boolean

isFilesOnly()

isFilesOnly() : boolean

Is files only

Returns

boolean

getPath()

getPath() : string

Get the path

Returns

string

getFiles()

getFiles() : array

Get the files

Returns

array

getTree()

getTree() : array

Get the tree

Returns

array

copyTo()

copyTo(string  $destination, boolean  $full = true) : void

Copy an entire directory recursively to another destination directory

Parameters

string $destination
boolean $full

fileExists()

fileExists(string  $file) : boolean

File exists

Parameters

string $file

Returns

boolean

deleteFile()

deleteFile(string  $file) : void

Delete a file

Parameters

string $file

Throws

\Pop\Dir\Exception

emptyDir()

emptyDir(boolean  $remove = false, string  $path = null) : void

Empty an entire directory

Parameters

boolean $remove
string $path

Throws

\Pop\Dir\Exception

__get()

__get(string  $name) : mixed

Get a file

Parameters

string $name

Returns

mixed

__isset()

__isset(string  $name) : boolean

Does file exist

Parameters

string $name

Returns

boolean

__set()

__set(string  $name, mixed  $value) : void

Set method

Parameters

string $name
mixed $value

Throws

\Pop\Dir\Exception

__unset()

__unset(string  $name) : void

Unset method

Parameters

string $name

Throws

\Pop\Dir\Exception

offsetExists()

offsetExists(mixed  $offset) : boolean

ArrayAccess offsetExists

Parameters

mixed $offset

Returns

boolean

offsetGet()

offsetGet(mixed  $offset) : mixed

ArrayAccess offsetGet

Parameters

mixed $offset

Returns

mixed

offsetSet()

offsetSet(string  $offset, mixed  $value) : void

ArrayAccess offsetSet

Parameters

string $offset
mixed $value

Throws

\Pop\Dir\Exception

offsetUnset()

offsetUnset(string  $offset) : void

ArrayAccess offsetUnset

Parameters

string $offset

Throws

\Pop\Dir\Exception

traverse()

traverse() : void

Traverse the directory

traverseRecursively()

traverseRecursively() : void

Traverse the directory recursively

buildTree()

buildTree(\DirectoryIterator  $it) : array

Build the directory tree

Parameters

\DirectoryIterator $it

Returns

array