types/Excludes.php

Show: inherited
Table of Contents

Datatype which handles excluded files, classes and methods.

Author
Benjamin Schultz  
Package
phing.types  
Since
2.4.6  
Version
$Id: 0c22f261d1984da235c6cf4993d1275c225a33ba $  

\Excludes

Package: phing\types

Datatype which handles excluded files, classes and methods.

This class handles the common description attribute and provides a default implementation for reference handling and checking for circular references that is appropriate for types that can not be nested inside elements of the same type (i.e. patternset but not path)

Parent(s)
\DataType < \ProjectComponent
Author
Benjamin Schultz  
Since
2.4.6  
Version
$Id: 0c22f261d1984da235c6cf4993d1275c225a33ba $  

Properties

Propertyprivatearray  $_classes= 'array()'

Holds the excluded classes

Default valuearray()Details
Type
array
Propertyprivate\DirectoryScanner  $_directoryScanner= 'null'

The directory scanner for getting the excluded files

Default valuenullDetails
Type
\DirectoryScanner
Propertyprivatearray  $_files= 'array()'

Holds the excluded file patterns

Default valuearray()Details
Type
array
Propertyprivatearray  $_methods= 'array()'

Holds the excluded methods

Default valuearray()Details
Type
array
Propertyprotectedboolean  $checked= 'true'
inherited

Are we sure we don't hold circular references?

Inherited from: \DataType::$$checked

Subclasses are responsible for setting this value to false if we'd need to investigate this condition (usually because a child element has been added that is a subclass of DataType).

Default valuetrueDetails
Type
boolean
Inherited_from
\DataType::$$checked  
Propertypublic  $description= 'null'
inherited

The descriptin the user has set.

Inherited from: \DataType::$$description
Default valuenullDetails
Type
n/a
Inherited_from
\DataType::$$description  
Propertyprotected\Project  $project= 'null'
inherited

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

A reference to the current project instanceInherited from: \ProjectComponent::$$project\DataType::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\DataType::$$project  
Propertypublic  $ref= 'null'
inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$$ref
Default valuenullDetails
Type
n/a
Inherited_from
\DataType::$$ref  

Methods

methodpublic__construct( \Project $project ) : void

ctor

Parameters
Name Type Description
$project \Project
methodprivate_addClass(  $classList ) : \ExcludesNameEntry

Adds a class to the exclusion list

Parameters
Name Type Description
$classList
Returns
Type Description
\ExcludesNameEntry Reference to the created ExcludesNameEntry instance
methodprivate_addFile(  $fileList ) : \ExcludesNameEntry

Adds a file to the exclusion list

Parameters
Name Type Description
$fileList
Returns
Type Description
\ExcludesNameEntry Reference to the created ExcludesNameEntry instance
methodprivate_addMethod(  $methodList ) : \ExcludesNameEntry

Adds a method to the exclusion list

Parameters
Name Type Description
$methodList
Returns
Type Description
\ExcludesNameEntry Reference to the created ExcludesNameEntry instance
methodpubliccircularReference( ) : void
inherited

Creates an exception that indicates the user has generated a loop of data types referencing each other.

Inherited from: \DataType::circularReference()
methodpubliccreateClass( ) : \ExcludesNameEntry

Add a name entry on the exclude class list

Returns
Type Description
\ExcludesNameEntry Reference to object
methodpubliccreateFile( ) : \ExcludesNameEntry

Add a name entry on the exclude file list

Returns
Type Description
\ExcludesNameEntry Reference to object
methodpubliccreateMethod( ) : \ExcludesNameEntry

Add a name entry on the exclude method list

Returns
Type Description
\ExcludesNameEntry Reference to object
methodpublicdieOnCircularReference(  $stk,  $p ) : void
inherited

Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).

Inherited from: \DataType::dieOnCircularReference()

If one is included, throw a BuildException created by circularReference

This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.

The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.

Parameters
Name Type Description
$stk
$p
methodpublicgetCheckedRef(  $requiredClass,  $dataTypeName ) : void
inherited

Performs the check for circular references and returns the referenced object.

Inherited from: \DataType::getCheckedRef()
Parameters
Name Type Description
$requiredClass
$dataTypeName
methodpublicgetDescription( ) : void
inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()
methodpublicgetExcludedClasses( ) : array

Returns the excluded class names

Returns
Type Description
array
methodpublicgetExcludedFiles( ) : array

Returns the excluded files

Returns
Type Description
array
methodpublicgetExcludedMethods( ) : array

Returns the excluded method names

Returns
Type Description
array
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\DataType::getProject()
Returns
Type Description
\Project Reference to current porject object
methodpublicisReference( ) : void
inherited

Has the refid attribute of this element been set?

Inherited from: \DataType::isReference()
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()\DataType::log()
Parameters
Name Type Description
$msg string

The message to be logged.

$level integer

The message's priority at this message should have

methodpublicnoChildrenAllowed( ) : void
inherited

Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.

Inherited from: \DataType::noChildrenAllowed()
methodpublicparsingComplete( ) : void
inherited

Template method being called when the data type has been parsed completely.

Inherited from: \DataType::parsingComplete()
methodpublicsetDescription(  $desc ) : void
inherited

Sets a description of the current data type. It will be useful in commenting what we are doing.

Inherited from: \DataType::setDescription()
Parameters
Name Type Description
$desc
methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\DataType::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetRefid( \Reference $r ) : void
inherited

Set the value of the refid attribute.

Inherited from: \DataType::setRefid()

Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do they must call parent::setRefid()

Parameters
Name Type Description
$r \Reference
methodpublictooManyAttributes( ) : void
inherited

Creates an exception that indicates that refid has to be the only attribute if it is set.

Inherited from: \DataType::tooManyAttributes()
Documentation was generated by DocBlox 0.18.1.