API Documentation

Zend/Reflection/Docblock.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Reflection  
Version
$Id: Docblock.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Reflection_Docblock

Package: Zend\Reflection

Implements
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_cleanDocComment= 'null'

Default valuenullDetails
Type
string
Propertyprotectedstring  $_docComment= 'null'

Default valuenullDetails
Type
string
Propertyprotected  $_endLine= 'null'
Default valuenullDetails
Type
Propertyprotectedstring  $_longDescription= 'null'

Default valuenullDetails
Type
string
Propertyprotected\Reflector  $_reflector= 'null'

Default valuenullDetails
Type
\Reflector
Propertyprotectedstring  $_shortDescription= 'null'

Default valuenullDetails
Type
string
Propertyprotected  $_startLine= 'null'
Default valuenullDetails
Type
Propertyprotectedarray  $_tags= 'array()'

Default valuearray()Details
Type
array

Methods

methodpublic__construct( \Reflector|string $commentOrReflector ) : void

Constructor

Parameters
Name Type Description
$commentOrReflector \Reflector|string
methodpublic__toString( ) : string

Serialize to string

Required by the Reflector interface

Returns
Type Description
string
Details
Todo
What should this return?  
methodprotected_parse( ) : void

Parse the docblock

methodpublicexport( ) : void
static

Export reflection

Reqired by the Reflector interface.

Details
Todo
What should this do?  
methodpublicgetContents( ) : string

Retrieve contents of docblock

Returns
Type Description
string
methodpublicgetEndLine( ) : int

Get last line (position) of docblock

Returns
Type Description
int
methodpublicgetLongDescription( ) : string

Get docblock long description

Returns
Type Description
string
methodpublicgetShortDescription( ) : string

Get docblock short description

Returns
Type Description
string
methodpublicgetStartLine( ) : int

Get start line (position) of docblock

Returns
Type Description
int
methodpublicgetTag( string $name ) : \Zend_Reflection_Docblock_Tag|false

Retrieve the given docblock tag

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Reflection_Docblock_Tag|false
methodpublicgetTags( string $filter = null ) : array

Get all docblock annotation tags

Parameters
Name Type Description
$filter string
Returns
Type Description
array Array of Zend_Reflection_Docblock_Tag
methodpublichasTag( string $name ) : bool

Does the docblock contain the given annotation tag?

Parameters
Name Type Description
$name string
Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.