PHP Class Phrocco\PhroccoGroup

Whereas the base Phrocco class operates on a single file to produce a single output, This class looks after recursively iterating over a directory and creating an output for each file found.

Author: Ross Riley

Show file Open project: rossriley/phrocco Class Usage Examples

Public Properties

Property	Type	Description
$defaults
$extensions
$group
$language		### Default options, These are normally provided by the command-line tool but can be overridden if required.
$options

Public Methods

Method	Description
__construct ( array $options )	###Constructor method, Prepares class using command line options provided.
process ( )	## Iterate and Process All the magic happens here, whils it looks complicated this is essentially a directory iterator that creates an array of filenames, with a corresponding Phrocco object that can look after rendering itself.
write ( )	### Final File renders Iterates over all found files and calls on the Phrocco class to render each file.

Method Details

__construct() public method

###Constructor method, Prepares class using command line options provided.

public __construct ( array $options )
$options	array	receives the command line options to decide where to choose files and output docs.

process() public method

## Iterate and Process All the magic happens here, whils it looks complicated this is essentially a directory iterator that creates an array of filenames, with a corresponding Phrocco object that can look after rendering itself.

public process ( )

write() public method

### Final File renders Iterates over all found files and calls on the Phrocco class to render each file.

public write ( )

Property Details

$defaults public property

public $defaults

$extensions public property

public $extensions

$group public property

public $group

$language public property

### Default options, These are normally provided by the command-line tool but can be overridden if required.

public $language

$options public property

public $options