tasks/ext/zendguard/ZendGuardLicenseTask.php

Show: inherited
Table of Contents

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  
Package
phing.tasks.ext.zendguard  
Since
2.4.3  
Version
$Id: 96af59b9cbecaf7f146dffab1d0b5a806a56b47f $  

\ZendGuardLicenseTask

Package: phing\tasks\ext\zendguard

Produce license files using Zeng Guard.

The task can produce a license file from the given license properties or it can use a template.

Parent(s)
\Task < \ProjectComponent
Author
Petr Rybak  
Copyright
2001,2002 THYRELL. All rights reserved  
Since
2.4.3  
Version
$Id: 96af59b9cbecaf7f146dffab1d0b5a806a56b47f $  

Properties

Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprotectedstring  $expires= ''

Expiration date of the license. 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

Details
Type
string
Propertyprotectedbool  $hardwareLocked= ''

Option that indicates if the license will be locked to a specific machine using the Zend Host ID code(s). If set to YES, the Host-ID is required.

OPTIONAL

Details
Type
bool
Propertyprotectedstring  $hostID= ''

Coded string (Zend Host ID) used to lock the license to a specific hardware. 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

Details
Type
string
Propertyprotectedstring  $ipRange= ''

Limits the use of the license to IP addresses that fall within specification. 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

Details
Type
string
Propertyprotectedstring  $licenseTemplate= ''

Path to license template. If specified all license properties will be ignored and the template will be used to generate the file.

Details
Type
string
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprotectedstring  $outputFile= ''

Where to store the signed license file

Details
Type
string
Propertyprotectedstring  $privateKeyPath= ''

Path to private key that will be used to sign the license

Details
Type
string
Propertyprotectedstring  $productName= ''

The name assigned to Product. This must be the same name used when encoding the PHP files.

REQUIRED

Details
Type
string
Propertyprotected\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  
Propertyprotectedstring  $registeredTo= ''

The Name of the Registered owner of the license.

REQUIRED

Details
Type
string
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Propertyprivate  $tmpLicensePath= ''
Details
Type
n/a
Propertyprotectedstring  $userDefinedValues= ''

Semi-colon separated user defined values that will be part of the license. These values CANNOT be modified after the license is produced. Modification would invalidate the license.

OPTIONAL Example: Tea=Mint Flavor;Coffee=Arabica

Details
Type
string
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  
Propertyprotectedstring  $xUserDefinedValues= ''

Semi-colon separated user defined x-values that will be part of the license. These values CAN be modified after the license is produced. Modification won't invalidate the license.

OPTIONAL Example: Tea=Mint Flavor;Coffee=Arabica

Details
Type
string
Propertyprotected  $zendsignCommand= ''
Details
Type
n/a
Propertyprotectedstring  $zendsignPath= ''

Path to Zend Guard zendenc_sign executable

Details
Type
string

Methods

methodprivatecleanupTmpFiles( ) : void

If temporary license file was created during the process this will remove it

methodprotectedgenerateLicense( ) : void

Creates the signed license at the defined output path

methodprotectedgenerateLicenseTemplate( ) : string

It will generate a temporary license template based on the properties defined.

Returns
Type Description
string Path of the temporary license template file
methodprotectedgenerateLicenseTemplateContent( ) : string

Generates license template content based on the defined parameters

Returns
Type Description
string
methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
methodprotectedgetLicenseTemplatePath( ) : string

Checks if the license template path is defined and returns it.

If it the license template path is not defined it will generate a temporary template file and provide it as a template.

Returns
Type Description
string
methodpublicgetLocation( ) : \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.
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()
Returns
Type Description
\Project Reference to current porject object
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : 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)
methodpublicinit( ) : void
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
methodpubliclog( 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  
methodpublicmain( ) : void

Do the work

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

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

Inherited from: \Task::maybeConfigure()
methodprotectedparseAndAddUserDefinedValues( \stirng $valueString, array $valueArray, string $keyPrefix = '',  $pairSeparator = ';' ) : void

Parse the given string in format like key1=value1;key2=value2;... and converts it to array (key1=>value1, key2=value2, ...)

Parameters
Name Type Description
$valueString \stirng

Semi-colon separated value pairs

$valueArray array

Array to which the values will be added

$keyPrefix string

Prefix to use when adding the key

$pairSeparator
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()
methodprotectedprepareSignCommand( ) : string

Prepares and returns the command that will be used to create the license.

Returns
Type Description
string
methodpublicsetDescription( 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

methodpublicsetExpires( mixed $expires ) : string

Process the expires property. 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)

Parameters
Name Type Description
$expires mixed
Returns
Type Description
string
methodpublicsetHardwareLocked(  $hardwareLocked ) : void

Parameters
Name Type Description
$hardwareLocked
methodpublicsetHostID(  $hostID ) : void

Parameters
Name Type Description
$hostID
methodpublicsetIpRange(  $iprange ) : void

Parameters
Name Type Description
$iprange
methodpublicsetLicenseTemplate(  $value ) : void

Parameters
Name Type Description
$value
methodpublicsetLocation( \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.

methodpublicsetOutputFile(  $outputFile ) : void

Parameters
Name Type Description
$outputFile
methodpublicsetOwningTarget( \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

methodpublicsetPrivateKeyPath(  $privateKeyPath ) : void

Parameters
Name Type Description
$privateKeyPath
methodpublicsetProductName(  $productName ) : void

Parameters
Name Type Description
$productName
methodpublicsetProject( \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

methodpublicsetRegisteredTo(  $registeredTo ) : void

Parameters
Name Type Description
$registeredTo
methodpublicsetRuntimeConfigurableWrapper( \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

methodpublicsetTaskName( 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
methodpublicsetTaskType( 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)

methodpublicsetUserDefinedValues(  $userDefinedValues ) : void

Parameters
Name Type Description
$userDefinedValues
methodpublicsetXUserDefinedValues(  $xUserDefinedValues ) : void

Parameters
Name Type Description
$xUserDefinedValues
methodpublicsetZendsignPath(  $zendsignPath ) : void

Parameters
Name Type Description
$zendsignPath
methodprotectedverifyConfiguration( ) : void

Verifies that the configuration is correct

Throws
Exception Description
\BuildException
Documentation was generated by DocBlox 0.18.1.