PHP Class Pop\Code\Generator

Author: Nick Sagona, III ([email protected])
Afficher le fichier Open project: nicksagona/PopPHP Class Usage Examples

Protected Properties

Свойство Type Description
$allowed array Array of allowed file types.
$body string Code body
$close boolean Flag to close the code file with ?>
$code Pop\Code\Generator\ClassGenerator | Pop\Code\Generator\InterfaceGenerator Code object
$docblock Pop\Code\Generator\DocblockGenerator Docblock generator object
$indent string Code indent
$namespace Pop\Code\Generator\NamespaceGenerator Namespace generator object

Méthodes publiques

Méthode Description
__construct ( string $file, integer $type = Generator::CREATE_NONE ) : Generator Constructor
appendToBody ( string $body, boolean $newline = true ) : Generator Append to the code body
code ( ) : ClassGenerator | InterfaceGenerator Access the code generator object
createClass ( ) : Generator Create a class generator object
createInterface ( ) : Generator Create a class generator object
getBody ( ) : string Get the method body
getDocblock ( ) : DocblockGenerator Access the docblock generator object
getIndent ( ) : string Get the code indent
getNamespace ( ) : NamespaceGenerator Access the namespace generator object
output ( boolean $download = false ) : Generator Output the code object directly.
render ( boolean $ret = false ) : mixed Render method
save ( string $to = null, boolean $append = false ) : void Save the code object to disk.
setBody ( string $body, boolean $newline = true ) : Generator Set the code body
setClose ( boolean $close = false ) : Generator Set the code close flag
setDocblock ( DocblockGenerator $docblock ) : Generator Set the docblock generator object
setIndent ( string $indent = null ) : Generator Set the code indent
setNamespace ( NamespaceGenerator $namespace ) : Generator Set the namespace generator object

Method Details

__construct() public méthode

Instantiate the code generator object
public __construct ( string $file, integer $type = Generator::CREATE_NONE ) : Generator
$file string
$type integer
Résultat Generator

appendToBody() public méthode

Append to the code body
public appendToBody ( string $body, boolean $newline = true ) : Generator
$body string
$newline boolean
Résultat Generator

code() public méthode

Access the code generator object
public code ( ) : ClassGenerator | InterfaceGenerator
Résultat Pop\Code\Generator\ClassGenerator | Pop\Code\Generator\InterfaceGenerator

createClass() public méthode

Create a class generator object
public createClass ( ) : Generator
Résultat Generator

createInterface() public méthode

Create a class generator object
public createInterface ( ) : Generator
Résultat Generator

getBody() public méthode

Get the method body
public getBody ( ) : string
Résultat string

getDocblock() public méthode

Access the docblock generator object
public getDocblock ( ) : DocblockGenerator
Résultat Pop\Code\Generator\DocblockGenerator

getIndent() public méthode

Get the code indent
public getIndent ( ) : string
Résultat string

getNamespace() public méthode

Access the namespace generator object
public getNamespace ( ) : NamespaceGenerator
Résultat Pop\Code\Generator\NamespaceGenerator

output() public méthode

Output the code object directly.
public output ( boolean $download = false ) : Generator
$download boolean
Résultat Generator

render() public méthode

Render method
public render ( boolean $ret = false ) : mixed
$ret boolean
Résultat mixed

save() public méthode

Save the code object to disk.
public save ( string $to = null, boolean $append = false ) : void
$to string
$append boolean
Résultat void

setBody() public méthode

Set the code body
public setBody ( string $body, boolean $newline = true ) : Generator
$body string
$newline boolean
Résultat Generator

setClose() public méthode

Set the code close flag
public setClose ( boolean $close = false ) : Generator
$close boolean
Résultat Generator

setDocblock() public méthode

Set the docblock generator object
public setDocblock ( DocblockGenerator $docblock ) : Generator
$docblock Pop\Code\Generator\DocblockGenerator
Résultat Generator

setIndent() public méthode

Set the code indent
public setIndent ( string $indent = null ) : Generator
$indent string
Résultat Generator

setNamespace() public méthode

Set the namespace generator object
public setNamespace ( NamespaceGenerator $namespace ) : Generator
$namespace Pop\Code\Generator\NamespaceGenerator
Résultat Generator

Property Details

$allowed protected_oe property

Array of allowed file types.
protected array $allowed
Résultat array

$body protected_oe property

Code body
protected string $body
Résultat string

$close protected_oe property

Flag to close the code file with ?>
protected bool $close
Résultat boolean

$code protected_oe property

Code object
protected ClassGenerator,Pop\Code\Generator|InterfaceGenerator,Pop\Code\Generator $code
Résultat Pop\Code\Generator\ClassGenerator | Pop\Code\Generator\InterfaceGenerator

$docblock protected_oe property

Docblock generator object
protected DocblockGenerator,Pop\Code\Generator $docblock
Résultat Pop\Code\Generator\DocblockGenerator

$indent protected_oe property

Code indent
protected string $indent
Résultat string

$namespace protected_oe property

Namespace generator object
protected NamespaceGenerator,Pop\Code\Generator $namespace
Résultat Pop\Code\Generator\NamespaceGenerator