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.

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


                 $cmp= '2'

Default value2Details

Type: n/a


                 $dateTime= 'null'

Default valuenullDetails

Type: n/a


                 $granularity= '0'

Default value0Details

Type: n/a


                 $includeDirs= 'false'

Default valuefalseDetails

Type: n/a


                 $seconds= '-1'

Default value-1Details

Type: n/a


                 $timeComparisons= 'array("before"'

static

Default valuearray("before"Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

circularReference(
          
          )
        
        :
          void

dieOnCircularReference(
          
          )
        
        :
          void

getCheckedRef(
          
          )
        
        :
          void

getDescription(
          
          )
        
        :
          void

getError(
          
          )
        
        :
          void

getParameters(
          
          )
        
        :
          void

getProject(
          
          )
        
        :
          void

getSeconds(
          
          )
        
        :
          void

Returns the seconds value the selector is set for.

isReference(
          
          )
        
        :
          void

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

noChildrenAllowed(
          
          )
        
        :
          void

parsingComplete(
          
          )
        
        :
          void

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

setError(
          
          )
        
        :
          void

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

setRefid(
          
          )
        
        :
          void

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

validate(
          
          )
        
        :
          void

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