PHP Class gossi\codegen\config\CodeFileGeneratorConfig

Author: Thomas Gossmann
Inheritance: extends CodeGeneratorConfig
Datei anzeigen Open project: gossi/php-code-generator Class Usage Examples

Public Methods

Method Description
getBlankLineAtEnd ( ) : boolean Returns whether a blank line should be generated at the end of the file
getDeclareStrictTypes ( ) : boolean Returns whether a declare(strict_types=1); statement should be printed below the header comments (PHP 7)
getHeaderComment ( ) : string Returns the file header comment
getHeaderDocblock ( ) : gossi\docblock\Docblock Returns the file header docblock
setBlankLineAtEnd ( boolean $show ) Sets whether a blank line should be generated at the end of the file
setDeclareStrictTypes ( boolean $strict ) Sets whether a declare(strict_types=1); statement should be printed below the header comments (PHP 7)
setHeaderComment ( string $comment ) Sets the file header comment
setHeaderDocblock ( gossi\docblock\Docblock $docblock ) Sets the file header docblock

Protected Methods

Method Description
configureOptions ( Symfony\Component\OptionsResolver\OptionsResolver $resolver )

Private Methods

Method Description
toDocblock ( mixed $value ) : gossi\docblock\Docblock | null

Method Details

configureOptions() protected method

protected configureOptions ( Symfony\Component\OptionsResolver\OptionsResolver $resolver )
$resolver Symfony\Component\OptionsResolver\OptionsResolver

getBlankLineAtEnd() public method

Returns whether a blank line should be generated at the end of the file
public getBlankLineAtEnd ( ) : boolean
return boolean `true` if it will be generated and `false` if not

getDeclareStrictTypes() public method

Returns whether a declare(strict_types=1); statement should be printed below the header comments (PHP 7)
public getDeclareStrictTypes ( ) : boolean
return boolean `true` if it will be printed and `false` if not

getHeaderComment() public method

Returns the file header comment
public getHeaderComment ( ) : string
return string the header comment

getHeaderDocblock() public method

Returns the file header docblock
public getHeaderDocblock ( ) : gossi\docblock\Docblock
return gossi\docblock\Docblock the docblock

setBlankLineAtEnd() public method

Sets whether a blank line should be generated at the end of the file
public setBlankLineAtEnd ( boolean $show )
$show boolean `true` if it will be generated and `false` if not

setDeclareStrictTypes() public method

Sets whether a declare(strict_types=1); statement should be printed below the header comments (PHP 7)
public setDeclareStrictTypes ( boolean $strict )
$strict boolean `true` if it will be printed and `false` if not

setHeaderComment() public method

Sets the file header comment
public setHeaderComment ( string $comment )
$comment string the header comment

setHeaderDocblock() public method

Sets the file header docblock
public setHeaderDocblock ( gossi\docblock\Docblock $docblock )
$docblock gossi\docblock\Docblock the docblock