API Documentation

Reflection/Docblock.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Reflection
version
$Id: Docblock.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Reflection_Docblock

Description

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.

Zend_Reflection_Docblock
jump to top

Implements
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Reflection
Properties
$_reflector
$_startLine
$_endLine
$_docComment
$_cleanDocComment
$_longDescription
$_shortDescription
$_tags
Methods
export
__toString
__construct
getContents
getStartLine
getEndLine
getShortDescription
getLongDescription
hasTag
getTag
getTags
_parse

Description

Properties

$_cleanDocComment
jump to class

string $_cleanDocComment = 'null'

Details

$_cleanDocComment
string
visibility
protected
default
null
final
false
static
false

$_docComment
jump to class

string $_docComment = 'null'

Details

$_docComment
string
visibility
protected
default
null
final
false
static
false

$_endLine
jump to class

 $_endLine = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_longDescription
jump to class

string $_longDescription = 'null'

Details

$_longDescription
string
visibility
protected
default
null
final
false
static
false

$_reflector
jump to class

Reflector $_reflector = 'null'

Details

$_reflector
Reflector
visibility
protected
default
null
final
false
static
false

$_shortDescription
jump to class

string $_shortDescription = 'null'

Details

$_shortDescription
string
visibility
protected
default
null
final
false
static
false

$_startLine
jump to class

 $_startLine = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_tags
jump to class

array $_tags = 'array'

Details

$_tags
array
visibility
protected
default
array
final
false
static
false

Methods

__construct
jump to class

__construct( Reflector|string $commentOrReflector ) :

Constructor

Arguments
$commentOrReflector
Reflectorstring
Details
visibility
public
final
false
static
false

__toString
jump to class

__toString( ) : string

Serialize to string

Required by the Reflector interface

Output
string
Details
visibility
public
final
false
static
false
todo
What should this return?

_parse
jump to class

_parse( ) : void

Parse the docblock

Details
visibility
protected
final
false
static
false

export
jump to class

export( ) : void

Export reflection

Reqired by the Reflector interface.

Details
visibility
public
final
false
static
true
todo
What should this do?

getContents
jump to class

getContents( ) : string

Retrieve contents of docblock

Output
string
Details
visibility
public
final
false
static
false

getEndLine
jump to class

getEndLine( ) : int

Get last line (position) of docblock

Output
int
Details
visibility
public
final
false
static
false

getLongDescription
jump to class

getLongDescription( ) : string

Get docblock long description

Output
string
Details
visibility
public
final
false
static
false

getShortDescription
jump to class

getShortDescription( ) : string

Get docblock short description

Output
string
Details
visibility
public
final
false
static
false

getStartLine
jump to class

getStartLine( ) : int

Get start line (position) of docblock

Output
int
Details
visibility
public
final
false
static
false

getTag
jump to class

getTag( string $name ) : Zend_Reflection_Docblock_Tag|false

Retrieve the given docblock tag

Arguments
$name
string
Output
Zend_Reflection_Docblock_Tag|false
Details
visibility
public
final
false
static
false

getTags
jump to class

getTags( string $filter = null ) : array

Get all docblock annotation tags

Arguments
$filter
string
Output
array
Array of Zend_Reflection_Docblock_Tag
Details
visibility
public
final
false
static
false

hasTag
jump to class

hasTag( string $name ) : bool

Does the docblock contain the given annotation tag?

Arguments
$name
string
Output
bool
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.