{"id":19693548,"url":"https://github.com/ezsystems/ezxmlinstaller","last_synced_at":"2025-04-29T09:31:47.134Z","repository":{"id":1124143,"uuid":"997444","full_name":"ezsystems/ezxmlinstaller","owner":"ezsystems","description":null,"archived":false,"fork":false,"pushed_at":"2016-04-21T11:59:18.000Z","size":578,"stargazers_count":22,"open_issues_count":5,"forks_count":13,"subscribers_count":33,"default_branch":"master","last_synced_at":"2025-04-05T14:51:11.848Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ezsystems.png","metadata":{"files":{"readme":"README","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-10-18T12:28:22.000Z","updated_at":"2020-12-24T01:25:25.000Z","dependencies_parsed_at":"2022-08-16T12:05:26.580Z","dependency_job_id":null,"html_url":"https://github.com/ezsystems/ezxmlinstaller","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ezsystems%2Fezxmlinstaller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ezsystems%2Fezxmlinstaller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ezsystems%2Fezxmlinstaller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ezsystems%2Fezxmlinstaller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ezsystems","download_url":"https://codeload.github.com/ezsystems/ezxmlinstaller/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251473481,"owners_count":21595055,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T19:17:11.678Z","updated_at":"2025-04-29T09:31:46.579Z","avatar_url":"https://github.com/ezsystems.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"eZ XML Installer extension 0.0.1 README\n\n\nWhat is the eZ XML Installer extension?\n=======================================\n\n   The eZ XML Installer extension is a plattform to define \n   proccesses for eZ Publish and execute them.\n   Proccesses will be defined in XML. The XML can be provided as\n   completed XML or as eZ Publish Template.\n   This template can contain a set of variables which will the user be ask for\n   before the processes will be executed.\n   The XML is a set of actions. Each action is bundled to a handler\n   which will proccess this action.\n   The set of handlers can be extended by custom handers.\n\n\neZ XML Installer version\n========================\n\nThe current version of eZ XML Installer is 0.0.1.\nYou can find details about changes for this version in\ndoc/changelogs/\n\n\nLicense\n=======\n\nThis software is licensed under the GNU General Public License. The complete\nlicense agreement is included in the LICENSE file. For more information\nor questions please contact info@ez.no\n\nRequirements\n============\n\nThe following requirements exists for using eZ XML Installer extension:\n\no  eZ Publish version:\n\n   Make sure you use eZ Publish version 3.9 or higher.\n\no  PHP version:\n\n   as indicated in your eZ Publish version requirements\n\n\nInstallation\n============\n\nPlease read the INSTALL file for installation instructions.\n\n\nCreating a custom proccess XML file\n===================================\nA proccess XML files will be defined with a enclosing \u003ceZXMLImporter\u003e tag.\nThis tag contains a set of proccess definitions.\nHere is an example:\n\u003ceZXMLImporter\u003e\n    \u003cProccessInformation comment=\"Content in media sections\" /\u003e\n    \u003cMyCustomAction\u003e\n        \u003cDoThis value1=\"foo\" value2=\"bar\" /\u003e\n        \u003cDoThat myvalue=\"lorem\" myothervalue=\"ipsum\" /\u003e\n    \u003c/MyCustomAction\u003e\n\u003c/eZXMLImporter\u003e\n\nThe XML structure of each action is defined by the handler.\nThe proccess definition will be executed step by step downwards from top.\n\nThe eZXMLImporter tag may contain some attributes which will be called \"settings\".\nThis can be global settings. E.g. where are some binary files located.\n\nInternal / External references\n------------------------------\nThe XML can contain internal or external referneces.\nCurrently are only \"node_id\" and \"object_id\" as external references are supported.\nReferences can be only used by actions where the handler supports references.\n* Internal reference definition\n  References will be defined inside the action definition.\n  Example:\n  \u003cSetReference attribute=\"object_id\" value=\"CONTENT_MANAGER_GROUP\" /\u003e\n  The \"attribute\" attribute will define which variable of the current action will be defined as reference.\n  The \"value\" attribute will name the variable the reference can be used with.\n* External reference definition\n  External references can be used without defintion.\n  It is important to only use values which will exist in the installation.\n  Otherwise this can cause errors and data inconsistencies.\n* Usage of internal references\n  Internal references can be used with the \"internal:\" prefix.\n  References are not supported everywhere. Please consult the handler documentation where references can be used.\n  Example:\n  \u003cRoleAssignment roleID=\"8\" assignTo=\"internal:CONTENT_MANAGER_GROUP\" /\u003e\n  In this example role with id 8 will be assigned to the newly created group with reference \"CONTENT_MANAGER_GROUP\".\n* Usage of external references\n  Internal references can be used with the \"node_id:\" or \"object_id:\" prefix.\n  References are not supported everywhere. Please consult the handler documentation where references can be used.\n\nDefault XML Installer handler\n-----------------------------\nHere is a short introduction in the hanlder shipped with this extension\n* ProccessInformation\n  This simple action will only display the given comment and increase the internal step counter.\n* AssignRoles\n  This action can be used to assign existing roles to user or user groups.\n* CreateContent\n  This action is used to create content objects based on existing content classes.\n  Please note that currently not all datatypes are supported.\n* SetSettings\n  This action can create new or modify existing setting files.\n  Please note that the standard eZ Publish mechanism is used.\n  This may cause a loss of comments or unsupported ini usage.\n\n\nCreating a custom proccess template file\n========================================\nThe template based proccess definition is an extended version of the file based definition.\nThe XML structure must be defined as described.\nThe template must be located under templates/xmlinstaller in a valid design.\nBut it is possible to define a set of variables which will be requested and can be used in the xml.\nFuthermore it is possible to use standard template functionallity.\n\nDefing the XML structure\n------------------------\nThe XML must be defined in a variable block with the name \"xml_data\".\nExample:\n{set-block variable='xml_data'}\n\u003c?xml version = '1.0' encoding = 'ISO-8859-1'?\u003e\n\u003ceZXMLImporter\u003e\n[...]\n\u003c/eZXMLImporter\u003e\n{/set-block}\n\nDefining and using template variables\n-------------------------------------\nTo request custom input before processing the \"tpl_info\" variable can be defined in the template.\nE.g.\n{set $tpl_info=hash(\n        'var1',      hash(   'info',     'Number of objects',\n                             'type',     'int' ),\n        'var2',      hash(   'info',     'URL to siteaccess',\n                             'type',     'string',\n                             'default',  'http://mmc.ez' ))}\nThis will request two variables. \"var1\" and \"var2\"\nThe hash of each variable defines the additional information.\n* info:    The info text for the request.\n* type:    The type of the variable (int or string)\n* default: The default value (used when input is empty).\n\nThe variabled will be rquested before proccessing and can thus be used in the template as named.\nE.g. {$var1} and {$var2}.\n\n\nProccessing the XML\n===================\nThe xmlinstaller.php script will proccess the XML.\n\nThe script is located in extension/ezxmlinstaller/bin/php/.\n\nIt can be used in two ways:\n* Proccessing a template:\n  php extension/ezxmlinstaller/bin/php/xmlinstaller.php --template=demo/mynewsiteaccess\n  In this case the name of the template (without .tpl, but with additional directories)\n  must be given as \"template\" parameter.\n* Proccessing a xml file:\n  php extension/ezxmlinstaller/bin/php/xmlinstaller.php --file=path/to/my/xml/demo.xml\n  In this case the relative or absolute path to a valid xml file must be given as \"file\" parameter.\n\n\nCreating a custom handler\n=========================\npossible, but not documented yet.\n\n\nWhere to get more help\n======================\n\neZ Publish forums: http://ez.no/community/forum\n\n\nTroubleshooting\n===============\n\n1. Read the FAQ\n   ------------\n\n   Some problems are more common than others. The most common ones are listed\n   in the FAQ file.\n\n2. Support\n   -------\n\n   If you have find any problems not handled by this document or the FAQ you\n   can contact eZ system trough the support system:\n   http://ez.no/services/support\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fezsystems%2Fezxmlinstaller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fezsystems%2Fezxmlinstaller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fezsystems%2Fezxmlinstaller/lists"}