[criticali] element index

Package indexes

All elements
a b c d e f g h i l m n o p q r s t u v w z _
_
top
Function __autoload
__autoload() in command_autoloader.php
Autoloader used by the command line tool.
Method __construct
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor.
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor.
Method __construct
Constructor.
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Method __construct
CriticalI_UnknownPackageVersionError::__construct() in UnknownPackageVersionError.php
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Method __construct
Constructor.
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Method __construct
Method __construct
Method __construct
Constructor.
Method __construct
Constructor
Method __construct
Method __construct
Constructor
Method __construct
Method __construct
Constructor
Method __construct
Method __construct
Method __construct
CriticalI_MissingPackageVersionError::__construct() in MissingPackageVersionError.php
Constructor
Method __construct
Method __construct
Method __construct
Constructor
Method __toString
Returns a pretty representation of the plan
a
top
Variable $add
Variable $allConnections
Variable $allowMultipleVersions
Variable $any
Variable $archive
Variable $args
Variable $argument
Variable $arguments
Variable $argument_name
NONE, REQUIRED, or OPTIONAL *
Variable $argument_type
Method abort
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).
Method add
Add (install) a new wrapped package to the repository
Method add
Add a package to the project.
Method add_commands_by_glob
Adds command classes given a base directory relative to CRITICALI_ROOT and a file globbing pattern.
Method add_dependency_item
Add an item to the dependency list
Method add_init_file
Add a file to the list in the init_files property. This method also prevents files from being added to the list more than once.
Method add_list
Return the list of packages to add
Method add_package
Add the package version to the add list
Method add_package_to_autoloader
Convenience method for including a given package and its dependencies in the runtime autoload directory list. The package must be installed for this to work (otherwise an exception will result).
Method add_remote
Add a remote that provides the package to the list
Method add_row
Add a row of data to the table
Method add_to_version_list
Add a version to a version list string and maintain sort order
Method add_to_width
Update width statistics with information from a cell
Method add_version
Add a version to this collection
Method add_version_to_packages_file
Update the installation list file with a single added package directory
Method all
Return all properties as an associative array
Method apportion_width
Determines column width when it is constrained
Method arguments
Return the arguments that remain after processing
Method assert_zip_exists
Throws an exception if this version of PHP does not have the right
Method assign_expr
Returns an assignment expression for a given array of keys to use in the output file.
b
top
Method batch_save
Write a collection of properties to the repository
Method build_columns
Build the columns for formatting the table
Method build_fixture_sql
Builds the INSERT SQL statement for a set of fixture data
c
top
Variable $commands
Variable $configWriter
Variable $connection
Method calculate_column_width
Calculate the width to use for a set of columns
Method canonify_version
Utility function to return the canonical three-part version number
Method canonify_version_specification
Returns a comparable version spec object given a version dependency string. See CriticalI_Package::satisify_dependency for formation information.
Method class_name
Convert a path into the class name that should be contained within the file
Method cleanup
Called automatically on shutdown to clean up after the lock file.
Method clean_name
Return a cleaned version of this packages name with spaces and special characters removed.
Method clean_root_directory
Return a cleaned version of the global variable $CRITICALI_ROOT for
Method clear
Forces CriticalI_Package_List to skip loading of packages and present an empty list for subsequent class to get.
Method commandVersions
Return the list of package versions that declare commands
Class Constant COMMAND_GLOB
Method compare_versions
Comparison function for sorting Version objects
Method compare_version_arrays
Comparison function for sorting canonified version arrays
Method compare_version_number
Compares a canonified version array to this version. Returns -1, 0, or -1 when this version is less than, equal, or greater than the supplied version, respectively.
Method compare_version_specification
Compares a canonified version dependency specification to this version. Returns -1, 0, or -1 when this version is less than, within, or greater than the specified range, respectively.
Method compare_version_strings
Comparison function for sorting version strings
Class Constant CONFIG_VERSION
Method connection
Return the database connection
Method construct_list
Build the list of packages from our remotes
Method construct_list
Build the list of packages from our Project
Method copy
Copy a file into the project. Creates any needed directories. If a
Page command_autoloader.php
command_autoloader.php in command_autoloader.php
Page ClassUtils.php
ClassUtils.php in ClassUtils.php
Page Command.php
Command.php in Command.php
Page ConfigFile.php
ConfigFile.php in ConfigFile.php
Page ConfigFileError.php
ConfigFileError.php in ConfigFileError.php
Page ChangePlanner.php
ChangePlanner.php in ChangePlanner.php
Page ConfigFileWriter.php
ConfigFileWriter.php in ConfigFileWriter.php
Class Constant CORE_COMMAND_GLOB
Method count
Return the count of versions of this package
Method create
Utility for creating a new Wrapper from a package version
Method create_lock_file
Called internally to create the lock file
Class CriticalI_ChangeManager_HasDependentError
Indicates a proposed change cannot be made due to unfulfilled dependencies.
Class CriticalI_ChangeManager_InvalidUpgradeError
Indicates an attempt to operate on an unknown/uninstalled package
Class CriticalI_ChangeManager_NotInstalledError
Indicates an attempt to operate on an unknown/uninstalled package
Class CriticalI_ChangeManager_Plan
A Plan represents a planned set of Package_Version changes for a repository or project.
Class CriticalI_ChangeManager_Planner
A Planner is used to construct a CriticalI_ChangeManager_Plan for making changes to a repository or project.
Class CriticalI_ChangeManager_PlanRequirement
Used internally to model requirements
Class CriticalI_ChangeManager_RepositoryPlanner
A CriticalI_ChangeManager_Planner specifically for planning changes to
Class CriticalI_ChangeManager_ResolutionError
Indicates a set of packages and correct dependencies could not be resolved from the available set. This is due either to missing packages or conflicts.
Class CriticalI_ClassUtils
CriticalI_ClassUtils in ClassUtils.php
Utilities for working with classes and files containing them
Class CriticalI_Command
CriticalI_Command in Command.php
A CriticalI_Command implements a command that can be used with the command-line criticali utility. This is the base class which all implemented commands must extend.
Class CriticalI_Command_List
CriticalI_Command_List is the collection of installed packages. It is a
Class CriticalI_Command_ProjectEnvironment
CriticalI_Command_ProjectEnvironment in ProjectEnvironment.php
A base class for writing commands that must run within a project's environment (as opposed to just within the repository environment).
Class CriticalI_Command_TableFormatter
CriticalI_Command_TableFormatter in TableFormatter.php
Formats information in an ASCII table for output by command line utilities.
Class CriticalI_Command_TableFormatter_Column
Internal class used by CriticalI_Command_TableFormatter to represent a
Class CriticalI_ConfigFile
CriticalI_ConfigFile in ConfigFile.php
Utilities for working with config files used by criticali.
Class CriticalI_ConfigFileError
CriticalI_ConfigFileError in ConfigFileError.php
Indicates an exception generated by a ConfigFile operation.
Class CriticalI_ConfigFileReadError
Indicates a config file could not be successfully read
Class CriticalI_ConfigFileVersionError
Indicates a config file specified an incorrect version
Class CriticalI_ConfigFileWriteError
Indicates a config file could not be successfully written
Class CriticalI_DBTestCase
CriticalI_DBTestCase in DBTestCase.php
The DBTestCase class exists as a convenience for writing test cases
Class CriticalI_Defaults
CriticalI_Defaults in Defaults.php
A collection of built-in default values which are shared between classes.
Class CriticalI_Globber
CriticalI_Globber in Globber.php
A utility for searching the file system for filenames matching a
Class CriticalI_Hook_Install
CriticalI_Hook_Install in Install.php
Repository install hook for criticali.
Class CriticalI_InstallHook
CriticalI_InstallHook in InstallHook.php
The interface that must be implemented by a repository install hook.
Class CriticalI_InvalidOptionArgumentError
Exception thrown for invalid argument provided
Class CriticalI_MissingOptionArgumentError
Exception thrown for missing argument
Class CriticalI_MissingPackageError
CriticalI_MissingPackageError in MissingPackageError.php
Indicates a required package could not be found
Class CriticalI_MissingPackageVersionError
CriticalI_MissingPackageVersionError in MissingPackageVersionError.php
Indicates a required package version could not be found
Class CriticalI_Option
CriticalI_Option in Options.php
An processed command line option
Class CriticalI_Options
CriticalI_Options in Options.php
Processes command line options.
Class CriticalI_OptionSpec
CriticalI_OptionSpec in OptionSpec.php
Specification for a command line option
Class CriticalI_Package
CriticalI_Package in Package.php
A Package is a collection of one or more installed package versions.
Class CriticalI_Package_Directory
A package directory represents an uninstalled directory for a package.
Class CriticalI_Package_List
CriticalI_Package_List is the collection of installed packages. It is a
Class CriticalI_Package_StatusListener
CriticalI_Package_StatusListener in StatusListener.php
Receives informational messages from a package-related operation on
Class CriticalI_Package_Version
A Version is the most granular form of a package. It represents a single installed version.
Class CriticalI_Package_VersionSpec
Internally used to represent a parsed version dependency specification
Class CriticalI_Package_Wrapper
A Wrapper contains an archived package version.
Class CriticalI_Package_ZipError
Indicates a zip file related error
Class CriticalI_Project
CriticalI_Project in Project.php
Represents a project directory set up for managing with criticali.
Class CriticalI_Project_ChangePlanner
CriticalI_Project_ChangePlanner in ChangePlanner.php
A CriticalI_ChangeManager_Planner specifically for planning changes to
Class CriticalI_Project_ConfigFileWriter
CriticalI_Project_ConfigFileWriter in ConfigFileWriter.php
Handles writing new default values to a config.php file
Class CriticalI_Project_InstallHook
The interface that must be implemented by a project install hook.
Class CriticalI_Project_InstallOperation
CriticalI_Project_InstallOperation in InstallOperation.php
Utilities for tracking and performing install operations for a given package in a project.
Class CriticalI_Project_Manager
Class CriticalI_Project_NotInstalledError
CriticalI_Project_NotInstalledError in NotInstalledError.php
Thrown if a removal fails due to the package not being installed.
Class CriticalI_Project_Package
CriticalI_Project_Package is a CriticalI_Package that has been installed within a project.
Class CriticalI_Project_PackageList
CriticalI_Project_PackageList is the collection of installed packages
Class CriticalI_Project_PackageVersion
CriticalI_Project_PackageVersion in PackageVersion.php
CriticalI_Project_PackageVersion is a CriticalI_Package_Version that has been installed within a project.
Class CriticalI_Project_StatusListener
CriticalI_Project_StatusListener in StatusListener.php
Receives informational messages from a project operation
Class CriticalI_Project_UninstallHook
CriticalI_Project_UninstallHook in UninstallHook.php
The interface that must be implemented by a project uninstall hook.
Class CriticalI_Property
CriticalI_Property in Property.php
CriticalI_Property is a class for working with user-level properties defined within the repository.
Class CriticalI_Remote_Package
CriticalI_Remote_Package is a collection of CriticalI_Package versions available from one or more remote repository.
Class CriticalI_Remote_PackageList
CriticalI_Remote_PackageList in PackageList.php
CriticalI_Remote_PackageList is the collection of available packages
Class CriticalI_Remote_PackageVersion
CriticalI_Remote_PackageVersion in PackageVersion.php
CriticalI_Remote_PackageVersion is a CriticalI_Package_Version that is available from one or more remote repositories.
Class CriticalI_Remote_Repository
CriticalI_Remote_Repository in Repository.php
CriticalI_Remote_Repository is used to interact with a remote collection of packages available for installation.
Class CriticalI_RepositoryLock
CriticalI_RepositoryLock in RepositoryLock.php
Interface for acquiring locks for accessing or modifying the repository.
Class CriticalI_TestCase
CriticalI_TestCase in TestCase.php
This class exists as a convenience for writing PHPUnit tests for the
Class CriticalI_UninstallHook
CriticalI_UninstallHook in UninstallHook.php
The interface that must be implemented by a repository uninstall hook.
Class CriticalI_UnknownOptionError
Exception thrown for unknown/unsupported options
Class CriticalI_UnknownPackageError
CriticalI_UnknownPackageError in UnknownPackageError.php
Indicates an attempt to operate on an unknown/uninstalled package
Class CriticalI_UnknownPackageVersionError
CriticalI_UnknownPackageVersionError in UnknownPackageVersionError.php
Indicates an attempt to operate on an unknown/uninstalled package
Class CriticalI_UsageError
CriticalI_UsageError in UsageError.php
General usage exceptions
Class CriticalI_Util
CriticalI_Util in Util.php
A generic collection of utilities used by multiple classes.
d
top
Variable $data
Variable $defaultRemotes
Variable $dependencies
Variable $description
Variable $description
Variable $directory
Variable $directory
Variable $directory
Page DBTestCase.php
DBTestCase.php in DBTestCase.php
Page Defaults.php
Defaults.php in Defaults.php
Page Directory.php
Directory.php in Directory.php
Method debug
Debug-level message
Method debug
Debug-level message
Method debug_status
Send a debug-level status message
Method default_remotes
Return the default list of remote repositories
Method delete_all_and_remove_directory
Equivalent to performing "rm -rf" on a directory
Method delete_properties
Remove a collection of properties from the repository
Method dependency_string
Return the dependency string for installation
Method directory
Return the directory being examined
Method directory
Returns the project's directory
Method directory_entry_count
Count the number of entries in a directory (not counting self and parent)
Method directory_entry_count
Count the number of entries in a directory (not counting self and parent)
e
top
Variable $end
Variable $entry
Variable $errors
Variable $exact
Method ensure_config_file_exists
Create a config file on the fly if default properties are requested
Method eval_requirements
Evaluate the requirements of a plan by adding packages to meet the requirements.
Method eval_upgrade
Evaluate an upgrade request for a set of packages.
Method execute
Execute the command
Method exists
Test for the existence of a property
Method expand_raw_value
Handles {...} expansion in values
f
top
Variable $fileHandle
Variable $filename
Variable $filesAdded
Variable $fixtures
Variable $fixturesCached
Method fetch_package
Fetches the named package version from the remote and stores it at the provided location.
Method fetch_to
Fetches this package version from one of our available remotes.
Method file_list
Return the set of files added during the installation
Method file_name
Convert a class name into the path and file that should contain it
Method find_matching_versions
Searches the list of packages to assemble a collection of Versions from an array of specs.
Method find_option_spec
Located the option spec for a named option
Method fixture
Return the data for a named fixture
Method format
Format a cell and return the results as an array of lines
Method format_row
Format an individual row of data for output
g
top
Variable $globalOptions
Page Globber.php
Globber.php in Globber.php
Method get
Returns the shared list instance
Method get
Returns the shared list instance
Method get
Get the value of a property
Method getArchiveName
Return the name of the archive where the error occurred
Method getEntryName
Return the name of the entry that caused the error
Method getIterator
Return an iterator for the package list
Method getIterator
Return an iterator for the options list
Method getIterator
Return an iterator for the package list
Method getIterator
Return an iterator for the command list
Method getIterator
Return an iterator for the versions list
Method getIterator
Return an iterator for the package list
h
top
Variable $hash
Variable $header
Page HasDependentError.php
HasDependentError.php in HasDependentError.php
Method has_commands
Test this directory to see if it has installed commands
Method help_string
Returns a usage/help statement for the command
i
top
Variable $index
Variable $installedList
Page InvalidUpgradeError.php
InvalidUpgradeError.php in InvalidUpgradeError.php
Page Install.php
Install.php in Install.php
Page InstallHook.php
InstallHook.php in InstallHook.php
Page InstallHook.php
InstallHook.php in InstallHook.php
Page InstallOperation.php
InstallOperation.php in InstallOperation.php
Method index
Returns the index of packages available from the remote
Method index_of_package
Search an array for a matching package (any version)
Method index_of_requirement
Search the requirements array for a matching package and version
Method index_of_version
Returns the numeric index of a given version number, or false if it does not exist.
Method index_of_version
Search an array for a matching package version number
Method index_of_version_specification
Search an array for a matching package version specification
Method info
Normal informational message
Method info
Normal informational message
Method info_status
Send an informational status message
Method init
Initialize a project
Method init_environment
Set up the environment to pull in the project settings. Generally you will want to call this at the beginning of your run_command method. The parameter it accepts is the package directory. If no directory is given, the current working directory is assumed.
Class Constant INIT_HOOKS
Method init_schema
Set up the schema, if needed
Class Constant INSIDE_PUBLIC
Method install
Invoked when the package is installed in a project
Method install
Invoked when the package is installed in the repository
Method install
Invoked when the package is installed in the repository
Method installation_directory
Return the installation directory (relative to CRITICALI_ROOT)
Method installed_package_instance
Return the named CriticalI_Package_Version instance from the installed list.
Method install_dependency_list
Add dependencies for a newly installed package to this project's properties
Method install_files
Install the files for a package
Method install_init_files
Add any specified classes to the init_files property for a package
Method install_package_in_list
Add the given package to our list of installed packages
Method install_plan
Create a plan for installing the specified package or packages.
Method install_property_defaults
Set any property defaults for a package
Method install_uninstallers
Add any specified classes to the uninstallers property for a package
Method is_absolute
Test a path to see if it is absolute
Method is_absolute
Test a path to see if it is absolute
Method is_exact_or_newer_version_installed
Determine if a specific package version or newer is already installed.
Method is_exact_version_installed
Determine if a specific package version is already installed.
Method is_installed
Determine if a package by the same name is already installed.
Method is_installed
Test to see if a package is already installed
Method is_next_option
Peeks at the next argument to see if it is an option
Method is_on_add_list
Determine if the given package name is to be added
Method is_on_remove_list
Determine if the given package version is to be removed
l
top
Variable $leftText
Variable $list
Variable $list
Variable $list
Variable $location
Variable $lockState
Page List.php
List.php in List.php
Page List.php
List.php in List.php
Class Constant LIBRARY_INSTALL_FROM
Class Constant LIBRARY_INSTALL_GLOB
Method listing
Return the shared class instance
Method list_missing_dependencies
Return the list of dependencies that are not fulfilled in the system represented by the current installation and the given plan.
Method load
Load the properties from the repository
Method load
Load a project
Method load_config
Load the configuration data from the file
Method load_fixtures
Set up the fixtures
Method load_fixture_files
Does the work of loading data from the fixture files
Method load_properties
Load the properties from the archive
Method location
Return the path or URL to the wrapper
m
top
Variable $major
Variable $minor
Variable $minus
Page MissingPackageError.php
MissingPackageError.php in MissingPackageError.php
Page MissingPackageVersionError.php
MissingPackageVersionError.php in MissingPackageVersionError.php
Page Manager.php
Manager.php in Manager.php
Method make_install_specification
Return the version specification as one suitable for an install requirement
Method mark_upgradable
Add the dependencies of a package to a list of upgradable packages
Method match
Return an array of pathnames matching the provided pattern and origin directory. Returned filenames are complete paths (not relative to the origin). The returned filenames are not sorted.
Method matching_versions
Return the list of suitable package versions for installation matching the given package name and version specification.
Method max_width
Return the maximum width of the cell
Method min_width
Return the minimum possible width of the cell
Method min_word_width
Return the minimum width of the cell that will not involve word
Method mkdir
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.
Method mkdir
Create a directory, if needed, and verify the path is a directory
n
top
Variable $name
Variable $name
Variable $name
Variable $name
Variable $name
Variable $name
CriticalI_OptionSpec::$name in OptionSpec.php
Variable $name
Page NotInstalledError.php
NotInstalledError.php in NotInstalledError.php
Page NotInstalledError.php
NotInstalledError.php in NotInstalledError.php
Method name
Return the name of this wrapper (the combined package name and
Method name
Returns the name of the command
Method name
Return the name of the package
Method name
Return the package name
Method newest
Return the newest version of the package
Class Constant NONE
CriticalI_OptionSpec::NONE in OptionSpec.php
Method normalize_package_args
Normalize $packageName and $version arguments as passed to public methods
o
top
Variable $options
Variable $options
Variable $options
Variable $optionSpec
Variable $optionSpec
Variable $origRaw
Page Options.php
Options.php in Options.php
Page OptionSpec.php
OptionSpec.php in OptionSpec.php
Method offsetExists
Tests for existence of an array index
Method offsetExists
Tests for existence of an array index
Method offsetExists
Tests for existence of an array index
Method offsetExists
Tests for existence of an array index
Method offsetExists
Tests for existence of an array index
Method offsetExists
Tests for existence of an array index
Method offsetGet
Retrieves the package at an array index.
Method offsetGet
Retrieves the value at an array index.
Method offsetGet
Retrieves the package at an array index.
Method offsetGet
Retrieves the value at an array index. A numeric index returns a CriticalI_Option, a non-numeric index returns only the argument for the option.
Method offsetGet
Retrieves the command at an array index.
Method offsetGet
Retrieves the package at an array index.
Method offsetSet
Sets the value at an array index
Method offsetSet
Sets the value at an array index
Method offsetSet
Sets the value at an array index
Method offsetSet
Sets the value at an array index
Method offsetSet
Sets the value at an array index
Method offsetSet
Sets the value at an array index
Method offsetUnset
Deletes an entry at an array index
Method offsetUnset
Deletes an entry at an array index
Method offsetUnset
Deletes an entry at an array index
Method offsetUnset
Deletes an entry at an array index
Method offsetUnset
Deletes an entry at an array index
Method offsetUnset
Deletes an entry at an array index
Method oldest
Return the oldest version of this package
Class Constant OPTIONAL
Method options_hash
Provides internal access to the options hash
Class Constant OUTSIDE_PUBLIC
p
top
Variable $package
Variable $packageInfo
Variable $packageList
Variable $packageName
Variable $packages
Variable $packages
Variable $packages
Variable $packageVersion
Variable $packageVersion
Variable $plus
Variable $project
Variable $project
Variable $project
Variable $properties
Variable $properties
Variable $properties
Variable $properties
Variable $properties
Page Plan.php
Plan.php in Plan.php
Page Planner.php
Planner.php in Planner.php
Page ProjectEnvironment.php
ProjectEnvironment.php in ProjectEnvironment.php
Page Package.php
Package.php in Package.php
Page Package.php
Package.php in Package.php
Page PackageList.php
PackageList.php in PackageList.php
Page PackageVersion.php
PackageVersion.php in PackageVersion.php
Page Project.php
Project.php in Project.php
Page Property.php
Property.php in Property.php
Page Package.php
Package.php in Package.php
Page PackageList.php
PackageList.php in PackageList.php
Page PackageVersion.php
PackageVersion.php in PackageVersion.php
Method package
Return the containing package
Method packages
Return a list of installed packages and their versions. Data is
Method package_list
Return the list of installed packages as a CriticalI_Project_PackageList (which contains CriticalI_Package objects instead of just a hash of strings).
Method package_name
Return the contained package name
Method package_on_add_list
Return the CriticalI_Package_Version instance with the given name from the add list
Method package_version
Return the contained package version number
Method package_version
Return the package being installed
Method parse_option
Parses an option
Method parse_option_optional_arg
Handle an option which may take an optional argument
Method parse_option_prohibited_arg
Handle an option which may not have an argument
Method parse_option_required_arg
Handle an option which requires an argument
Method perform
Perform the set of operations prescribed by a CriticalI_ChangeManager_Plan
Method perform
Perform the set of operations prescribed by a CriticalI_ChangeManager_Plan
Method populate_versions_from_string
Populates the list of versions from a string containing a comma- separated list of installed version numbers.
Method pop_requirement
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.
Method private_directory
Returns the project's private directory.
Method process_arguments
Process the arguments
Method project
Return the project associated with this installation
Class Constant PROJECT_INSTALL_HOOKS
Method project_private_dir
Return the directory that contains the non-public files for the project
Method project_public_dir
Return the directory that contains the public files for the project
Class Constant PROJECT_UNINSTALL_HOOKS
Method prompt
Prompt the user and return the user's response
Method prompt_confirm
Prompt the user with a yes/no question and return the user's response as a boolean
Method property
Return the value of a property for the wrapped package version
Method property
Return the value of a property for this package version
Method property
Return the value of a property for this package version
Method property
Return the value of a property for this project
Method public_directory
Returns the project's public directory.
Method push_requirement
Add a requirement to the list
q
top
Method quote
Quotes a value for output to an ini file
r
top
Variable $rawFile
Variable $rawSuffix
Variable $remotes
Variable $remotes
Variable $remove
Variable $requirements
Variable $revision
Variable $rightText
Variable $rows
Page RepositoryPlanner.php
RepositoryPlanner.php in RepositoryPlanner.php
Page ResolutionError.php
ResolutionError.php in ResolutionError.php
Page Repository.php
Repository.php in Repository.php
Page RepositoryLock.php
RepositoryLock.php in RepositoryLock.php
Method read
Read a config file and return the resulting array of data.
Method read_lock
Acquire a read lock of the repository
Class Constant READ_LOCKED
Method rebuild
Rebuild the installation list file and repopulate the list
Method recursive_list
Recursively list the contents of a directory
Method release
Release any acquired lock
Class Constant REMOTES
Method remove
Remove (uninstall) a package version from the repository
Method remove
Remove a package from the project.
Method remove
Remove (delete) a property. The change is immediately saved to disk.
Method remove_closest
Add the closest matching installed package to the remove list
Method remove_from_version_list
Remove a version from a version list string and maintain sort order
Method remove_init_file
Remove a file from the list in the init_files property.
Method remove_list
Return the list of packages to remove
Method remove_multiple
Remove (delete) a set of properties. The changes are immediately saved to disk.
Method remove_package
Add a package to the remove list
Method remove_plan
Create a plan for removing the specified package or packages.
Method remove_version_from_packages_file
Update the installation list file by removing a single deleted package directory
Class Constant REPOSITORY_INSTALL_HOOKS
Class Constant REPOSITORY_UNINSTALL_HOOKS
Class Constant REQUIRED
Method requirements_list
Return the list of requirements
Method requirement_count
Return the count of requirements in this plan's list
Method revert_file
Writes back the original file content (as it was loaded when this class was created).
Method runBare
Override the run method to allow additional prep
Method run_command
Internal implementation of the command. This must be implemented by all sub classes. The properties globalOptions, options, and args will have been populated when this method is called.
Method run_installers_for
Run any specified installers for a package
Method run_installers_for
Run any specified installers for a package
Method run_uninstallers_for
Run any specified uninstallers for a package
Method run_uninstallers_for
Run any registered uninstallers for a package
s
top
Variable $schemaLoaded
Variable $scriptName
Variable $skipWrite
Variable $sourceList
Variable $start
Variable $statusListener
Variable $statusListener
Variable $summary
Page StatusListener.php
StatusListener.php in StatusListener.php
Page StatusListener.php
StatusListener.php in StatusListener.php
Method satisfies_requirement
Determine if the installed set of packages satisfy the requirement for the named package and version.
Method satisfies_requirement
Determine if this plan already provides the given package and version specification
Method satisfy_dependency
Return the version that satisfies the dependency required by the given version dependency string or null if not found.
Method save
Write a property to the repository
Method script_name
Return the script name
Method set
Set the value of a property. The property is immediately saved to disk.
Method set_config_value
Set a configuration value in the project. This will override any existing value.
Method set_default
If no corresponding key in the configuration is set, defines a new value for it.
Method set_default_config_value
Set a default configuration value in the project. If no corresponding key in the configuration is set, defines a new value for it.
Method set_header
Set the header for the table
Method set_multiple
Set the value of a several properties at once.
Method set_status_listener
Set the status listener
Method set_status_listener
Set the status listener
Method set_value
Set the key to a new value, irrespective of any existing values.
Method slash
Adds slashes needed to enclose a value safely in double quotes in PHP.
Method status_listener
Return the status listener
Method summary
Returns the summary of the command
Method system_upgrade
Upgrade the criticali system to a new wrapped package
t
top
Variable $testDir
Variable $type
Page TableFormatter.php
TableFormatter.php in TableFormatter.php
Page TestCase.php
TestCase.php in TestCase.php
Method tempfile
Create a temporary file and return its name. The file is automatically cleaned up at the end of the script.
Method to_string
Format the table and return it as a string
Method try_add
Clone a package and attempt to add a package to it
Method type
Returns the project's type
u
top
Variable $upgradable
Variable $url
Page UninstallHook.php
UninstallHook.php in UninstallHook.php
Page UninstallHook.php
UninstallHook.php in UninstallHook.php
Page UnknownPackageError.php
UnknownPackageError.php in UnknownPackageError.php
Page UnknownPackageVersionError.php
UnknownPackageVersionError.php in UnknownPackageVersionError.php
Page UsageError.php
UsageError.php in UsageError.php
Page Util.php
Util.php in Util.php
Method uninstall
Invoked when the package is uninstalled from the repository
Method uninstall
Invoked when the package is uninstalled from a project
Method uninstall_dependency_list
Remove dependencies for a package from this project's properties
Method uninstall_files
Remove all of the files in a listing. Any directories in the listing are removed if they are empty after first removing all other files in the list.
Method uninstall_init_script_listings
Remove any listings in the init_files property for the removed files listed in $manifest
Method uninstall_package_in_list
Remove the given package from our list of installed packages
Class Constant UNLOCKED
Method unwrap
Extract a wrapped package to the given directory
Method update_system_in_packages_file
Update the criticali system version listed in the package directory
Method upgrade_plan
Create a plan for upgrading the specified package or packages.
Method usage_text
Helper function to produce partial usage text from a list of CriticalI_OptionSpec objects.
v
top
Variable $version
Variable $version
Variable $versions
Page Version.php
Version.php in Version.php
Method validateKeys
Validates that the key values in a set of properties are valid
Method version
Return the package version
Method version
Return the version number as an array with three elements (major, minor, and revision numbers).
Method versions_string
Returns a comma-separated list of version strings for the versions this package contains.
Method version_string
Return the version number as a string.
w
top
Variable $widestCell
Variable $widestWord
Variable $width
Variable $wrapper
Page Wrapper.php
Wrapper.php in Wrapper.php
Method will_conflict
Determine if the given package will conflict with planned packages to install
Method will_conflict
Determine if a conflicting package is already installed (or, optionally, will be installed).
Method working_directory
Return the path to the test directory.
Method wrap
Called internally to assemble a new wrapper
Method wrapper
Return this package's wrapper. This will fetch the remote package to a temporary file and return the wrapper object for it.
Method wrap_version_files
Insert files from a package version into a new wrapper
Method write
Write configuration data to a file.
Method write_file
Writes any changes made out to the file
Method write_htaccess
Writes a default .htaccess file. Will not clobber an existing file.
Method write_lock
Acquire a write lock of the repository
Class Constant WRITE_LOCKED
Method write_properties
Write the properties file out
z
top
Page ZipError.php
ZipError.php in ZipError.php
Method zip_status
Return a status message from a zip object (if possible)
a b c d e f g h i l m n o p q r s t u v w z _