src/DocBlox/Plugin/Core/Parser/DocBlock/Validator/File.php

Show: inherited

Classes
- \DocBlox_Plugin_Core_Parser_DocBlock_Validator_File

Table of Contents

File contains the DocBlox_Core_Validator_File class

PHP Version 5

Author: Ben Selby
Author: Mike van Riel
Category: DocBlox
Copyright: 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
License: MIT
Link: http://docblox-project.org
Package: Parser
Subpackage: DocBlock_Validators

\DocBlox_Plugin_Core_Parser_DocBlock_Validator_File
jump to top

Package: Parser\DocBlock\Validators

This class is responsible for validating the file docbloc

Parent(s): \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Class < \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract < \DocBlox_Parser_Abstract
Author: Ben Selby
Author: Mike van Riel
Category: DocBlox
Copyright: 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
License: MIT
Link: http://docblox-project.org

Properties

\DocBlox_Reflection_DocBlock
                 $_docblock= ''

inherited

Docblock for the file.

Inherited from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::$_docblock

Details

Type: \DocBlox_Reflection_DocBlock
Inherited_from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::$_docblock

string
                 $_entityName= ''

inherited

Name of the "entity" being validated.

Inherited from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::$_entityName

Details

Type: \string
Inherited_from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::$_entityName

int
                 $_lineNumber= ''

inherited

Line number of the docblock

Inherited from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::$_lineNumber

Details

Type: \int
Inherited_from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::$_lineNumber

array
                 $_options= ''

inherited

Array of options that may or may not be used whilst validating

Inherited from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::$_options

Details

Type: \array
Inherited_from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::$_options

\DocBlox_Reflection_Abstract
                 $_source= ''

inherited

Source element of the DocBlock.

Inherited from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::$_source

Details

Type: \DocBlox_Reflection_Abstract
Inherited_from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::$_source

\sfEventDispatcher|null
                 $event_dispatcher= 'null'

staticinherited

The event dispatcher object, may be null to not dispatch events.

Inherited from: \DocBlox_Parser_Abstract::$event_dispatcher

Default valuenullDetails

Type: \sfEventDispatcher | \null
Inherited_from: \DocBlox_Parser_Abstract::$event_dispatcher

Methods

__construct(
          \string $name, \int $lineNumber, \DocBlox_Reflection_DocBlock | \null $docblock
              =
              null, \DocBlox_Reflection_Abstract | \null $source
              =
              null
          )
        
        :
          void

inherited

Constructor

Inherited from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::__construct()

Parameters

Name	Type	Description
$name	\string	Name of the "entity"
$lineNumber	\int	Line number for
$docblock	\DocBlox_Reflection_DocBlock \| \null	Docblock
$source	\DocBlox_Reflection_Abstract \| \null	Source Element.

debug(
          \string $message
          )
        
        :
          \void

inherited

Dispatches a logging request to log a debug message.

Inherited from: \DocBlox_Parser_Abstract::debug()

Parameters

Name	Type	Description
$message	\string	The message to log.

dispatch(
          \string $name, \string[] $arguments
          )
        
        :
          \mixed | \null

inherited

Dispatches an event to the Event Dispatcher.

Inherited from: \DocBlox_Parser_Abstract::dispatch()

This method tries to dispatch an event; if no Event Dispatcher has been set than this method will explicitly not fail and return null.

By not failing we make the Event Dispatcher optional and is it easier for people to re-use this component in their own application.

Parameters

Name	Type	Description
$name	\string	Name of the event to dispatch.
$arguments	\string[]	Arguments for this event.

Returns

Type	Description
\mixed \| \null

Throws

Exception	Description
\DocBlox_Parser_Exception	if there is a dispatcher but it is not of type sfEventDispatcher

isValid(
          )
        
        :
          \boolean

Is the docblock valid?

Returns

Type	Description
\boolean

Details

See: \DocBlox_Parser_DocBlock_Validator::isValid()

log(
          \string $message, \int $priority
              =
              6
          )
        
        :
          \void

inherited

Dispatches a logging request.

Inherited from: \DocBlox_Parser_Abstract::log()

Parameters

Name	Type	Description
$message	\string	The message to log.
$priority	\int	The logging priority, the lower, the more important. Ranges from 1 to 7

logParserError(
          \string $type, \string $message, \string $line
          )
        
        :
          \void

inherited

Dispatches a parser error to be logged.

Inherited from: \DocBlox_Parser_Abstract::logParserError()

Parameters

Name	Type	Description
$type	\string	The logging priority as string
$message	\string	The message to log.
$line	\string	The line number where the error occurred..

setOptions(
          \array $options
          )
        
        :
          \void

inherited

Set the options that may be used whilst validating the docblocks.

Inherited from: \DocBlox_Plugin_Core_Parser_DocBlock_Validator_Abstract::setOptions()

Can contain configuration as long as each validator knows how to interrogate it

Parameters

Name	Type	Description
$options	\array	Options that may be used during validation

src/DocBlox/Plugin/Core/Parser/DocBlock/Validator/File.php

\DocBlox_Plugin_Core_Parser_DocBlock_Validator_Filejump to top

Properties

Methods

\DocBlox_Plugin_Core_Parser_DocBlock_Validator_File
jump to top