Automad
 All Classes Functions Variables Pages
Automad\Core\Filelist Class Reference

Public Member Functions

 __construct ($Context)
 
 config ($options)
 
 getFiles ()
 

Private Attributes

 $Context
 
 $defaults
 
 $files = array()
 

Detailed Description

The Filelist object represents a set of files based on a file pattern.

Author
Marc Anton Dahmen hello.nosp@m.@mar.nosp@m.cdahm.nosp@m.en.d.nosp@m.e
License
MIT license - http://automad.org/license

Definition at line 53 of file filelist.php.

Constructor & Destructor Documentation

Automad\Core\Filelist::__construct (   $Context)

The constructor.

Parameters
object$Context

Definition at line 85 of file filelist.php.

References Automad\Core\Automad\$Context.

Member Function Documentation

Automad\Core\Filelist::config (   $options)

Configure the files array.

Parameters
array$options

Definition at line 99 of file filelist.php.

References Automad\Core\Parse\fileDeclaration(), Automad\Core\Context\get(), and Automad\Core\Debug\log().

Automad\Core\Filelist::getFiles ( )

Return the files array.

Returns
The array of matched files.

Definition at line 129 of file filelist.php.

Member Data Documentation

Automad\Core\Filelist::$Context
private

The Context.

Definition at line 60 of file filelist.php.

Automad\Core\Filelist::$defaults
private
Initial value:
= array(
'glob' => '*.jpg, *.png, *.gif',
'sortOrder' => 'asc'
)

The default options.

Definition at line 67 of file filelist.php.

Automad\Core\Filelist::$files = array()
private

The set of matched files.

Definition at line 76 of file filelist.php.


The documentation for this class was generated from the following file: