tasks/system/TstampTask.php
inherited
Classes
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
- $Revision: 557 $
\TstampCustomFormat
Properties
$locale= '""'
""Details- Type
- n/a
$pattern= '""'
""Details- Type
- n/a
$propertyName= '""'
""Details- Type
- n/a
Methods
execute(
\TstampTask $tstamp
)
:
voidvalidate parameter and execute the format.
| Name | Type | Description |
|---|---|---|
| $tstamp | \TstampTask | reference to task |
setLocale(
$locale
)
:
voidThe locale used to create date/time string.
| Name | Type | Description |
|---|---|---|
| $locale | locale |
setPattern(
$pattern
)
:
voidThe date/time pattern to be used. The values are as defined by the PHP strftime() function.
| Name | Type | Description |
|---|---|---|
| $pattern | pattern |
setProperty(
\propertyName $propertyName
)
:
voidThe property to receive the date/time string in the given pattern
| Name | Type | Description |
|---|---|---|
| $propertyName | \propertyName | the name of the property. |
\TstampTask
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
- Since
- 2.2.0
- Version
- $Revision: 557 $
Properties
$customFormats= 'array()'
array()Details- Type
- n/a
$prefix= '""'
""Details- Type
- n/a
Methods
addFormat(
\TstampCustomFormat $cf
)
:
voidAdds a custom format
| Name | Type | Description |
|---|---|---|
| $cf | \TstampCustomFormat | custom format |
getDescription(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidlog(
)
:
voidmain(
)
:
voidCreate the timestamps. Custom ones are done before the standard ones.
| Exception | Description |
|---|---|
| \BuildException |
maybeConfigure(
)
:
voidperform(
)
:
voidprefixProperty(
$name, $value
)
:
voidhelper that encapsulates prefix logic and property setting policy (i.e. we use setNewProperty instead of setProperty).
| Name | Type | Description |
|---|---|---|
| $name | ||
| $value |
setDescription(
)
:
voidsetLocation(
)
:
voidsetOwningTarget(
)
:
voidsetPrefix(
\prefix $prefix
)
:
voidSet a prefix for the properties. If the prefix does not end with a "." one is automatically added.
| Name | Type | Description |
|---|---|---|
| $prefix | \prefix | the prefix to use. |
setProject(
)
:
voidsetRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
void