types/selectors/BaseSelectorContainer.php

Show: inherited
Table of Contents

This is the base class for selectors that can contain other selectors.

Author
Bruce Atherton (Ant)  
Package
phing.types.selectors  

\BaseSelectorContainer

Package: phing\types\selectors

This is the base class for selectors that can contain other selectors.

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)
\SelectorContainer < \DataType < \ProjectComponent
Children
\OrSelector
\AndSelector
\NoneSelector
\MajoritySelector
Author
Bruce Atherton (Ant)  
Version
$Id$  

Properties

Propertyprotectedboolean  $checked= 'true'
inherited

Are we sure we don't hold circular references?

Inherited from: \DataType::$$checked\BaseSelector::$$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  
Inherited_from
\BaseSelector::$$checked  
Propertypublic  $description= 'null'
inherited

The descriptin the user has set.

Inherited from: \DataType::$$description\BaseSelector::$$description
Default valuenullDetails
Type
n/a
Inherited_from
\DataType::$$description  
Inherited_from
\BaseSelector::$$description  
Propertyprivate  $errmsg= 'null'
inheritedInherited from: \BaseSelector::$$errmsg
Default valuenullDetails
Type
n/a
Inherited_from
\BaseSelector::$$errmsg  
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\BaseSelector::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\DataType::$$project  
Inherited_from
\BaseSelector::$$project  
Propertypublic  $ref= 'null'
inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$$ref\BaseSelector::$$ref
Default valuenullDetails
Type
n/a
Inherited_from
\DataType::$$ref  
Inherited_from
\BaseSelector::$$ref  
Propertyprivate  $selectorsList= 'array()'
Default valuearray()Details
Type
n/a

Methods

methodpublicappendSelector( \selector $selector ) : \the

Add a new selector into this container.

Parameters
Name Type Description
$selector \selector

the new selector to add

Returns
Type Description
\the selector that was added
methodpubliccircularReference( ) : void
inherited

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

Inherited from: \DataType::circularReference()\BaseSelector::circularReference()
methodpubliccreateAnd( ) : void

add an "And" selector entry on the selector list

methodpubliccreateContains( ) : void

add a contains selector entry on the selector list

methodpubliccreateContainsRegexp( ) : void

add a contains selector entry on the selector list

methodpubliccreateCustom( ) : void

add an extended selector entry on the selector list

methodpubliccreateDate( ) : void

add a selector date entry on the selector list

methodpubliccreateDepend( ) : void

add a depends selector entry on the selector list

methodpubliccreateDepth( ) : void

add a depth selector entry on the selector list

methodpubliccreateFilename( ) : void

add a selector filename entry on the selector list

methodpubliccreateMajority( ) : void

add a majority selector entry on the selector list

methodpubliccreateNone( ) : void

add a "None" selector entry on the selector list

methodpubliccreateNot( ) : void

add a "Not" selector entry on the selector list

methodpubliccreateOr( ) : void

add an "Or" selector entry on the selector list

methodpubliccreatePresent( ) : void

add a present selector entry on the selector list

methodpubliccreateSelector( ) : void

add a "Select" selector entry on the selector list

methodpubliccreateSize( ) : void

add a selector size entry on the selector list

methodpubliccreateType( ) : void

add a type selector entry on the selector list

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()\BaseSelector::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()\BaseSelector::getCheckedRef()
Parameters
Name Type Description
$requiredClass
$dataTypeName
methodpublicgetDescription( ) : void
inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()\BaseSelector::getDescription()
methodpublicgetError( ) : \the
inherited

Returns any error messages that have been set.

Inherited from: \BaseSelector::getError()
Returns
Type Description
\the error condition
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\DataType::getProject()\BaseSelector::getProject()
Returns
Type Description
\Project Reference to current porject object
methodpublicgetSelectors(  $p ) : void

Returns a copy of the selectors as an array.

Parameters
Name Type Description
$p
methodpublichasSelectors( ) : void

Indicates whether there are any selectors here.

methodpublicisReference( ) : void
inherited

Has the refid attribute of this element been set?

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

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()\DataType::log()\BaseSelector::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()\BaseSelector::noChildrenAllowed()
methodpublicparsingComplete( ) : void
inherited

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

Inherited from: \DataType::parsingComplete()\BaseSelector::parsingComplete()
methodpublicselectorCount( ) : void

Gives the count of the number of selectors in this container

methodpublicselectorElements( ) : void

Returns an array for accessing the set of selectors (not a copy).

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()\BaseSelector::setDescription()
Parameters
Name Type Description
$desc
methodpublicsetError( \msg $msg ) : void
inherited

Allows all selectors to indicate a setup error. Note that only the first error message is recorded.

Inherited from: \BaseSelector::setError()
Parameters
Name Type Description
$msg \msg

The error message any BuildException should throw.

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\DataType::setProject()\BaseSelector::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()\BaseSelector::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
methodpublictoString( ) : \comma

Convert the Selectors within this container to a string. This will just be a helper class for the subclasses that put their own name around the contents listed here.

Returns
Type Description
\comma separated list of Selectors contained in this one
methodpublictooManyAttributes( ) : void
inherited

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

Inherited from: \DataType::tooManyAttributes()\BaseSelector::tooManyAttributes()
methodpublicvalidate( ) : void

This implementation validates the container by calling verifySettings() and then validates each contained selector provided that the selector implements the validate interface.

Ordinarily, this will validate all the elements of a selector container even if the isSelected() method of some elements is never called. This has two effects:

  • Validation will often occur twice.
  • Since it is not required that selectors derive from BaseSelector, there could be selectors in the container whose error conditions are not detected if their isSelected() call is never made.
methodpublicverifySettings( ) : void
inherited

Subclasses can override this method to provide checking of their state. So long as they call validate() from isSelected(), this will be called automatically (unless they override validate()).

Implementations should check for incorrect settings and call setError() as necessary.

Inherited from: \BaseSelector::verifySettings()
Documentation was generated by DocBlox 0.18.1.