types/selectors/ContainsSelector.php

Show: inherited
Table of Contents

Selector that filters files based on whether they contain a particular string.

Author
Hans Lellelid (Phing)  
Author
Bruce Atherton (Ant)  
Package
phing.types.selectors  

\ContainsSelector

Package: phing\types\selectors

Selector that filters files based on whether they contain a particular string.

It provides support for gathering the parameters together as well as for assigning an error message and throwing a build exception if an error is detected.

Parent(s)
\BaseExtendSelector < \ExtendFileSelector < \DataType < \ProjectComponent
Author
Hans Lellelid (Phing)  
Author
Bruce Atherton (Ant)  
Version
$Id$  

Constants

Constant  CONTAINS_KEY = "text"
Constant  CASE_KEY = "casesensitive"

Properties

Propertyprivate  $casesensitive= 'true'
Default valuetrueDetails
Type
n/a
Propertyprotectedboolean  $checked= 'true'
inherited

Are we sure we don't hold circular references?

Inherited from: \DataType::$$checked\BaseSelector::$$checked\BaseExtendSelector::$$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  
Inherited_from
\BaseExtendSelector::$$checked  
Propertyprivate  $contains= 'null'
Default valuenullDetails
Type
n/a
Propertypublic  $description= 'null'
inherited

The descriptin the user has set.

Inherited from: \DataType::$$description\BaseSelector::$$description\BaseExtendSelector::$$description
Default valuenullDetails
Type
n/a
Inherited_from
\DataType::$$description  
Inherited_from
\BaseSelector::$$description  
Inherited_from
\BaseExtendSelector::$$description  
Propertyprivate  $errmsg= 'null'
Default valuenullDetails
Type
n/a
Inherited_from
\BaseSelector::$$errmsg  
Inherited_from
\BaseExtendSelector::$$errmsg  
Propertyprotected  $parameters= 'null'
inherited

The passed in parameter array.

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

Value to the refid attribute. Type of Reference

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

Methods

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

Return the description for the current data type.

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

Returns any error messages that have been set.

Inherited from: \BaseSelector::getError()\BaseExtendSelector::getError()
Returns
Type Description
\the error condition
methodprotectedgetParameters( ) : \the
inherited

Allows access to the parameters gathered and set within the <custom> tag.

Inherited from: \BaseExtendSelector::getParameters()
Returns
Type Description
\the set of parameters defined for this selector
methodpublicgetProject( ) : \Project
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()\BaseSelector::isReference()\BaseExtendSelector::isReference()
methodpublicisSelected( \basedir $basedir, \filename $filename, \file $file ) : \whether

The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.

Parameters
Name Type Description
$basedir \basedir

the base directory the scan is being done from

$filename \filename

is the name of the file to check

$file \file

a PhingFile object the selector can use

Returns
Type Description
\whether the file should be selected or not
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()\BaseExtendSelector::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()\BaseExtendSelector::noChildrenAllowed()
methodpublicparsingComplete( ) : void
inherited

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

Inherited from: \DataType::parsingComplete()\BaseSelector::parsingComplete()\BaseExtendSelector::parsingComplete()
methodpublicsetCasesensitive( boolean $casesensitive ) : void

Whether to ignore case in the string being searched.

Parameters
Name Type Description
$casesensitive boolean

whether to pay attention to case sensitivity

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()\BaseExtendSelector::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()\BaseExtendSelector::setError()
Parameters
Name Type Description
$msg \msg

The error message any BuildException should throw.

methodpublicsetParameters( array $parameters ) : void

When using this as a custom selector, this method will be called.

It translates each parameter into the appropriate setXXX() call.

Parameters
Name Type Description
$parameters array

the complete set of parameters for this selector

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\DataType::setProject()\BaseSelector::setProject()\BaseExtendSelector::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()\BaseExtendSelector::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
methodpublicsetText( string $contains ) : void

The string to search for within a file.

Parameters
Name Type Description
$contains string

the string that a file must contain to be selected.

methodpublictoString( ) : void

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()\BaseExtendSelector::tooManyAttributes()
methodpublicvalidate( ) : void
inherited

Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.

Inherited from: \BaseSelector::validate()\BaseExtendSelector::validate()
methodpublicverifySettings( ) : void

Checks to make sure all settings are kosher. In this case, it means that the pattern attribute has been set.

Documentation was generated by DocBlox 0.18.1.