Documentation

PropertyGenerator extends AbstractClassElementGenerator
in package
Uses NameTrait, DocblockTrait

Property generator class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2021 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.1.0

Table of Contents

$docblock  : DocblockGenerator
Docblock generator object
$indent  : int
Code indent spaces
$name  : string
Name
$output  : string
Output string
$static  : bool
Static flag
$type  : string
Property type
$value  : mixed
Property value
$visibility  : string
Visibility
__construct()  : mixed
Constructor
__toString()  : string
Print property
getDesc()  : string
Get the docblock description
getDocblock()  : DocblockGenerator
Access the docblock generator object
getIndent()  : int
Get the indent
getName()  : string
Get the name
getOutput()  : string
Get the output
getType()  : string
Get the property type
getValue()  : mixed
Get the property value
getVisibility()  : string
Get the visibility
hasDesc()  : bool
Has a docblock description
hasDocblock()  : bool
Has docblock generator object
hasIndent()  : bool
Has indent
hasName()  : bool
Get the name
hasOutput()  : bool
Has output
hasType()  : bool
Has property type
hasValue()  : bool
Has property value
isPrivate()  : bool
Set the visibility to private
isProtected()  : bool
Set the visibility to protected
isPublic()  : bool
Is visibility public
isRendered()  : bool
Is rendered (alias to hasOutput())
isStatic()  : bool
Get the static flag
printIndent()  : string
Print the indent
render()  : mixed
Render property
setAsPrivate()  : AbstractClassElementGenerator
Set the visibility to public
setAsProtected()  : AbstractClassElementGenerator
Set the visibility to protected
setAsPublic()  : AbstractClassElementGenerator
Set the visibility to public
setAsStatic()  : AbstractClassElementGenerator
Set the static flag
setDesc()  : DocblockTrait
Set the docblock description
setDocblock()  : DocblockTrait
Set the docblock generator object
setIndent()  : AbstractGenerator
Set the indent
setName()  : NameTrait
Set the name
setType()  : PropertyGenerator
Set the property type
setValue()  : PropertyGenerator
Set the property value
setVisibility()  : AbstractClassElementGenerator
Set the visibility
formatArrayValues()  : string
Format array value

Properties

Methods

__construct()

Constructor

public __construct(string $name[, string $type = null ][, mixed $value = null ][, string $visibility = 'public' ][, bool $static = false ]) : mixed

Instantiate the property generator object

Parameters
$name : string
$type : string = null
$value : mixed = null
$visibility : string = 'public'
$static : bool = false
Return values
mixed —

__toString()

Print property

public __toString() : string
Return values
string —

getDesc()

Get the docblock description

public getDesc() : string
Return values
string —

getName()

Get the name

public getName() : string
Return values
string —

getOutput()

Get the output

public getOutput() : string
Return values
string —

getType()

Get the property type

public getType() : string
Return values
string —

getValue()

Get the property value

public getValue() : mixed
Return values
mixed —

hasDesc()

Has a docblock description

public hasDesc() : bool
Return values
bool —

hasDocblock()

Has docblock generator object

public hasDocblock() : bool
Return values
bool —

hasName()

Get the name

public hasName() : bool
Return values
bool —

hasValue()

Has property value

public hasValue() : bool
Return values
bool —

isRendered()

Is rendered (alias to hasOutput())

public isRendered() : bool
Return values
bool —

printIndent()

Print the indent

public printIndent() : string
Return values
string —

formatArrayValues()

Format array value

protected formatArrayValues() : string
Return values
string —

Search results