Docs For Class CriticalI_Package

Description

A Wrapper contains an archived package version.

Located in /Core/lib/CriticalI/Package/Wrapper.php (line 9)

Variable Summary

mixed $location

mixed $name

mixed $packageName

mixed $packageVersion

mixed $properties

Method Summary

static CriticalI_Package_Wrapper create (string $outfile, CriticalI_Paackage_Version $version)

CriticalI_Package_Wrapper __construct (string $location, [string $name = null])

void assert_zip_exists ()

void load_properties ()

string location ()

string name ()

string package_name ()

string package_version ()

mixed property (string $name, [mixed $default = null])

void recursive_list ( $dir)

void unwrap (string $directory)

void wrap (CriticalI_Paackage_Version $version)

void wrap_version_files ( $version, $zip)

void zip_status ( $zip)

Variables

mixed $location (line 10)

access: protected

mixed $name (line 12)

access: protected

mixed $packageName (line 13)

access: protected

mixed $packageVersion (line 14)

access: protected

mixed $properties (line 11)

access: protected

Methods

static create (line 100)

Utility for creating a new Wrapper from a package version

access: public

CriticalI_Package_Wrapper create (string $outfile, CriticalI_Paackage_Version $version)

string $outfile: The output location
CriticalI_Paackage_Version $version: The version to wrap

Constructor __construct (line 22)

Constructor

access: public

CriticalI_Package_Wrapper __construct (string $location, [string $name = null])

string $location: The path or URL to the wrapper file
string $name: Can be used to override the base file name when the wrapper is a temp file

assert_zip_exists (line 165)

Throws an exception if this version of PHP does not have the right

ZIP support

access: protected

void assert_zip_exists ()

load_properties (line 134)

Load the properties from the archive

access: protected

void load_properties ()

location (line 35)

Return the path or URL to the wrapper

access: public

string location ()

name (line 44)

Return the name of this wrapper (the combined package name and

version)

access: public

string name ()

package_name (line 52)

Return the contained package name

access: public

string package_name ()

package_version (line 70)

Return the contained package version number

access: public

string package_version ()

property (line 87)

Return the value of a property for the wrapped package version

access: public

mixed property (string $name, [mixed $default = null])

string $name: The name of the property to retrieve
mixed $default: The default value for the property if not found

recursive_list (line 217)

Recursively list the contents of a directory

access: protected

void recursive_list ( $dir)

$dir

unwrap (line 113)

Extract a wrapped package to the given directory

access: public

void unwrap (string $directory)

string $directory: The output location

wrap (line 177)

Called internally to assemble a new wrapper

access: protected

void wrap (CriticalI_Paackage_Version $version)

CriticalI_Paackage_Version $version: The version to wrap

wrap_version_files (line 197)

Insert files from a package version into a new wrapper

access: protected

void wrap_version_files ( $version, $zip)

$version
$zip

zip_status (line 253)

Return a status message from a zip object (if possible)

access: public

void zip_status ( $zip)

$zip