types/PatternSet.php

Show: inherited
Table of Contents

The patternset storage component. Carries all necessary data and methods for the patternset stuff.

Author
Andreas Aderhold, andi@binarycloud.com  
Package
phing.types  
Version
$Id: af3bd3709d79ad0299bf6ec0130a8a244ee325ab $  

\PatternSet

Package: phing\types

The patternset storage component. Carries all necessary data and methods for the patternset stuff.

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
Andreas Aderhold, andi@binarycloud.com  
Version
$Id: af3bd3709d79ad0299bf6ec0130a8a244ee325ab $  

Properties

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  
Propertyprivate  $excludeList= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $excludesFileList= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $includeList= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $includesFileList= 'array()'
Default valuearray()Details
Type
n/a
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

methodprivateaddPatternToList( array $list ) : \PatternSetNameEntry

add a name entry to the given list

Parameters
Name Type Description
$list array

List onto which the nameentry should be added

Returns
Type Description
\PatternSetNameEntry Reference to the created PsetNameEntry instance
methodpublicappend(  $other,  $p ) : void

Adds the patterns of the other instance to this set.

Parameters
Name Type Description
$other
$p
methodpubliccircularReference( ) : void
inherited

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

Inherited from: \DataType::circularReference()
methodpubliccreateExclude( ) : \PatternSetNameEntry

Add a name entry on the exclude list

Returns
Type Description
\PatternSetNameEntry Reference to object
Throws
Exception Description
\BuildException
methodpubliccreateExcludesFile( ) : \PatternSetNameEntry

add a name entry on the exclude files list

Returns
Type Description
\PatternSetNameEntry Reference to object
Throws
Exception Description
\BuildException
methodpubliccreateInclude( ) : \PatternSetNameEntry

Add a name entry on the include list

Returns
Type Description
\PatternSetNameEntry Reference to object
Throws
Exception Description
\BuildException
methodpubliccreateIncludesFile( ) : \PatternSetNameEntry

Add a name entry on the include files list

Returns
Type Description
\PatternSetNameEntry Reference to object
Throws
Exception Description
\BuildException
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()
methodpublicgetExcludePatterns(  $p ) : void

Returns the filtered exclude patterns.

Parameters
Name Type Description
$p
methodpublicgetIncludePatterns(  $p ) : void

Returns the filtered include patterns.

Parameters
Name Type Description
$p
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

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

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

Parameters
Name Type Description
$p
methodpublichasPatterns( ) : void

helper for FileSet.

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

methodprivatemakeArray(  $list,  $p ) : void

Convert a array of PatternSetNameEntry elements into an array of Strings.

Parameters
Name Type Description
$list
$p
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()
methodprivatereadFiles(  $p ) : void

Read includesfile or excludesfile if not already done so.

Parameters
Name Type Description
$p
methodprivatereadPatterns(  $patternfile,  $patternlist,  $p ) : void

Reads path matching patterns from a file and adds them to the includes or excludes list

Parameters
Name Type Description
$patternfile
$patternlist
$p
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
methodpublicsetExcludes( string $excludes ) : void

Sets the set of exclude patterns. Patterns may be separated by a comma or a space.

Parameters
Name Type Description
$excludes string

the string containing the exclude patterns

Throws
Exception Description
\BuildException
methodpublicsetExcludesFile( \excludesFile $excludesFile ) : void

Sets the name of the file containing the excludes patterns.

Parameters
Name Type Description
$excludesFile \excludesFile

The file to fetch the exclude patterns from.

methodpublicsetIncludes( string $includes ) : void

Sets the set of include patterns. Patterns may be separated by a comma or a space.

Parameters
Name Type Description
$includes string

the string containing the include patterns

Throws
Exception Description
\BuildException
methodpublicsetIncludesFile( \includesFile $includesFile ) : void

Sets the name of the file containing the includes patterns.

Parameters
Name Type Description
$includesFile \includesFile

The file to fetch the include patterns from.

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

Makes this instance in effect a reference to another PatternSet instance.

You must not set another attribute or nest elements inside this element if you make it a reference.

Parameters
Name Type Description
$r \Reference
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()

\PatternSetNameEntry

Package: phing\types

"Internal" class for holding an include/exclude pattern.

Properties

Propertyprivatestring  $ifCond= ''

The if-condition property for this pattern to be applied.

Details
Type
string
Propertyprivatestring  $name= ''

The pattern.

Details
Type
string
Propertyprivatestring  $unlessCond= ''

The unless-condition property for this pattern to be applied.

Details
Type
string

Methods

methodpublicevalName(  $project ) : string

Evaluates the pattern.

Parameters
Name Type Description
$project
Returns
Type Description
string The pattern or null if it is ruled out by a condition.
methodpublicgetName( ) : string

Get the pattern text.

Returns
Type Description
string The pattern.
methodpublicsetIf( string $cond ) : void

Sets an if-condition property for this pattern to match.

Parameters
Name Type Description
$cond string
methodpublicsetName( string $name ) : void

Set the pattern text.

Parameters
Name Type Description
$name string

The pattern

methodpublicsetPattern( string $pattern ) : void

An alias for the setName() method.

Parameters
Name Type Description
$pattern string
Details
See
\setName()  
methodpublicsetUnless( string $cond ) : void

Sets an unless-condition property for this pattern to match.

Parameters
Name Type Description
$cond string
methodpublictoString( ) : string

Gets a string representation of this pattern.

Returns
Type Description
string
methodpublicvalid( \Project $project ) : boolean

Checks whether pattern should be applied based on whether the if and unless properties are set in project.

Parameters
Name Type Description
$project \Project
Returns
Type Description
boolean
Documentation was generated by DocBlox 0.18.1.