AbstractMagicMember

Inheritance diagram for AbstractMagicMember:

Description

A magic member.

TODO: resolve class imports for types

Public Properties
string	$docblock = ''
string	$fqn = ''
int	$logLevel = LOG_USER
string	$name = ''

Public Static Methods
static self[]	fromDocBlock (AbstractRefClass $owner, string &$docblock)
	Extracts magic members of the called type from a root entity's docblock. More...

Public Methods
string	__toString ()
string	getVisibility ()
	Magic members are always public. More...
Public Methods inherited from MemberInterface
bool	isStatic ()
Public Methods inherited from XMLWriterInterface
void	write (RefXML $xml)
	Reflector writes itself to the XML. More...

Protected Methods
void	setDocBlock (string $docblock)
	Cleans up a fragmented magic member comment from the parser and sets it as the docblock. More...
Protected Methods inherited from DocBlockTrait
void	writeDocBlock (RefXML $xml, string $docblock)
	Writes the docblock. More...
void	writeDocBlock_Prune (&$docblock)
void	writeDocBlock_Tags (RefXML $xml, string &$docblock)
void	writeDocBlock_Tags_internal (RefXML $xml, string &$docblock)
void	writeDocBlock_Tags_see (RefXML $xml, string &$docblock)
void	writeDocBlock_Tags_todo (RefXML $xml, string &$docblock)

Additional Inherited Members
Protected Properties inherited from DocBlockTrait
string[]	$warnings = []

Methods

__toString()

string __toString

(

)

Returns

string Globally unique <ClassFQN>::<identifier>

Implements MemberInterface.

fromDocBlock()

static self [] fromDocBlock ( AbstractRefClass  $owner, string &  $docblock  )

staticabstract

Extracts magic members of the called type from a root entity's docblock.

Parameters

AbstractRefClass	$owner
string	$docblock	Extracted magic members are removed.

Returns

self[]

getVisibility()

string getVisibility ( )

final

Magic members are always public.

Returns

string

Implements MemberInterface.

setDocBlock()

void setDocBlock ( string  $docblock )

protected

Cleans up a fragmented magic member comment from the parser and sets it as the docblock.

Parameters

string

$docblock