Zend Framework  3.0
Public Member Functions | Protected Attributes | List of all members
AbstractTypeableTag Class Reference

This abstract class can be used as parent for all tags that use a type part in their content. More...

Public Member Functions

 __construct ($types=[], $description=null)
 
 setDescription ($description)
 
 getDescription ()
 
 setTypes ($types)
 Array of types or string with types delimited by pipe (|) e.g.
 
 getTypes ()
 
 getTypesAsString ($delimiter= '|')
 
- Public Member Functions inherited from AbstractGenerator
 __construct ($options=[])
 
 setSourceDirty ($isSourceDirty=true)
 
 isSourceDirty ()
 
 setIndentation ($indentation)
 
 getIndentation ()
 
 setSourceContent ($sourceContent)
 
 getSourceContent ()
 
 setOptions ($options)
 
- Public Member Functions inherited from GeneratorInterface
 generate ()
 

Protected Attributes

 $description = null
 
 $types = []
 
- Protected Attributes inherited from AbstractGenerator
 $isSourceDirty = true
 
 $indentation = ' '
 
 $sourceContent = null
 

Additional Inherited Members

- Public Attributes inherited from AbstractGenerator
const LINE_FEED = "\n"
 Line feed to use in place of EOL.
 

Detailed Description

This abstract class can be used as parent for all tags that use a type part in their content.

See Also
http://www.phpdoc.org/docs/latest/for-users/phpdoc/types.html

Constructor & Destructor Documentation

__construct (   $types = [],
  $description = null 
)
Parameters
array$types
string$description

Member Function Documentation

getDescription ( )
Returns
string
getTypes ( )
Returns
array
getTypesAsString (   $delimiter = '|')
Parameters
string$delimiter
Returns
string
setDescription (   $description)
Parameters
string$description
Returns
ReturnTag
setTypes (   $types)

Array of types or string with types delimited by pipe (|) e.g.

array('int', 'null') or "int|null"

Parameters
array | string$types
Returns
ReturnTag

Member Data Documentation

$description = null
protected
$types = []
protected