|
|
| (13 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_Configurator''.
| | #REDIRECT [[Class: I2CE_Configurator (4.1.12)]] |
| *Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
| |
| *Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L40 lib/I2CE_Configurator.php] on line 40
| |
| ==Variables==
| |
| ===$mod_path===
| |
| Hack to store the paths to each config
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L53 i2ce/lib/I2CE_Configurator.php] on line 53
| |
| *Type: private [http://www.php.net/manual/en/language.types.array.php array ] $mod_path
| |
| | |
| ===$top_module===
| |
| An associative array linking directory to top-level module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L59 i2ce/lib/I2CE_Configurator.php] on line 59
| |
| *Type: private [http://www.php.net/manual/en/language.types.array.php array ] $top_module
| |
| | |
| ===$checked_paths===
| |
| A list of the paths checked
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L65 i2ce/lib/I2CE_Configurator.php] on line 65
| |
| *Type: private [http://www.php.net/manual/en/language.types.array.php array ] $checked_paths
| |
| | |
| ===$found_modules===
| |
| Holds a list of found modules @var private array $found_module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L71 i2ce/lib/I2CE_Configurator.php] on line 71
| |
| *Type: private $found_modules
| |
| | |
| ===$errors===
| |
| Errors encountered
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L76 i2ce/lib/I2CE_Configurator.php] on line 76
| |
| *Type: private [http://www.php.net/manual/en/language.types.string.php string ] $errors
| |
| | |
| ===$file_list===
| |
| list of files for each module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L81 i2ce/lib/I2CE_Configurator.php] on line 81
| |
| *Type: private [http://www.php.net/manual/en/language.types.array.php array ] $file_list
| |
| | |
| ===$storage===
| |
| Where we are saving all configuration data
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L87 i2ce/lib/I2CE_Configurator.php] on line 87
| |
| *Type: protected [[Class: I2CE_MagicData | I2CE_MagicData]] $storage
| |
| | |
| ===$template===
| |
| the current template we are working with ;
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L93 i2ce/lib/I2CE_Configurator.php] on line 93
| |
| *Type: protected [[Class: I2CE_MagicDataTemplate | I2CE_MagicDataTemplate]] $template
| |
| | |
| ===$merges===
| |
| $var protected array $merges. Keys are magic data paths, values are merge type
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L99 i2ce/lib/I2CE_Configurator.php] on line 99
| |
| *Type: protected $merges
| |
| | |
| ===$locales===
| |
| The locales for which we check for config files.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L104 i2ce/lib/I2CE_Configurator.php] on line 104
| |
| *Type: protected $locales
| |
| | |
| ===$hash===
| |
| . The hash of the last config file processed. It is a string, the hash, if the last config file loaded successully. false if the last config file did not load succesully. null if there was never a config file processed.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L113 i2ce/lib/I2CE_Configurator.php] on line 113
| |
| *Type: protected [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $hash
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| Constructor
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L124 i2ce/lib/I2CE_Configurator.php] on line 124
| |
| *Signature: public function __construct($storage,$set_last_access)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicData | I2CE_MagicData]] $storage <br/>if none is passed in, then a simple MagicData and config storage object using MagicDataStorageMem will be set up.
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $set_last_access
| |
| ***Default Value: true
| |
| ===__destruct()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L142 i2ce/lib/I2CE_Configurator.php] on line 142
| |
| *Signature: public function __destruct()
| |
| ===checkForConflicts()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L960 i2ce/lib/I2CE_Configurator.php] on line 960
| |
| *Signature: protected function checkForConflicts($requirements,$enabled_modules)
| |
| *Parameters:
| |
| **$requirements
| |
| **$enabled_modules
| |
| ===checkRequirements()===
| |
| Checks the requirements. if all requirements are met and there are no conflicts, it returns a list of those that need to be installed, an empty array() if none are needed. On failure returns null. @param array $shortnames an array of shortnames @param array $remove an array of potential shortnames to remove -- if we did not find them somplace else. (it may have just been moved) defaults to an empty array.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L743 i2ce/lib/I2CE_Configurator.php] on line 743
| |
| *Signature: public function checkRequirements($updates,$disables,$removals,$enabled_modules,$required_modules)
| |
| *Parameters:
| |
| **$updates
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $disables <br/>a shortname or an array of shortnames of modules to disable. Defaults to empty array
| |
| ***Default Value: array()
| |
| **$removals
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $enabled_modules <br/>An array of shortnames of enabled modules -- we check for conflicts against this array
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $required_modules <br/>A shortname or an array of shortnames of required modules -- if a module is set to be updated and it is not required by on of the modules in this array, it will be set as an optional modules. Defaults to the empty array
| |
| ***Default Value: array()
| |
| *Returns: array.<br/>Keys are: 'failure' - string with the reason for failture 'requirements' - array which has as keys shortnames and values files for the requirements. 'removals' - array of shortnames that need to be removed. 'optional' - array with key shortnames and value true 'moved' - array with key shortnames and value true
| |
| ===extRequirements()===
| |
| Get a list of External dependencies for the module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1356 i2ce/lib/I2CE_Configurator.php] on line 1356
| |
| *Signature: public function extRequirements($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>Module to check.
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>List of requirement objects
| |
| ===findAvailableConfigs()===
| |
| Searches the system for available configuration files (if not done already) and stores them in the given I2CE_MagicData @param I2CE_FileSearch A file search to use for modules. If null(default) uses I2CE::getFileSearch()
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L610 i2ce/lib/I2CE_Configurator.php] on line 610
| |
| *Signature: public function findAvailableConfigs($file_search,$deep,$extensions,$limit_to_subdir,$verbose_errors)
| |
| *Parameters:
| |
| **$file_search
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $deep <br/>Defaults to false. If false, only checks the module paths of the currently enabled modules. If true, checks the module paths of all modules which are either enabled or disabled.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $extensions <br/>An array containing file extensions which we wish to test if they are a config file. Defaults to the empty array in which case we look for files with the 'xml' extension and any additional extensions registered under I2CE::getConfig()->config->additional_configuration_extensions
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $limit_to_subdir <br/>If $file_search is given and this is set, we only add in the directories which are subdirectorues of $limit_to_subdir (check is by string comparision)
| |
| ***Default Value: ''
| |
| **$verbose_errors
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string the list of shortnames found
| |
| ===findPotentialConfigs()===
| |
| Return a list of potential configuration files. "Potential config files" are those whose extension matches the regular expression. @param array @returns
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L572 i2ce/lib/I2CE_Configurator.php] on line 572
| |
| *Signature: private function findPotentialConfigs($extensions,$file_search)
| |
| *Parameters:
| |
| **$extensions
| |
| **$file_search
| |
| ===flattenRequirements()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L680 i2ce/lib/I2CE_Configurator.php] on line 680
| |
| *Signature: protected function flattenRequirements($requirementDOM)
| |
| *Parameters:
| |
| **$requirementDOM
| |
| ===getAvailableModules()===
| |
| Scan a directory for available modules.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1718 i2ce/lib/I2CE_Configurator.php] on line 1718
| |
| *Signature: public function getAvailableModules($search_dirs,$limit_search,$rescan,$verbose)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $search_dirs <br/>List of Directories to search
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $limit_search <br/>Don't scan by depth (true)
| |
| ***Default Value: true
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $rescan <br/>Whether to force a rescan (false)
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $verbose <br/>Verbose errors (false)
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>List of modules found
| |
| ===getConflicts()===
| |
| For a given module, find a list of conflicting modules.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1415 i2ce/lib/I2CE_Configurator.php] on line 1415
| |
| *Signature: private function getConflicts($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>Module to check
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>List of conflicts
| |
| ===getDefaultExtensions()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L543 i2ce/lib/I2CE_Configurator.php] on line 543
| |
| *Signature: private function getDefaultExtensions()
| |
| ===getDependencyList()===
| |
| Gets information about the dependecies for a module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1229 i2ce/lib/I2CE_Configurator.php] on line 1229
| |
| *Signature: public function getDependencyList($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>indexed by 'requirements', 'conflicts' 'enable', 'path', and 'badness' where 'badness' is an array of strings of error messages and the other are arrays of shortnames
| |
| ===getDependsList()===
| |
| Gets the list of modules depending on the specified module.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1191 i2ce/lib/I2CE_Configurator.php] on line 1191
| |
| *Signature: public function getDependsList($shortname)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $shortname <br/>The shortname of a module
| |
| ===getDescription()===
| |
| Returns a brief one-line description of the module.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1537 i2ce/lib/I2CE_Configurator.php] on line 1537
| |
| *Signature: public function getDescription($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>name
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getEnabled()===
| |
| Get enabled sub-modules
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1324 i2ce/lib/I2CE_Configurator.php] on line 1324
| |
| *Signature: private function getEnabled($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>Module to check.
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>List of enabled submodules
| |
| ===getHash()===
| |
| Get the hash of the contents of the last processConfifFile.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L191 i2ce/lib/I2CE_Configurator.php] on line 191
| |
| *Signature: public function getHash()
| |
| *Returns: mixed.<br/>String, the hash, if the last config file loaded successfully. false if the last config file did not load succesully. null if there was never a config file processed.
| |
| ===getI2CERoot()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1294 i2ce/lib/I2CE_Configurator.php] on line 1294
| |
| *Signature: public function getI2CERoot()
| |
| ===getLongDescription()===
| |
| Returns a longer description of the module.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1546 i2ce/lib/I2CE_Configurator.php] on line 1546
| |
| *Signature: public function getLongDescription($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>name
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getMaxChildOrder()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1172 i2ce/lib/I2CE_Configurator.php] on line 1172
| |
| *Signature: protected function getMaxChildOrder($node,$xpath)
| |
| *Parameters:
| |
| **$node
| |
| **$xpath
| |
| ===getMerges()===
| |
| Get the magic data paths whose status we are tracking. $retrurns array. Keys are magic data paths, values are the merge type
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L517 i2ce/lib/I2CE_Configurator.php] on line 517
| |
| *Signature: public function getMerges()
| |
| ===getModuleDir()===
| |
| Return the directory of the module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1305 i2ce/lib/I2CE_Configurator.php] on line 1305
| |
| *Signature: public function getModuleDir($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>Module to check.
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>Path to config file.
| |
| ===getModuleFileList()===
| |
| Get a list of files for a given module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1694 i2ce/lib/I2CE_Configurator.php] on line 1694
| |
| *Signature: public function getModuleFileList($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>The module name
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>List of files in the module. Paths are relative to the directory where the module's configuration file is.
| |
| ===getModuleFileMap()===
| |
| Get a list of each files under each path.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1623 i2ce/lib/I2CE_Configurator.php] on line 1623
| |
| *Signature: public function getModuleFileMap($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>The module name
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>List of file maps in the module. Paths are relative to the directory where the module's configuration file is. @todo Contains a hack for the special case where CLASSES directory is ./
| |
| ===getModulePath()===
| |
| Return the path to the module configuration file
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1286 i2ce/lib/I2CE_Configurator.php] on line 1286
| |
| *Signature: public function getModulePath($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>Module to check.
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>Path to config file.
| |
| ===getModulePathList()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1605 i2ce/lib/I2CE_Configurator.php] on line 1605
| |
| *Signature: public function getModulePathList($module)
| |
| *Parameters:
| |
| **$module
| |
| ===getNextUnchecked()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1004 i2ce/lib/I2CE_Configurator.php] on line 1004
| |
| *Signature: protected function getNextUnchecked($requirementDOM)
| |
| *Parameters:
| |
| **$requirementDOM
| |
| ===getPackageAuthors()===
| |
| Returns a longer description of the module.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1564 i2ce/lib/I2CE_Configurator.php] on line 1564
| |
| *Signature: public function getPackageAuthors($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>name
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getRequirements()===
| |
| Get a list of requirements for the module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1372 i2ce/lib/I2CE_Configurator.php] on line 1372
| |
| *Signature: private function getRequirements($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>Module to check.
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>List of required modules.
| |
| ===getRoot()===
| |
| Get the root of where this I2CE instance started.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1259 i2ce/lib/I2CE_Configurator.php] on line 1259
| |
| *Signature: public function getRoot()
| |
| *Returns: the<br/>fully resolved path to the starting directory
| |
| ===getStorage()===
| |
| Get the magic data node storage for the configurator
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L46 i2ce/lib/I2CE_Configurator.php] on line 46
| |
| *Signature: public function getStorage()
| |
| *Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]]
| |
| ===getTopModule()===
| |
| Find the top-level module in a directory. (e.g. I2CE, ihris-common, ihris-manage)
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1586 i2ce/lib/I2CE_Configurator.php] on line 1586
| |
| *Signature: public function getTopModule($d,$verbose)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $d <br/>Directory to check
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $verbose @return
| |
| ***Default Value: false
| |
| ===getVersion()===
| |
| Return the version for a given module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1525 i2ce/lib/I2CE_Configurator.php] on line 1525
| |
| *Signature: public function getVersion($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>name
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===importLocalizedTemplates()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L351 i2ce/lib/I2CE_Configurator.php] on line 351
| |
| *Signature: public function importLocalizedTemplates($localized)
| |
| *Parameters:
| |
| **$localized
| |
| ***Default Value: array()
| |
| ===isReq()===
| |
| Determine if this object is a I2CE_MagicDataNode that can be used as a requirement. @param mixed $string
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1214 i2ce/lib/I2CE_Configurator.php] on line 1214
| |
| *Signature: private function isReq($req)
| |
| *Parameters:
| |
| **$req
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===loadConfigFile()===
| |
| Load a config file with various extensions.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L170 i2ce/lib/I2CE_Configurator.php] on line 170
| |
| *Signature: protected function loadConfigFile($file,$verbose_errors)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $file <br/>Path to the config file
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $verbose_errors <br/>(true)
| |
| ***Default Value: true
| |
| *Returns: booolean<br/>true on success
| |
| ===moduleConflicts()===
| |
| Checks to see if a module conflicts with by another module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1514 i2ce/lib/I2CE_Configurator.php] on line 1514
| |
| *Signature: public function moduleConflicts($module,$version,$conflicts,$deep)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>Module to check
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $version <br/>Version of the module
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $conflicts <br/>Module name or an array of module names
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $deep <br/>Whether to recursively check the requirements (true)
| |
| ***Default Value: true
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===moduleRequires()===
| |
| Checks to see if a module is required by another module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1453 i2ce/lib/I2CE_Configurator.php] on line 1453
| |
| *Signature: public function moduleRequires($module,$version,$requirements,$deep,$cat)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $version
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $requirements <br/>a module name or an array of module names
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $deep <br/>Defaults to true meaning we should check requirements of requiremnets of requirements of ...
| |
| ***Default Value: true
| |
| **$cat
| |
| ***Default Value: 'requirement'
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===processConfig()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L436 i2ce/lib/I2CE_Configurator.php] on line 436
| |
| *Signature: public function processConfig($process_configuration,$verbose_errors,$process_meta,$localized)
| |
| *Parameters:
| |
| **$process_configuration
| |
| ***Default Value: false
| |
| **$verbose_errors
| |
| ***Default Value: true
| |
| **$process_meta
| |
| ***Default Value: true
| |
| **$localized
| |
| ***Default Value: array()
| |
| ===processConfigFile()===
| |
| Loads in a config file and validates it against its referenced DTD. Sets the access time and the shortname (provided in the metadata) for the file. If there is already a config file with the same shortname, it will remove that fro the list of the config files. Save all the configuration metadata under $storage->$shortname where $shortname is the shortname provided for by the config file.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L224 i2ce/lib/I2CE_Configurator.php] on line 224
| |
| *Signature: public function processConfigFile($file,$process_configuration,$verbose_errors,$process_meta,$localized)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $file <br/>The full path to the config file. If this is less than the time the file was last accessed, it does not load the file/set the access time.
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $process_configuration <br/>Boolean -- true if you want to save the configuration data into (defaults to false). If true process all config data. If it is a string, then we assume that it is a version number, in which case we process all configuration data that is versioned after the specified version
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $verbose_errors <br/>defaults to true.
| |
| ***Default Value: true
| |
| **$process_meta
| |
| ***Default Value: true
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $localized <br/>Data on localized versions of the file already loaded.
| |
| ***Default Value: array()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>the shortname provided for by this config file or null on failure.
| |
| ===processRequirementsDOM()===
| |
| @param boolean $options. Defaults to false. Set to true if the new requests are optional i.e. don't cause a fatal error/add to the DOM if there a conflict
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1046 i2ce/lib/I2CE_Configurator.php] on line 1046
| |
| *Signature: public function processRequirementsDOM($new_requests,$requests,$optional)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $new_requests <br/>a shortname or an array of shortnames of module we wish to be loaded.
| |
| ** [http://www.php.net/manual/en/class.domdocument.php DOMDocument ] $requests <br/>The existing requests. Each node should have an order attribute. Optionally hey may have the attribute 'checked' meaning that we consider this node to be checked.
| |
| **$optional
| |
| ***Default Value: false
| |
| *Returns: an<br/>array of the new modules that were installed on sucess. A string on failure describing the failure reason.
| |
| ===recursiveScan()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L634 i2ce/lib/I2CE_Configurator.php] on line 634
| |
| *Signature: private function recursiveScan($shortnames,$extensions,$limit_to_subdir,$verbose)
| |
| *Parameters:
| |
| **&$shortnames
| |
| **$extensions
| |
| **$limit_to_subdir
| |
| **$verbose
| |
| ===requirements()===
| |
| Get a list of requirement objects for the module
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1340 i2ce/lib/I2CE_Configurator.php] on line 1340
| |
| *Signature: public function requirements($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>Module to check.
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>List of requirement objects
| |
| ===resetCheckedPaths()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L706 i2ce/lib/I2CE_Configurator.php] on line 706
| |
| *Signature: public function resetCheckedPaths()
| |
| ===resetMerges()===
| |
| Reset the tracked data.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L523 i2ce/lib/I2CE_Configurator.php] on line 523
| |
| *Signature: public function resetMerges()
| |
| ===setLocales()===
| |
| Set the locales used when handingling the processing of config data.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L152 i2ce/lib/I2CE_Configurator.php] on line 152
| |
| *Signature: public function setLocales($locales)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $locales <br/>Either a string ( a locale) or an array of strings
| |
| ===setModulePath()===
| |
| Set the module's path, usually used for testing.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1269 i2ce/lib/I2CE_Configurator.php] on line 1269
| |
| *Signature: public function setModulePath($module,$path)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $path
| |
| ===setRoot()===
| |
| Set the root of where this I2CE instance started.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1246 i2ce/lib/I2CE_Configurator.php] on line 1246
| |
| *Signature: public function setRoot($dir)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $dir <br/>Directory (defaults to getcwd()) where this instance of Configurator was created.
| |
| ***Default Value: null
| |
| *Returns: the<br/>fully resolved path to $dir
| |
| ===setTopModule()===
| |
| Set the top level module for a directory.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L1572 i2ce/lib/I2CE_Configurator.php] on line 1572
| |
| *Signature: public function setTopModule($dir,$module)
| |
| *Parameters:
| |
| **$dir
| |
| **$module
| |
| ===setupFileSearch()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L527 i2ce/lib/I2CE_Configurator.php] on line 527
| |
| *Signature: private function setupFileSearch($mod,$path)
| |
| *Parameters:
| |
| **$mod
| |
| ***Default Value: null
| |
| **$path
| |
| ***Default Value: "MODULES"
| |
| ===shallowScan()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Configurator.php#L656 i2ce/lib/I2CE_Configurator.php] on line 656
| |
| *Signature: private function shallowScan($potential_configs,$verbose)
| |
| *Parameters:
| |
| **$potential_configs
| |
| **$verbose
| |
| ***Default Value: false
| |
| ==Inherited Methods==
| |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| ==Fuzzy Methods==
| |
| ===loadConfigFile_YAML()===
| |
| This method is implemented by [[Class: I2CE_Module_YAML#loadConfigFile_YAML() | I2CE_Module_YAML->loadConfigFile_YAML() ]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
