Produce license files using Zeng Guard.
The task can produce a license file from the given license properties or it can use a template.
| author | Petr Rybak |
|---|---|
| version | $Id: 96af59b9cbecaf7f146dffab1d0b5a806a56b47f $ |
| package | phing.tasks.ext.zendguard |
| since | 2.4.3 |
| copyright | 2001,2002 THYRELL. All rights reserved |
getDescription() : string
| inherited_from | \Task::getDescription() |
|---|
stringThe text description of the taskgetLocation() : \Location
Used by BuildException to give detailed error messages.
| inherited_from | \Task::getLocation() |
|---|
\LocationThe location object describing the position of this
task within the buildfile.getProject() : \Project
| inherited_from | \ProjectComponent::getProject() |
|---|---|
| inherited_from | \Task::getProject() |
\ProjectReference to current porject objectgetRuntimeConfigurableWrapper() : \RuntimeConfigurable
| inherited_from | \Task::getRuntimeConfigurableWrapper() |
|---|
\RuntimeConfigurableThe wrapper object used by this taskgetTaskName() : string
| inherited_from | \Task::getTaskName() |
|---|
stringName of this taskgetTaskType() : string
| inherited_from | \Task::getTaskType() |
|---|
stringThe type of this task (XML Tag)init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
| inherited_from | \Task::init() |
|---|
\BuildException |
|---|
log(string $msg, integer $level)
| see | \BuildEvent |
|---|---|
| see | \BuildListener |
| inherited_from | \Task::log() |
stringThe message to log
integerThe priority of the message
main()
This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
\BuildException |
|---|
maybeConfigure()
| inherited_from | \Task::maybeConfigure() |
|---|
perform()
| inherited_from | \Task::perform() |
|---|
setDescription(string $desc)
| inherited_from | \Task::setDescription() |
|---|
stringThe text describing the task
setExpires(mixed $expires) : string
If the value is empty (false, '', ...) it will set the value to 'Never' Otherwise it will run the value through strtotime so relative date and time notation can be used (e.g. +1 month)
mixed
stringsetHardwareLocked($hardwareLocked)
setHostID($hostID)
setIpRange($iprange)
setLicenseTemplate($value)
setLocation(\Location $location)
Called by the parser to set location information.
| inherited_from | \Task::setLocation() |
|---|
setOutputFile($outputFile)
setOwningTarget(\Target $target)
setPrivateKeyPath($privateKeyPath)
setProductName($productName)
setProject(\Project $project)
| inherited_from | \ProjectComponent::setProject() |
|---|---|
| inherited_from | \Task::setProject() |
setRegisteredTo($registeredTo)
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
| inherited_from | \Task::setRuntimeConfigurableWrapper() |
|---|
setTaskName(string $name) : string
| inherited_from | \Task::setTaskName() |
|---|
string
stringA string representing the name of this task for logsetTaskType(string $name)
Usually this is the name of the XML tag
| inherited_from | \Task::setTaskType() |
|---|
stringThe type of this task (XML Tag)
setUserDefinedValues($userDefinedValues)
setXUserDefinedValues($xUserDefinedValues)
setZendsignPath($zendsignPath)
generateLicense() : void
generateLicenseTemplate() : string
stringPath of the temporary license template filegenerateLicenseTemplateContent() : string
stringgetLicenseTemplatePath() : string
If it the license template path is not defined it will generate a temporary template file and provide it as a template.
stringgetRegisterSlot(string $slotName)
| inherited_from | \Task::getRegisterSlot() |
|---|
string
parseAndAddUserDefinedValues(\stirng $valueString, array $valueArray, string $keyPrefix, $pairSeparator) : void
.. and converts it to array (key1=>value1, key2=value2, ...)
\stirngSemi-colon separated value pairs
arrayArray to which the values will be added
stringPrefix to use when adding the key
prepareSignCommand() : string
stringcleanupTmpFiles() : void
$description : string
| inherited_from | \Task::$$description |
|---|
$expires : string
Used if the license is issued with a date restriction. Possible values: - 'Never', '0' or false: the license won't expire - A Date in format DD-MM-YYYY to set expiration for that date - Relative date supported by the PHP strtotime function (e.g. +1 month)
REQUIRED
$hardwareLocked : bool
If set to YES, the Host-ID is required.
OPTIONAL
$hostID : string
The Zend Host ID obtained from the machine where the encoded files and license are to be installed. The Zend Host ID code can be obtained by using the zendid utility. For more details, see Getting the Zend Host ID.
REQUIRED if Hardware-Locked is set equal to YES. Meaningless if Hardware-Locked is set equal to NO.
User semicolon to enter more than one Host-ID
Example: Host-ID = H:MFM43-Q9CXC-B9EDX-GWYSU;H:MFM43-Q9CXC-B9EDX-GWYTY
$ipRange : string
Supports wildcards for any of the IP place holders, as well as the two types of net masks (filters). Netmask pair An IP a.b.c.d, and a netmask w.x.y.z. (That is., 10.1.0.0/255.255.0.0), where the binary of mask is applied to filter IP addresses. ip/nnn (similar to a CIDR specification) This mask consists of nnn high-order 1 bits. (That is, 10.1.0.0/16 is the same as 10.1.0.0/255.255.0.0). Instead of spelling out the bits of the subnet mask, this mask notation is simply listed as the number of 1s bits that start the mask. Rather than writing the address and subnet mask as 192.60.128.0/255.255.252.0 the network address would be written simply as: 192.60.128.0/22 which indicates starting address of the network and number of 1s bits (22) in the network portion of the address. The mask in binary is (11111111.11111111.11111100.00000000).
OPTIONAL
Example (Wildcard): IP-Range = 10.1.. Example (Net Mask): IP-Range = 10.1.0.0/255.255.0.0 Example (Net Mask): IP-Range = 10.1.0.0/16
$licenseTemplate : string
If specified all license properties will be ignored and the template will be used to generate the file.
$outputFile : string
$privateKeyPath : string
$productName : string
This must be the same name used when encoding the PHP files.
REQUIRED
$project : \Project
| inherited_from | \ProjectComponent::$$project |
|---|---|
| inherited_from | \Task::$$project |
$registeredTo : string
REQUIRED
$taskName : string
| inherited_from | \Task::$$taskName |
|---|
$taskType : string
| inherited_from | \Task::$$taskType |
|---|
$userDefinedValues : string
These values CANNOT be modified after the license is produced. Modification would invalidate the license.
OPTIONAL Example: Tea=Mint Flavor;Coffee=Arabica
$xUserDefinedValues : string
These values CAN be modified after the license is produced. Modification won't invalidate the license.
OPTIONAL Example: Tea=Mint Flavor;Coffee=Arabica
$zendsignCommand
$zendsignPath : string
$tmpLicensePath