Docs For Class CriticalI_Project

Description

Utilities for tracking and performing install operations for a given package in a project.

Located in /Core/lib/CriticalI/Project/InstallOperation.php (line 10)

Variable Summary

mixed $configWriter

mixed $dependencies

mixed $filesAdded

mixed $packageVersion

mixed $project

Method Summary

CriticalI_Project_InstallOperation __construct (CriticalI_Project $project, CriticalI_Package_Version $packageVersion)

void abort ()

void add_dependency_item (string $pkgName, string $versionSpec)

void copy (string $src, string $dest)

void dependency_string ()

int directory_entry_count (string $dir)

void ensure_config_file_exists ()

void file_list ()

void is_absolute (string $path)

void mkdir (string $dirname)

void package_version (CriticalI_Project_Version 0)

CriticalI_Project project ()

void set_config_value (string $key, string $value)

boolean set_default_config_value (string $key, string $value)

Variables

mixed $configWriter (line 15)

access: protected

mixed $dependencies (line 13)

access: protected

mixed $filesAdded (line 14)

access: protected

mixed $packageVersion (line 12)

access: protected

mixed $project (line 11)

access: protected

Methods

Constructor __construct (line 23)

Constructor

access: public

CriticalI_Project_InstallOperation __construct (CriticalI_Project $project, CriticalI_Package_Version $packageVersion)

CriticalI_Project $project: The project the install operation is for
CriticalI_Package_Version $packageVersion: The package being installed

abort (line 225)

Abort a failed installation. Removes all files that were created and any directories that were created as long as they contain no files (after removing added files).

access: public

void abort ()

add_dependency_item (line 67)

Add an item to the dependency list

access: public

void add_dependency_item (string $pkgName, string $versionSpec)

string $pkgName: The name of the required package
string $versionSpec: The version specification associated with the package

copy (line 82)

Copy a file into the project. Creates any needed directories. If a

directory is given as the source, the entire directory is copied recursively to the destination. Note that when copying directories recursively, any child directories whose names begin with a dot are ignored. If the destination is given as a relative path, it is assumed to be relative to the project root.

access: public

void copy (string $src, string $dest)

string $src: Source file
string $dest: Destination filename

dependency_string (line 50)

Return the dependency string for installation

access: public

void dependency_string ()

directory_entry_count (line 268)

Count the number of entries in a directory (not counting self and parent)

return: Count of entries or false on error
access: protected

int directory_entry_count (string $dir)

string $dir: The directory to check

ensure_config_file_exists (line 286)

Create a config file on the fly if default properties are requested

access: protected

void ensure_config_file_exists ()

file_list (line 57)

Return the set of files added during the installation

access: public

void file_list ()

is_absolute (line 257)

Test a path to see if it is absolute

access: protected

void is_absolute (string $path)

string $path: The path to test

mkdir (line 157)

Make a directory in the project. Creates any needed directories parent directories. If the directory is given as a relative path, it is assumed to be relative to the project root.

access: public

void mkdir (string $dirname)

string $dirname: The directory to make

package_version (line 43)

Return the package being installed

access: public

void package_version (CriticalI_Project_Version 0)

CriticalI_Project_Version 0

project (line 35)

Return the project associated with this installation

access: public

CriticalI_Project project ()

set_config_value (line 210)

Set a configuration value in the project. This will override any existing value.

access: public

void set_config_value (string $key, string $value)

string $key: The key to set the value for
string $value: The new default value

set_default_config_value (line 192)

Set a default configuration value in the project. If no corresponding key in the configuration is set, defines a new value for it.

return: Returns true if a value was set, false otherwise
access: public

boolean set_default_config_value (string $key, string $value)

string $key: The key to (potentially) set a default value for
string $value: The new default value