C.69 PhkPackageTask

This task runs PHK_Creator.phk to build PHK-package. Learn more about build process in PHK Builder's Guide.

Table C.89: Attributes

NameTypeDescriptionDefaultRequired
phkcreatorpathStringPath to PHK_Creator.phk.n/aYes
inputdirectoryStringPath to directory, that will be packed.n/aYes
outputfileStringOutput PHK-file. Directory, where file will be stored, must exist!n/aYes
compressStringCompression type (gzip, bzip2, none) to apply to the packed files.noneNo
stripBooleanWhen true, PHP source file(s) are stripped (filtered through php_strip_whitespace()) before being stored into the archive.falseNo
nameStringThe package's name (Information only).n/aNo
webrunscriptStringThe script to run in web direct access mode. Subfile path.n/aNo
crccheckBooleanIf true, a CRC check will be forced every time the package is mounted.falseNo

C.69.1 Example

Sample build command:

<phkpackage
    phkcreatorpath="/path/to/PHK_Creator.phk"
    inputdirectory="src"
    outputfile="build/sample-project.phk"
    compress="gzip"
    strip="true"
    name="Sample Project"
    webrunscript="index.php">
    <webaccess>
        <paentry>/</paentry>
    </webaccess>
</phkpackage>

C.69.2 Supported Nested Tags

  • webaccess

    Collection of path tags (see example below), that will be visible outside package in web mode.