1.7.5.1
|
eZ Publish
[4.0]
|
A set of functions to do web-site installation from command-line. More...
A set of functions to do web-site installation from command-line.
Helps simplify installation process by providing a set of steps which will be executed sequentially. This class contains a common functions which can be reused in particular installtions.
Definition at line 47 of file ezsiteinstaller.php.
| eZSiteInstaller::addClassAttributes | ( | $ | params | ) |
Add attribute to the content class Params: array( 'class' => array( 'identifier' => optional, string: identifire of content class; see 'id'; 'id' => optional, ID of content class. if set it's used instead of 'class_identifier' to speed up things. you must supply either 'class_identifier' or 'class_id'; ), 'attributes' => array( array( 'identifier' => attibute identifier, 'name' => attribute name, 'data_type_string' => attribute datatype, 'default_value' => optional, attribute default value, default is 'false' 'can_translate' => optional, default '1' 'is_required' => optional, default '0' 'is_searchable' => optional, default '0' 'content' => optional, attribute content ), ... );
Definition at line 427 of file ezsiteinstaller.php.
| eZSiteInstaller::addPoliciesForRole | ( | $ | params | ) |
Add policies from role Params: role_name - name of role; policies - array of policies to remove. Each item is an array of policy definition: array( 'module' => 'function' => ['limitation'] => ); create_role - boolean, optional. If TRUE - will create new role if it doesn't exist. Default is TRUE.
Definition at line 1215 of file ezsiteinstaller.php.
| eZSiteInstaller::addSetting | ( | $ | name, |
| $ | value | ||
| ) |
Add setting with $name and $value.
Definition at line 118 of file ezsiteinstaller.php.
| eZSiteInstaller::assignUserToRole | ( | $ | params | ) |
Assign user to role. Params: location - path to user node where user object is located; role_name - name of role to assign;
Definition at line 1188 of file ezsiteinstaller.php.
| eZSiteInstaller::buildFunctionParams | ( | &$ | params | ) |
Prepare parameters for function executed in step definition.
Definition at line 214 of file ezsiteinstaller.php.
Referenced by execFunction().
| eZSiteInstaller::classByIdentifier | ( | $ | params | ) |
Return content class. Params: 'identifier' - identifier of the class.
Definition at line 335 of file ezsiteinstaller.php.
Referenced by addClassAttributes(), and classIDbyIdentifier().
| eZSiteInstaller::classIDbyIdentifier | ( | $ | params | ) |
Return ID of the content class. Params: 'identifier' - identifier of the class.
Definition at line 316 of file ezsiteinstaller.php.
Referenced by updateClassAttributes().
| eZSiteInstaller::contentObjectByName | ( | $ | params | ) |
Return content object. The first object is returned in case if several objects have the same name. Params: 'name' - object's name to look up; 'class_id' - optional, ID of content class;
Definition at line 667 of file ezsiteinstaller.php.
Referenced by nodeByName(), and removeContentObject().
| eZSiteInstaller::contentObjectByUrl | ( | $ | params | ) |
Return content object by path identification string of its node. Params: 'location' - path_identification_string of the node.
Definition at line 597 of file ezsiteinstaller.php.
Referenced by updateObjectAttributeFromString().
| eZSiteInstaller::createContentObject | ( | $ | params | ) |
Create content object. Params: class_identifier - identifier of class; location - path identification string of parent node; attributes - array with object attributes;
Definition at line 617 of file ezsiteinstaller.php.
| eZSiteInstaller::createContentSection | ( | $ | params | ) |
Create new content section. Params: 'name' - string: section name; 'navigation_part_identifier' - string: identifier of navigation part;
Definition at line 1331 of file ezsiteinstaller.php.
| eZSiteInstaller::createSiteAccess | ( | $ | params | ) |
Create localized siteaccess: copy general setting form 'source' siteaccess, apply new custom settings(locale, others...).
Definition at line 1567 of file ezsiteinstaller.php.
Referenced by createTranslationSiteAccesses().
| eZSiteInstaller::createSiteaccessUrls | ( | $ | params | ) |
Create siteaccess urls for additional user siteacceses using info about access type(host, post, uri) Params: 'siteaccess_list' - list of siteaccess names to build urls; 'access_type' - access type: port, hostname, url; 'port' - optional, port number to start with. used if 'access_type' is 'port'; 'exclude_port_list' - optional, ports to skip. used if 'access_type' is 'port'; 'host' - host name 'host_prepend_siteaccess' - optional, boolean which instructs to prepend the site access name or not to the value of 'host', by default true
Definition at line 1480 of file ezsiteinstaller.php.
| eZSiteInstaller::dbBegin | ( | $ | params | ) |
Start transaction. Params: no params
Definition at line 287 of file ezsiteinstaller.php.
| eZSiteInstaller::dbCommit | ( | $ | params | ) |
Commit transaction. Params: no params
Definition at line 298 of file ezsiteinstaller.php.
| eZSiteInstaller::defaultErrorHandler | ( | ) |
Default error handler
Definition at line 1733 of file ezsiteinstaller.php.
Referenced by executeSteps().
| eZSiteInstaller::execFunction | ( | $ | function | ) |
Execute $function defined in step
Definition at line 200 of file ezsiteinstaller.php.
Referenced by buildFunctionParams(), and executeSteps().
| eZSiteInstaller::executeSteps | ( | $ | steps | ) |
| eZSiteInstaller::eZSiteInstaller | ( | $ | parameters = false | ) |
Definition at line 53 of file ezsiteinstaller.php.
| eZSiteInstaller::getParam | ( | $ | params, |
| $ | name, | ||
| $ | defaultValue = false |
||
| ) | [static] |
Return a value from $params hash. Return $defaultValue is value is not set. $name - a key in $params hash. $name can point to 2-dimensional array. example: $name = 'foo' will return $params['foo']; $name = 'foo/boo' will return $params['foo']['boo']
Definition at line 1708 of file ezsiteinstaller.php.
| eZSiteInstaller::handleError | ( | ) |
Virtual function to re-implement in derived classes to handle error. Default error handler will be called if returns FALSE.
Definition at line 1742 of file ezsiteinstaller.php.
Referenced by executeSteps().
| eZSiteInstaller::hasSetting | ( | $ | name | ) |
Return TRUE if setting exist, otherwise FALSE.
Definition at line 144 of file ezsiteinstaller.php.
Referenced by setting().
| eZSiteInstaller::initSettings | ( | $ | parameters | ) |
Initialize $Settings member with custom values which can be used in install steps.
Definition at line 71 of file ezsiteinstaller.php.
Referenced by eZSiteInstaller().
| eZSiteInstaller::initSteps | ( | ) |
Define install steps Step definition: array( '_function' => <function_name>, '_params' => array( <param_list> ) ) where '_function' defines function name(which should be implemented within installer class) which will be called, '_params' is an array of parameters which will be passed to function <function_name>. Note that items of <param_list> can be defined in the form as <step definition>=""> and this rule can be applied recursively.
Each function used in step definition should be defined as: function someFunction( $params ) { ... you code goes here ...
optionally you can set $LastErrorCode to 'eZSiteInstaller::ERR_ABORT' if you want to break installation if some step is failed. $this->setLastErrorCode( eZSiteInstaller::ERR_ABORT ); }
Example: array( '_function' => 'step_1', '_params' => array( 'param_a' => 'foo', 'param_b' => array( '_function' => 'helper_function_for_b', '_params' => array( 'param_b_a' => 'goo', 'param_b_b' => array( '_function' => 'helper_functin_for_b_b', '_params' => array( 'param_b_b_a' => 'b_b_a' ) ) ) ) ) ); Execution flow:
Definition at line 110 of file ezsiteinstaller.php.
Referenced by eZSiteInstaller().
| & eZSiteInstaller::instance | ( | $ | params | ) |
Definition at line 61 of file ezsiteinstaller.php.
Referenced by createSiteAccess(), createSiteaccessUrls(), dbBegin(), dbCommit(), setVersion(), swapNodes(), and updateINIFiles().
| eZSiteInstaller::isFunctionParam | ( | $ | param | ) |
Return TRUE is custom function should be called to prepare params, otherwise FALSE( $param is constant).
Definition at line 232 of file ezsiteinstaller.php.
Referenced by buildFunctionParams().
| eZSiteInstaller::languageNameFromLocale | ( | $ | locale | ) |
Return language name from locale string. Example: 'rus' from 'rus-RU'
Definition at line 1463 of file ezsiteinstaller.php.
Referenced by createTranslationSiteAccesses(), and languageNameListFromLocaleList().
| eZSiteInstaller::languageNameListFromLocaleList | ( | $ | localeList | ) |
Build array of language names from locale list. Example: array( 'eng-GB', 'rus-RU' ) => array( 'eng', 'rus' )
Definition at line 1450 of file ezsiteinstaller.php.
| eZSiteInstaller::lastErrorCode | ( | ) |
Get last error code.
Definition at line 252 of file ezsiteinstaller.php.
Referenced by defaultErrorHandler(), and executeSteps().
| eZSiteInstaller::moveTreeNode | ( | $ | params | ) |
Move node. Params: 'node' - array( 'name' => object's name to move, 'class_id' => optional, object's content class ID );
'parent_node' - array( 'name' => parent object's name to move; 'class_id' => optional, parent object's content class ID );
Definition at line 1011 of file ezsiteinstaller.php.
| eZSiteInstaller::nodeByName | ( | $ | params | ) |
Definition at line 991 of file ezsiteinstaller.php.
Referenced by nodeIdByName().
| eZSiteInstaller::nodeByUrl | ( | $ | params | ) |
Return node. Params: 'location' - path_identification_string of the node.
Definition at line 954 of file ezsiteinstaller.php.
Referenced by assignUserToRole(), contentObjectByUrl(), createContentObject(), nodePathStringByURL(), and setSection().
| eZSiteInstaller::nodeIdByName | ( | $ | params | ) |
Definition at line 975 of file ezsiteinstaller.php.
Referenced by moveTreeNode(), and swapNodes().
| eZSiteInstaller::nodePathStringByURL | ( | $ | params | ) |
Return 'path_string' attribute of the node. Params: 'location' - path_identification_string of the node.
Definition at line 933 of file ezsiteinstaller.php.
| eZSiteInstaller::packageFileItemPath | ( | $ | params | ) |
Return path for package item.
Definition at line 1420 of file ezsiteinstaller.php.
| eZSiteInstaller::postInstall | ( | ) |
Execute 'post_install' steps
Definition at line 164 of file ezsiteinstaller.php.
| eZSiteInstaller::postInstallSteps | ( | ) |
Return 'post_install' steps
Definition at line 156 of file ezsiteinstaller.php.
Referenced by postInstall().
| eZSiteInstaller::removeClassAttribute | ( | $ | params | ) |
Remove attribute from the content class Params: 'class_id' - ID of content class to remove attribute from; 'attribute_identifier' - attibute identifier to remove;
Definition at line 364 of file ezsiteinstaller.php.
| eZSiteInstaller::removeContentObject | ( | $ | params | ) |
Remove content object. Params: see 'contentObjectByName'
Definition at line 691 of file ezsiteinstaller.php.
| eZSiteInstaller::removePoliciesForRole | ( | $ | params | ) |
Remove policies from role Params: role_name - name of role; policies - array of policies to remove. Each item is an array of policy definition: array( 'module' => , 'function' => ); remove_role - boolean, optional. If TRUE - empty(without policies) role will be removed. Default is TRUE.
Definition at line 1264 of file ezsiteinstaller.php.
| eZSiteInstaller::renameContentObject | ( | $ | params | ) |
Change name of content object. Params: contentobject_id - ID of object; name - new object name;
Definition at line 650 of file ezsiteinstaller.php.
| eZSiteInstaller::reportError | ( | $ | text, |
| $ | caption, | ||
| $ | errCode = eZSiteInstaller::ERR_ABORT |
||
| ) |
Set last error code and write error message to debug output Params: $text - error message text; $caption - error message caption; $errCode - error code to set;
Definition at line 264 of file ezsiteinstaller.php.
Referenced by addClassAttributes(), addPoliciesForRole(), executeSteps(), nodeByUrl(), removeClassAttribute(), removePoliciesForRole(), swapNodes(), updateContentObjectAttributes(), and updateObjectAttributeFromString().
| eZSiteInstaller::sectionIDbyName | ( | $ | params | ) |
Return ID of the section. Params: 'section_name' - name of the section
Definition at line 1304 of file ezsiteinstaller.php.
Referenced by setSection().
| eZSiteInstaller::setLastErrorCode | ( | $ | errCode | ) |
Set last error code.
Definition at line 244 of file ezsiteinstaller.php.
Referenced by reportError().
| eZSiteInstaller::setRSSExport | ( | $ | params | ) |
Create rss export.
Definition at line 1380 of file ezsiteinstaller.php.
| eZSiteInstaller::setSection | ( | $ | params | ) |
Assign section to subtree. Params: 'section_name' - string: section name; 'location' - string: path_identification_string of the node(root node of subtree);
Definition at line 1354 of file ezsiteinstaller.php.
| eZSiteInstaller::setting | ( | $ | name | ) |
Return value for setting $name.
Definition at line 126 of file ezsiteinstaller.php.
Referenced by packageFileItemPath().
| eZSiteInstaller::setVersion | ( | $ | params = false | ) |
Set solution name and version into db. Params: not used
Definition at line 1617 of file ezsiteinstaller.php.
| eZSiteInstaller::solutionName | ( | ) |
Definition at line 1607 of file ezsiteinstaller.php.
Referenced by setVersion().
| eZSiteInstaller::solutionVersion | ( | ) |
Definition at line 1602 of file ezsiteinstaller.php.
Referenced by setVersion().
| eZSiteInstaller::swapNodes | ( | $ | params | ) |
Swap two nodes. It's a copy/paste from kernel/content/action.php
Definition at line 1025 of file ezsiteinstaller.php.
| eZSiteInstaller::updateClassAttributes | ( | $ | params | ) |
Update class attribute data. Currently only attribute 'name' is supported. Params: 'class' - array( 'identifier' - identifire of content class ); 'attributes - array( array( 'identifier' - attibute identifier to update; 'new_name' - new attribute name ), ... );
Definition at line 553 of file ezsiteinstaller.php.
| eZSiteInstaller::updateContentObjectAttributes | ( | $ | params | ) |
Definition at line 776 of file ezsiteinstaller.php.
| eZSiteInstaller::updateINIFiles | ( | $ | params | ) |
Definition at line 1629 of file ezsiteinstaller.php.
| eZSiteInstaller::updateObjectAttributeFromString | ( | $ | params | ) |
Update contentObjectAttribute with value specified in string. The object can be specified either by ID or by path identification string of its node. Params: object_id - optional, ID of object to update; location - optional, path to node with object; class_attribute_identifier - an identifier of attribute to update; string - new attribute value;
Definition at line 722 of file ezsiteinstaller.php.
| eZSiteInstaller::updatePreferences | ( | $ | params | ) |
Definition at line 1685 of file ezsiteinstaller.php.
| eZSiteInstaller::updateRoles | ( | $ | params | ) |
Definition at line 1645 of file ezsiteinstaller.php.
| eZSiteInstaller::$LastErrorCode |
Definition at line 1753 of file ezsiteinstaller.php.
| eZSiteInstaller::$Settings |
Definition at line 1749 of file ezsiteinstaller.php.
| eZSiteInstaller::$Steps |
Definition at line 1751 of file ezsiteinstaller.php.
| const eZSiteInstaller::ERR_ABORT = 1 |
Definition at line 50 of file ezsiteinstaller.php.
Referenced by executeSteps().
| const eZSiteInstaller::ERR_CONTINUE = 2 |
Definition at line 51 of file ezsiteinstaller.php.
Referenced by updateContentObjectAttributes().
| const eZSiteInstaller::ERR_OK = 0 |
Definition at line 49 of file ezsiteinstaller.php.
Referenced by executeSteps(), and eZSiteInstaller().
1.7.5.1