PHP Class Solar_Cli_MakeDocs, php-framework-benchmarks

Author: Paul M. Jones ([email protected])
Inheritance: extends Solar_Controller_Command
Mostrar archivo Open project: pmjones/php-framework-benchmarks

Public Properties

Property Type Description
$api array The entire API as a data set.
$packages array All package groupings as a data set.

Protected Properties

Property Type Description
$_Solar_Cli_MakeDocs array Default configuration values.
$_class_dir string Write class API files to this directory.
$_classes_list array Summary list of all classes.
$_docbook_dir string Write DocBook files to this directory.
$_package_dir string Write package files to this directory.
$_source string The source code directory, typically the 'include' directory.

Public Methods

Method Description
writeClassConfig ( string $class ) : void Writes the Config file.
writeClassConstants ( string $class ) : void Writes the Constants file.
writeClassIndex ( string $class ) : void Writes the index file for a single class.
writeClassMethod ( string $class, string $name, array $info ) : void Writes an individual method file.
writeClassMethods ( string $class ) : void Writes the Methods file.
writeClassOverview ( string $class ) : void Writes the Overview file.
writeClassProperties ( string $class ) : void Writes the Properties file.
writeClasses ( ) : void Writes the "class" directory.
writeClassesIndex ( ) : void Writes the index file for the list of classes.
writePackageClassList ( string $package ) : void Writes one package description file.
writePackageIndex ( ) : void Writes the package index file.
writePackages ( ) : void Writes the entire "packages" directory.

Protected Methods

Method Description
_exec ( string $class = null ) : void Main action: parse the classes and write documentation.
_getFile ( string $type, string $file ) : string Builds a target filename path in the 'class' or 'package' directory.
_postConstruct ( ) : void Post-construction tasks to complete object construction.
_title1 ( string $text ) : string Returns level-1 title markup.
_title2 ( string $text ) : string Returns level-2 title markup.
_title3 ( string $text ) : string Returns level-3 title markup.
_touch ( string $type, string $file ) : void Touches a file to create it or update its timestamp.
_write ( string $type, string $file, mixed $text ) : void Writes a file to the target directory.

Method Details

_exec() protected method

Main action: parse the classes and write documentation.
protected _exec ( string $class = null ) : void
$class string Start parsing with this class and recursively descend.
return void

_getFile() protected method

Builds a target filename path in the 'class' or 'package' directory.
protected _getFile ( string $type, string $file ) : string
$type string The type of file to work with: 'class' or 'package'.
$file string A relative file name, e.g. "class/Class_Name/Overview".
return string

_postConstruct() protected method

Post-construction tasks to complete object construction.
protected _postConstruct ( ) : void
return void

_title1() protected method

Returns level-1 title markup.
protected _title1 ( string $text ) : string
$text string The title text.
return string

_title2() protected method

Returns level-2 title markup.
protected _title2 ( string $text ) : string
$text string The title text.
return string

_title3() protected method

Returns level-3 title markup.
protected _title3 ( string $text ) : string
$text string The title text.
return string

_touch() protected method

Touches a file to create it or update its timestamp.
protected _touch ( string $type, string $file ) : void
$type string The type of file to write: 'class' or 'package'.
$file string A relative file name, e.g. "class/Class_Name/Overview".
return void

_write() protected method

Writes a file to the target directory.
protected _write ( string $type, string $file, mixed $text ) : void
$type string The type of file to write: 'class' or 'package'.
$file string A relative file name, e.g. "class/Class_Name/Overview".
$text mixed A text string or array to write to the file; if an array, is imploded with newlines and trimmed before writing.
return void

writeClassConfig() public method

Writes the Config file.
public writeClassConfig ( string $class ) : void
$class string The class to write Config items for.
return void

writeClassConstants() public method

Writes the Constants file.
public writeClassConstants ( string $class ) : void
$class string The class to write Constants for.
return void

writeClassIndex() public method

Writes the index file for a single class.
public writeClassIndex ( string $class ) : void
$class string The class to write index for.
return void

writeClassMethod() public method

Writes an individual method file.
public writeClassMethod ( string $class, string $name, array $info ) : void
$class string The class to which the method belongs.
$name string The method name.
$info array Information about the method.
return void

writeClassMethods() public method

Writes the Methods file.
public writeClassMethods ( string $class ) : void
$class string The class to write Methods for.
return void

writeClassOverview() public method

Writes the Overview file.
public writeClassOverview ( string $class ) : void
$class string The class to write Overview for.
return void

writeClassProperties() public method

Writes the Properties file.
public writeClassProperties ( string $class ) : void
$class string The class to write Properties for.
return void

writeClasses() public method

Writes the "class" directory.
public writeClasses ( ) : void
return void

writeClassesIndex() public method

Writes the index file for the list of classes.
public writeClassesIndex ( ) : void
return void

writePackageClassList() public method

Writes one package description file.
public writePackageClassList ( string $package ) : void
$package string The package name.
return void

writePackageIndex() public method

Writes the package index file.
public writePackageIndex ( ) : void
return void

writePackages() public method

Writes the entire "packages" directory.
public writePackages ( ) : void
return void

Property Details

$_Solar_Cli_MakeDocs protected_oe property

Default configuration values.
protected array $_Solar_Cli_MakeDocs
return array

$_class_dir protected_oe property

Write class API files to this directory.
protected string $_class_dir
return string

$_classes_list protected_oe property

Summary list of all classes.
protected array $_classes_list
return array

$_docbook_dir protected_oe property

Write DocBook files to this directory.
protected string $_docbook_dir
return string

$_package_dir protected_oe property

Write package files to this directory.
protected string $_package_dir
return string

$_source protected_oe property

The source code directory, typically the 'include' directory.
protected string $_source
return string

$api public_oe property

The entire API as a data set.
public array $api
return array

$packages public_oe property

All package groupings as a data set.
public array $packages
return array