types/selectors/DateSelector.php

Show:

inherited

Classes
- \DateSelector

Table of Contents

Selector that chooses files based on their last modified date. Ant uses millisecond precision (thanks to Java); PHP is forced to use only seconds precision.

Author: Hans Lellelid (Phing)
Author: Bruce Atherton (Ant)
Package: phing.types.selectors
Version: $Revision: 1207 $

\DateSelector
jump to top

Package: phing\types\selectors

Selector that chooses files based on their last modified date. Ant uses millisecond precision (thanks to Java); PHP is forced to use only seconds precision.

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 < \BaseSelector < \DataType < \ProjectComponent
Author: Hans Lellelid (Phing)
Author: Bruce Atherton (Ant)
Version: $Revision: 1207 $

Constants

 
                MILLIS_KEY
                = "millis"

 
                DATETIME_KEY
                = "datetime"

 
                CHECKDIRS_KEY
                = "checkdirs"

 
                GRANULARITY_KEY
                = "granularity"

 
                WHEN_KEY
                = "when"

Properties

boolean
                 $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


                 $cmp= '2'

Default value2Details

Type


                 $dateTime= 'null'

Default valuenullDetails

Type


                 $description= 'null'

inherited

The descriptin the user has set.

Inherited from: \DataType::$description

Default valuenullDetails

Type
Inherited_from: \DataType::$description


                 $granularity= '0'

Default value0Details

Type


                 $includeDirs= 'false'

Default valuefalseDetails

Type


                 $parameters= 'null'

inherited

The passed in parameter array.

Inherited from: \BaseExtendSelector::$parameters

Default valuenullDetails

Type
Inherited_from: \BaseExtendSelector::$parameters

\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

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$project


                 $ref= 'null'

inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$ref

Default valuenullDetails

Type
Inherited_from: \DataType::$ref


                 $seconds= '-1'

Default value-1Details

Type


                 $timeComparisons= 'array("before"'

static

Default valuearray("before"Details

Type

Methods

__construct(
          
          )
        
        :
          void

circularReference(
          
          )
        
        :
          void

inherited

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

Inherited from: \DataType::circularReference()

dieOnCircularReference(
           $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

getCheckedRef(
           $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

getDescription(
          
          )
        
        :
          void

inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()

getError(
          
          )
        
        :
          \the

inherited

Returns any error messages that have been set.

Inherited from: \BaseSelector::getError()

Returns

Type	Description
\the	error condition

getParameters(
          
          )
        
        :
          \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

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getSeconds(
          
          )
        
        :
          void

Returns the seconds value the selector is set for.

isReference(
          
          )
        
        :
          void

inherited

Has the refid attribute of this element been set?

Inherited from: \DataType::isReference()

isSelected(
          \PhingFile $basedir, string $filename, \PhingFile $file
          )
        
        :
          boolean

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	\PhingFile	the base directory the scan is being done from
$filename	string	is the name of the file to check
$file	\PhingFile	is a PhingFile object the selector can use

Returns

Type	Description
boolean	Whether the file should be selected or not

Throws

Exception	Description
\BuildException	if the selector was not configured correctly

log(
           $msg, integer $level
              =
              Project::MSG_INFO
          )
        
        :
          void

inherited

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()

@param string $msg The message to be logged.

Parameters

Name	Type	Description
$msg
$level	integer	The message's priority at this message should have

noChildrenAllowed(
          
          )
        
        :
          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()

parsingComplete(
          
          )
        
        :
          void

inherited

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

Inherited from: \DataType::parsingComplete()

setCheckdirs(
          boolean $includeDirs
          )
        
        :
          void

Should we be checking dates on directories?

Parameters

Name	Type	Description
$includeDirs	boolean	whether to check the timestamp on directories

setDatetime(
          string $dateTime
          )
        
        :
          void

Sets the date. The user must supply it in MM/DD/YYYY HH:MM AM_PM format

Parameters

Name	Type	Description
$dateTime	string	a string in MM/DD/YYYY HH:MM AM_PM format

setDescription(
           $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

setError(
          \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.

setGranularity(
          int $granularity
          )
        
        :
          void

Sets the number of milliseconds leeway we will give before we consider a file not to have matched a date.

Parameters

Name	Type	Description
$granularity	int

setParameters(
          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

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

setRefid(
          \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

setSeconds(
          int $seconds
          )
        
        :
          void

For users that prefer to express time in seconds since 1970

Parameters

Name	Type	Description
$seconds	int	the time to compare file's last modified date to, expressed in milliseconds

setWhen(
          string $cmp
          )
        
        :
          void

Sets the type of comparison to be done on the file's last modified date.

Parameters

Name	Type	Description
$cmp	string	The comparison to perform

toString(
          
          )
        
        :
          void

tooManyAttributes(
          
          )
        
        :
          void

inherited

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

Inherited from: \DataType::tooManyAttributes()

validate(
          
          )
        
        :
          void

inherited

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

Inherited from: \BaseSelector::validate()

verifySettings(
          
          )
        
        :
          void

This is a consistency check to ensure the selector's required values have been set.

types/selectors/DateSelector.php

\DateSelectorjump to top

Constants

Properties

Methods

\DateSelector
jump to top