PHP Class Todaymade\Daux\Tree\Directory

Inheritance: extends Entry, implements ArrayAccess, implements IteratorAggregate
Mostrar archivo Open project: justinwalsh/daux.io Class Usage Examples

Protected Properties

Property Type Description
$children Entry[]
$first_page Todaymade\Daux\Tree\Content

Public Methods

Method Description
addChild ( Entry $entry )
dump ( )
getConfig ( ) : Config
getEntries ( ) : Entry[]
getFirstPage ( ) : Todaymade\Daux\Tree\Content | null
getIndexPage ( ) : Todaymade\Daux\Tree\Content | null
getIterator ( )
hasContent ( ) : boolean Used when creating the navigation.
offsetExists ( mixed $offset ) : boolean Whether a offset exists
offsetGet ( mixed $offset ) : Entry Offset to retrieve
offsetSet ( mixed $offset, Entry $value ) : void Offset to set
offsetUnset ( string $offset ) : void Offset to unset
removeChild ( Entry $entry )
seekFirstPage ( ) : Todaymade\Daux\Tree\Content | null Seek the first available page from descendants
setFirstPage ( Todaymade\Daux\Tree\Content $first_page )
sort ( )

Private Methods

Method Description
sortBucket ( $bucket, $final )

Method Details

addChild() public method

public addChild ( Entry $entry )
$entry Entry

dump() public method

public dump ( )

getConfig() public method

public getConfig ( ) : Config
return Todaymade\Daux\Config

getEntries() public method

public getEntries ( ) : Entry[]
return Entry[]

getFirstPage() public method

public getFirstPage ( ) : Todaymade\Daux\Tree\Content | null
return Todaymade\Daux\Tree\Content | null

getIndexPage() public method

public getIndexPage ( ) : Todaymade\Daux\Tree\Content | null
return Todaymade\Daux\Tree\Content | null

getIterator() public method

public getIterator ( )

hasContent() public method

Hides folders without showable content
public hasContent ( ) : boolean
return boolean

offsetExists() public method

Whether a offset exists
public offsetExists ( mixed $offset ) : boolean
$offset mixed An offset to check for.
return boolean true on success or false on failure.

offsetGet() public method

Offset to retrieve
public offsetGet ( mixed $offset ) : Entry
$offset mixed The offset to retrieve.
return Entry Can return all value types.

offsetSet() public method

Offset to set
public offsetSet ( mixed $offset, Entry $value ) : void
$offset mixed The offset to assign the value to.
$value Entry The value to set.
return void

offsetUnset() public method

Offset to unset
public offsetUnset ( string $offset ) : void
$offset string the offset to unset
return void

removeChild() public method

public removeChild ( Entry $entry )
$entry Entry

seekFirstPage() public method

Seek the first available page from descendants
public seekFirstPage ( ) : Todaymade\Daux\Tree\Content | null
return Todaymade\Daux\Tree\Content | null

setFirstPage() public method

public setFirstPage ( Todaymade\Daux\Tree\Content $first_page )
$first_page Todaymade\Daux\Tree\Content

sort() public method

public sort ( )

Property Details

$children protected_oe property

protected Entry[],Todaymade\Daux\Tree $children
return Entry[]

$first_page protected_oe property

protected Content,Todaymade\Daux\Tree $first_page
return Todaymade\Daux\Tree\Content