Reflection/Docblock.php

Show:

inherited

Classes
- \Zend_Reflection_Docblock

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 [email protected] 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 24593 2012-01-05 20:35:02Z matthew $

\Zend_Reflection_Docblock
jump to top

Package: Zend\Reflection

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

Properties

string $_cleanDocComment = null

Default valuenullDetails

Type: string

string $_docComment = null

Default valuenullDetails

Type: string

$_endLine = null

Default valuenullDetails

Type: n/a

string $_longDescription = null

Default valuenullDetails

Type: string

\Reflector $_reflector = null

Default valuenullDetails

Type: \Reflector

string $_shortDescription = null

Default valuenullDetails

Type: string

$_startLine = null

Default valuenullDetails

Type: n/a

array $_tags = array()

Default valuearray()Details

Type: array

Methods

__construct(\Reflector | string $commentOrReflector) : void

Constructor

Parameters

Name	Type	Description
$commentOrReflector	\Reflector \| string

__toString() : string

Serialize to string

Required by the Reflector interface

Returns

Type	Description
string

Details

Todo: What should this return?

_parse() : void

Parse the docblock

export() : void

static

Export reflection

Reqired by the Reflector interface.

Details

Todo: What should this do?

getContents() : string

Retrieve contents of docblock

Returns

Type	Description
string

getEndLine() : int

Get last line (position) of docblock

Returns

Type	Description
int

getLongDescription() : string

Get docblock long description

Returns

Type	Description
string

getShortDescription() : string

Get docblock short description

Returns

Type	Description
string

getStartLine() : int

Get start line (position) of docblock

Returns

Type	Description
int

getTag(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

getTags(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

hasTag(string $name) : bool

Does the docblock contain the given annotation tag?

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool