better documentation of checkExtensionByName()

This commit is contained in:
Uwe Steinmann 2025-11-15 11:27:06 +01:00
parent 4be5afcef8
commit 3efcf064f2

View File

@ -410,14 +410,19 @@ $EXT_CONF = '.var_export($EXT_CONF, true).';');
} /* }}} */
/**
* Check content of extension directory or configuration of extension
* Check configuration of extension
*
* @param string|array $dir full path to extension directory or extension name
* or an array containing the configuration.
* @param array $options array with options elements 'noconstraints' and 'nofiles'.
* Set 'noconstraints' to true if
* constraints to local seeddms installation shall not be checked. Set 'nofiles'
* to true to turn off checking of files
* This method checks if the configurations of an extension is complete
* and all dependencies specified in the configuration are met.
*
* @param string $extname not used anymore. Was previously use to store
* result of the check into $this->configcache, but this method can be
* used for installed extensions and those in the repository, which makes
* the use of a cache useless.
* @param array $extconf extension configuration to be checked
* @param array $options array with option element 'noconstraints'.
* Set 'noconstraints' to true if constraints to local seeddms
* installation shall not be checked.
* @return boolean true if check was successful, otherwise false
*/
public function checkExtensionByName($extname, $extconf, $options=array()) { /* {{{ */