tasks/ext/zendguard/ZendGuardLicenseTask.php

Show:

inherited

Classes
- \ZendGuardLicenseTask

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: ZendGuardLicenseTask.php 1026 2011-01-06 15:13:50Z mrook $

\ZendGuardLicenseTask
jump to top

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
Since: 2.4.3
Version: $Id: ZendGuardLicenseTask.php 1026 2011-01-06 15:13:50Z mrook $

Properties

string
                 $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

bool
                 $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

string
                 $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

string
                 $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

string
                 $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

string
                 $outputFile= ''

Where to store the signed license file

Details

Type: string

string
                 $privateKeyPath= ''

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

Details

Type: string

string
                 $productName= ''

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

REQUIRED

Details

Type: string

string
                 $registeredTo= ''

The Name of the Registered owner of the license.

REQUIRED

Details

Type: string


                 $tmpLicensePath= ''

Details

Type: n/a

string
                 $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

string
                 $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


                 $zendsignCommand= ''

Details

Type: n/a

string
                 $zendsignPath= ''

Path to Zend Guard zendenc_sign executable

Details

Type: string

Methods

cleanupTmpFiles(
          
          )
        
        :
          void

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

generateLicense(
          
          )
        
        :
          void

Creates the signed license at the defined output path

generateLicenseTemplate(
          
          )
        
        :
          string

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

Returns

Type	Description
string	Path of the temporary license template file

generateLicenseTemplateContent(
          
          )
        
        :
          string

Generates license template content based on the defined parameters

Returns

Type	Description
string

getDescription(
          
          )
        
        :
          void

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

getLocation(
          
          )
        
        :
          void

getOwningTarget(
          
          )
        
        :
          void

getProject(
          
          )
        
        :
          void

getRegisterSlot(
          
          )
        
        :
          void

getRuntimeConfigurableWrapper(
          
          )
        
        :
          void

getTaskName(
          
          )
        
        :
          void

getTaskType(
          
          )
        
        :
          void

Do the work

Throws

Exception	Description
\BuildException

maybeConfigure(
          
          )
        
        :
          void

parseAndAddUserDefinedValues(
          \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

perform(
          
          )
        
        :
          void

prepareSignCommand(
          
          )
        
        :
          string

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

Returns

Type	Description
string

setDescription(
          
          )
        
        :
          void

setExpires(
          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

setHardwareLocked(
           $hardwareLocked
          )
        
        :
          void

Parameters

Name	Type	Description
$hardwareLocked

setHostID(
           $hostID
          )
        
        :
          void

Parameters

Name	Type	Description
$hostID

setIpRange(
           $iprange
          )
        
        :
          void

Parameters

Name	Type	Description
$iprange

setLicenseTemplate(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

setLocation(
          
          )
        
        :
          void

setOutputFile(
           $outputFile
          )
        
        :
          void

Parameters

Name	Type	Description
$outputFile

setOwningTarget(
          
          )
        
        :
          void

setPrivateKeyPath(
           $privateKeyPath
          )
        
        :
          void

Parameters

Name	Type	Description
$privateKeyPath

setProductName(
           $productName
          )
        
        :
          void

Parameters

Name	Type	Description
$productName

setProject(
          
          )
        
        :
          void

setRegisteredTo(
           $registeredTo
          )
        
        :
          void

Parameters

Name	Type	Description
$registeredTo

setRuntimeConfigurableWrapper(
          
          )
        
        :
          void

setTaskName(
          
          )
        
        :
          void

setTaskType(
          
          )
        
        :
          void

setUserDefinedValues(
           $userDefinedValues
          )
        
        :
          void

Parameters

Name	Type	Description
$userDefinedValues

setXUserDefinedValues(
           $xUserDefinedValues
          )
        
        :
          void

Parameters

Name	Type	Description
$xUserDefinedValues

setZendsignPath(
           $zendsignPath
          )
        
        :
          void

Parameters

Name	Type	Description
$zendsignPath

verifyConfiguration(
          
          )
        
        :
          void

Verifies that the configuration is correct

Throws

Exception	Description
\BuildException

tasks/ext/zendguard/ZendGuardLicenseTask.php

\ZendGuardLicenseTaskjump to top

Properties

Methods

\ZendGuardLicenseTask
jump to top