tasks/system/TstampTask.php

Show:

inherited

Classes
- \TstampCustomFormat
- \TstampTask

Table of Contents

Sets properties to the current time, or offsets from the current time.

The default properties are TSTAMP, DSTAMP and TODAY;

Based on Ant's Tstamp task.

Author: Michiel Rook
Package: phing.tasks.system
Since: 2.2.0
Version: $Id$

\TstampCustomFormat
jump to top

Package: phing\tasks\system

Properties


                 $locale= '""'

Default value""Details

Type: n/a


                 $pattern= '""'

Default value""Details

Type: n/a


                 $propertyName= '""'

Default value""Details

Type: n/a

Methods

execute(
          \TstampTask $tstamp
          )
        
        :
          void

validate parameter and execute the format.

Parameters

Name	Type	Description
$tstamp	\TstampTask	reference to task

setLocale(
           $locale
          )
        
        :
          void

The locale used to create date/time string.

Parameters

Name	Type	Description
$locale		locale

setPattern(
           $pattern
          )
        
        :
          void

The date/time pattern to be used. The values are as defined by the PHP strftime() function.

Parameters

Name	Type	Description
$pattern		pattern

setProperty(
          \propertyName $propertyName
          )
        
        :
          void

The property to receive the date/time string in the given pattern

Parameters

Name	Type	Description
$propertyName	\propertyName	the name of the property.

\TstampTask
jump to top

Package: phing\tasks\system

Sets properties to the current time, or offsets from the current time.

The default properties are TSTAMP, DSTAMP and TODAY;

Based on Ant's Tstamp task.

Parent(s): \Task < \ProjectComponent
Author: Michiel Rook
Copyright: 2001,2002 THYRELL. All rights reserved
Since: 2.2.0
Version: $Id$

Properties


                 $customFormats= 'array()'

Default valuearray()Details

Type: n/a

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

Type: string
Inherited_from: \Task::$$description

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

Type: \Location
Inherited_from: \Task::$$location


                 $prefix= '""'

Default value""Details

Type: n/a

\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 \Task::$$project

Default valuenullDetails

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

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target

Details

Type: \Target
Inherited_from: \Task::$$target

string
                 $taskName= ''

inherited

Taskname for logger

Inherited from: \Task::$$taskName

Details

Type: string
Inherited_from: \Task::$$taskName

string
                 $taskType= ''

inherited

Internal taskname (req)

Inherited from: \Task::$$taskType

Details

Type: string
Inherited_from: \Task::$$taskType

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$$wrapper

Methods

addFormat(
          \TstampCustomFormat $cf
          )
        
        :
          void

Adds a custom format

Parameters

Name	Type	Description
$cf	\TstampCustomFormat	custom format

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

getLocation(
          
          )
        
        :
          \Location

inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()

Returns

Type	Description
\Location	The location object describing the position of this task within the buildfile.

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          string

inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()

Returns

Type	Description
string	The type of this task (XML Tag)

inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws

Exception	Description
\BuildException

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

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

Parameters

Name	Type	Description
$msg	string	The message to log
$level	integer	The priority of the message

Details

See: \BuildEvent
See: \BuildListener

Create the timestamps. Custom ones are done before the standard ones.

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Throws

Exception	Description
\BuildException

maybeConfigure(
          
          )
        
        :
          void

inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

prefixProperty(
           $name,  $value
          )
        
        :
          void

helper that encapsulates prefix logic and property setting policy (i.e. we use setNewProperty instead of setProperty).

Parameters

Name	Type	Description
$name
$value

setDescription(
          string $desc
          )
        
        :
          void

inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()

Parameters

Name	Type	Description
$desc	string	The text describing the task

setLocation(
          \Location $location
          )
        
        :
          void

inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()

Parameters

Name	Type	Description
$location	\Location	The location object describing the position of this task within the buildfile.

setOwningTarget(
          \Target $target
          )
        
        :
          void

inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()

Parameters

Name	Type	Description
$target	\Target	Reference to owning target

setPrefix(
          \prefix $prefix
          )
        
        :
          void

Set a prefix for the properties. If the prefix does not end with a "." one is automatically added.

Parameters

Name	Type	Description
$prefix	\prefix	the prefix to use.

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()

Parameters

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

setRuntimeConfigurableWrapper(
          \RuntimeConfigurable $wrapper
          )
        
        :
          void

inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()

Parameters

Name	Type	Description
$wrapper	\RuntimeConfigurable	The wrapper object this task should use

setTaskName(
          string $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string	A string representing the name of this task for log

setTaskType(
          string $name
          )
        
        :
          void

inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()

Parameters

Name	Type	Description
$name	string	The type of this task (XML Tag)

tasks/system/TstampTask.php

\TstampCustomFormatjump to top

Properties

Methods

\TstampTaskjump to top

Properties

Methods

\TstampCustomFormat
jump to top

\TstampTask
jump to top