Skip to content

Latest commit

 

History

History
183 lines (158 loc) · 4.71 KB

modules_contentobject.md

File metadata and controls

183 lines (158 loc) · 4.71 KB
Raw

Modules - contentobject

The contentobject module provides methods to manipulate content objects.

attributematch

Get list of objects matching the content class and a match on the attribute value.

$ eep contentobject attributematch <content class identifier> <attribute identifier> <search value>

clearcache

Clears the content cache for given content object.

$ eep use ezroot <path>
$ eep use contentobject <object id>
$ eep contentobject clearcache
or
$ eep contentobject clearcache <object id>

info

Displays some information about a content object.

$ eep use ezroot <path>
$ eep use contentobject <object id>
$ eep contentobject info
or
$ eep contentobject info <object id>

datamap

Displays most of the content object datamap.

$ eep use ezroot <path>
$ eep use contentobject <object id>
$ eep contentobject datamap
or
$ eep contentobject datamap <object id>

delete

Deletes a content object and it's children.

$ eep use ezroot <path>
$ eep use contentobject <object id>
$ eep contentobject delete
or
$ eep contentobject delete <object id>

dump

Dump all content data, suitable for export from ez. See "eep contentnode dump".

related

Displays a list of related content objects.

  • supports use of --limit=N and --offset=M
$ eep use ezroot <path>
$ eep use contentobject <object id>
$ eep contentobject related
or
$ eep contentobject related <object id>

reverserelated

Displays a list of reverse related content objects.

  • supports use of --limit=N and --offset=M
$ eep use ezroot <path>
$ eep use contentobject <object id>
$ eep contentobject reverserelated
or
$ eep contentobject reverserelated <object id>

contentnode

Converts a content object id into a content node id.

$ eep use ezroot <path>
$ eep contentobject contentnode <content object id>
or
$ eep use ezroot <path>
$ eep use contentobject <content object id>
$ eep contentobject contentnode

republish

Republishes a content object.

$ eep use ezroot <path>
$ eep use contentobject <object id>
$ eep contentobject republish
or
$ eep contentobject republish <object id>

sitemapxml

Displays a line of XML for inclusion in a sitemap.

  • Note domain is only: example.com
  • Note <change frequency> is one of: always hourly daily weekly monthly yearly never
  • Note that the sitemap header is: <?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  • the matching close is: </urlset>
$ eep contentobject sitemapxml <object id> <domain> [<change frequency> [<priority>]]

deleteversions

Deletes all the archived versions of a content object.

$ eep contentobject deleteversions <object id>

fetchbyremoteid

Fetches a content object by remote id.

$ eep use ezroot <path>
$ eep contentobject fetchbyremoteid <remoteid>

translationcreate

Adds a new translation for the content object, optionally copies the translation from an existing one

  • Note that 'locale's are, eg., eng-GB or eng-US
$ eep contentobject translationcreate <object id> <new locale> [<existing locale>]

translationsetmain

Sets the main translation, eg. in preparation to removing eng-GB as a supported translation

$ eep contentobject translationsetmain <object id> <locale>

translationremove

Removes a translation from the content object

$ eep contentobject translationremove <object id> <locale>

stateassignbyid

Assigns an object state by state id

eep contentobject stateassignbyid <object id> <state id>

stateassignbyidentifier

Assigns an object state by state/group identifier e.g. ez_lock/locked eZ Publish ships with one state group with two states by default

  • ez_lock/locked
  • ez_lock/not_locked

All state groups and states can be found in the admin interface: Setup > States

eep contentobject stateassignbyidentifier <object id> <state/group identifier>

stateview

Displays object state information

eep contentobject stateview <object id>