Path

ez.no / ezpublish / documentation / ez publish 3.4 / content object export with ezpm


Content object export with ezpm

These documentation pages are no longer maintained. Please visit the new documentation site.

Introduction

From 3.4 it will be possible to export content objects using the package system. You can do this with the command line version of the package manager (called ezpm).
The basics of doing this is first creating a new package, adding your objects or subtrees to the package then exporting it to a file. This file can later on be imported to another site.

Syntax

ezpm.php add package contentobject [options][path|node]

Options

  • --include-classes
    Include class definitions in package (default)
  • --include-templates
    Include related template files in package (default)
  • --exclude-classes
    Do not include class definitions in package
  • --exclude-templates
    Do not include related template files in package
  • --language
    Comma separated list of languages to export.
    If not supplied the value is taken from settings.
  • --current-version
    Export only the published version for all objects. (default)
  • --all-versions
    Export all versions for all objects.
  • --node-main
    Export only main node for all objects. (default)
  • --node-selected
    Export all nodes for all objects.
  • --siteaccess
    Comma separated list of siteaccess to get definitions from, determines template override data and designs.
    If not supplied the value is taken from default siteaccess.

Path syntax

The path is chosen in the same manner as the URL alias which is shown in the path in the browser. If you want to export all objects under the node you must add /* to the end of the path
e.g. news/this_is_news, news or news/*
Note: To fetch the entire tree including users and media you must use an empty string, e.g. ''

Node syntax

The node is simply the node ID which is a integer number.
e.g. 2, 5 or 42

Examples

A couple of examples, all uses forum as package.

All objects in forum

ezpm.php add forum contentobject 'forum/*'

All versions and objects in forum

ezpm.php add forum contentobject --all-versions 'forum/*'

All objects in forum, but no templates

ezpm.php add forum contentobject --exclude-templates 'forum/*'

Comments

Other ezpm commands

create: Create a new package.
usage: create NAME [SUMMARY [VERSION [INSTALLTYPE]]] [PARAMETERS]

SUMMARY: A short summary of your package
VERSION: The version of your package, default is 1.0
INSTALLTYPE: Use install (default) for a package that installs files or
import for a package that can only be imported.
Parameters:

install: Install an eZ publish package.
usage: install PACKAGE

PACKAGE can be specified with just the name of the of package or
the filename of the package. If just the name is used the package
will be looked for by appending .ezpkg

import: Import an eZ publish package.
usage: import PACKAGE

PACKAGE can be specified with just the name of the of package or
the filename of the package. If just the name is used the package
will be looked for by appending .ezpkg

export: Export a part of the eZ publish installation into a package.
usage: export TYPE [PARAMETERS]... [TYPE [PARAMETERS]...]...

Options:
-o,--output FILE export to file

add: Adds an eZ publish item to the package.
usage: add PACKAGE ITEM [ITEMPARAMETERS]...

Items:
group: Add categorization groups
ezcontentclass: Add contentclass definitions
Note: Will open up a new release if no open releases exists yet.

set: Sets an attribute in the package.
usage: set PACKAGE ATTRIBUTE ATTRIBUTEVALUE

Attributes:
summary :
description :
vendor :
priority :
type :
extension :
source :
version :
licence :
state :
Note: Will open up a new release if no open releases exists yet.

list (ls): Lists all packages in the repository.
usage: list

info: Displays information on a given package.
usage: info PACKAGE

Contents

ez publish 3.4

Content object export with ezpm
Content object import and export
Ini settings module
Using 'look and feel' to configure yo...
Using 'Settings' object to change ini...
Using database schema checker
Using file consistency check


Created

13/05/2004
4:10:16 pm
by Jan Borsodi

Last updated

22/06/2004
11:15:38 am
by Kåre Køhler Høvik

Authors

Jan Borsodi
Kåre Køhler Høvik



This page is part of the eZ Publish documentation. The documentation is available under the GNU Free Documentation License. All contributions will be released under the terms of this license.