Docs For Class CriticalI_ChangeManager

Description

A Plan represents a planned set of Package_Version changes for a repository or project.

Located in /Core/lib/CriticalI/ChangeManager/Plan.php (line 10)

Variable Summary

mixed $add

mixed $remove

mixed $requirements

Method Summary

CriticalI_ChangeManager_Plan __construct ([CriticalI_ChangeManager_Plan $copy = null])

array add_list ()

void add_package (CriticalI_Pacakge_Version $packageVersion)

void index_of_package ( &$list, $packageName)

void index_of_requirement ( $name, $version)

void index_of_version ( &$list, $packageName, $packageVersion)

void index_of_version_specification ( &$list, $packageName, $packageVersion)

boolean is_on_add_list (string $packageName)

boolean is_on_remove_list (CriticalI_Package_Version $packageVersion)

CriticalI_Package_Version package_on_add_list (string $packageName)

array pop_requirement ()

void push_requirement (string $name, string $version)

array remove_list ()

void remove_package ( $packageVersion)

array requirements_list ()

int requirement_count ()

boolean satisfies_requirement ( $package, string $version, string $name)

boolean will_conflict (CriticalI_Package_Version $pkg)

void __toString ()

Variables

mixed $add (line 11)

access: protected

mixed $remove (line 12)

access: protected

mixed $requirements (line 13)

access: protected

Methods

Constructor __construct (line 20)

Constructor

access: public

CriticalI_ChangeManager_Plan __construct ([CriticalI_ChangeManager_Plan $copy = null])

CriticalI_ChangeManager_Plan $copy: Optional plan to create a copy of

add_list (line 31)

Return the list of packages to add

access: public

array add_list ()

add_package (line 154)

Add the package version to the add list

access: public

void add_package (CriticalI_Pacakge_Version $packageVersion)

CriticalI_Pacakge_Version $packageVersion: The package version object to add

index_of_package (line 239)

Search an array for a matching package (any version)

access: protected

void index_of_package ( &$list, $packageName)

&$list
$packageName

index_of_requirement (line 252)

Search the requirements array for a matching package and version

specification

access: protected

void index_of_requirement ( $name, $version)

$name
$version

index_of_version (line 225)

Search an array for a matching package version number

access: protected

void index_of_version ( &$list, $packageName, $packageVersion)

&$list
$packageName
$packageVersion

index_of_version_specification (line 211)

Search an array for a matching package version specification

access: protected

void index_of_version_specification ( &$list, $packageName, $packageVersion)

&$list
$packageName
$packageVersion

is_on_add_list (line 131)

Determine if the given package name is to be added

access: public

boolean is_on_add_list (string $packageName)

string $packageName: The name of the package to search for

is_on_remove_list (line 119)

Determine if the given package version is to be removed

access: public

boolean is_on_remove_list (CriticalI_Package_Version $packageVersion)

CriticalI_Package_Version $packageVersion: The version to search for

package_on_add_list (line 143)

Return the CriticalI_Package_Version instance with the given name from the add list

access: public

CriticalI_Package_Version package_on_add_list (string $packageName)

string $packageName: The name of the package to search for

pop_requirement (line 81)

Remove and return the last requirement from the list. Returns an array whose first element is the package name and whose second element is the version specification.

access: public

array pop_requirement ()

push_requirement (line 68)

Add a requirement to the list

access: public

void push_requirement (string $name, string $version)

string $name: Required package name
string $version: Required version specification

remove_list (line 40)

Return the list of packages to remove

access: public

array remove_list ()

remove_package (line 172)

Add a package to the remove list

access: public

void remove_package ( $packageVersion)

$packageVersion

requirements_list (line 49)

Return the list of requirements

access: public

array requirements_list ()

requirement_count (line 58)

Return the count of requirements in this plan's list

access: public

int requirement_count ()

satisfies_requirement (line 96)

Determine if this plan already provides the given package and version specification

access: public

boolean satisfies_requirement ( $package, string $version, string $name)

string $name: Package name to test
string $version: Version specification to test
$package

will_conflict (line 108)

Determine if the given package will conflict with planned packages to install

access: public

boolean will_conflict (CriticalI_Package_Version $pkg)

CriticalI_Package_Version $pkg: The package to test

__toString (line 190)

Returns a pretty representation of the plan

access: public

void __toString ()