API Documentation

API Documentation / Wiki

The following pages provide an overview about all functions of the API (Application Programming Interface) of the hyper Content & Digital Asset Management Server.
Please note, that you might usually only require few functions for the development of Plugins, template functions like navigation, sitemap and so on. Please read the Template Designers Guide and Programers Guide for a better insight.
The API is primarily used for the implementation of standalone applications that leverage the capabilities of the hyper Content & Digital Asset Management Server. The API is not to be confused with the OpenAPI, which is based on a SOA (Service Oriented Architecture), and is not part of the Free Edition.

For Questions & Answers please visit the Google Group.

hyperCMS API Function Reference

  1. Main API Functions
  2. Get API Functions
  3. Set API Functions
  4. Connect API Functions
  5. Security API Functions
  6. Media API Functions
  7. Metadata API Functions
  8. Link API Functions
  9. Plugin API Functions
  10. User Interface API Functions
  11. Template Engine API Functions
  12. XML API Functions
  13. Report API Functions
  14. Project API Functions
  15. Task API Functions
  16. Workflow API Functions
  17. Cloud Storage API Functions
  18. Import/Export API Functions

Link API Functions

link_db_restore


Description
This function restores a given or all link management index files

Syntax
link_db_restore ($site="")

Input parameters
  • $site ... publication name [string] (optional)

global input parameters
  • $mgmt_config

Output
  • true / false on error


link_db_load


Description
This function loads and locks the link management database
each record of the link management database has the following design:
xml-content container :| absolute path to 1-n objects :| 1-m links used by 1-n objects
important: the link management database has to saved or closed after loading it.

Syntax
link_db_load ($site, $user)

Input parameters
  • $site ... publication name [string]
  • $user ... user name [string]

global input parameters
  • $mgmt_config

Output
  • link database [2 dim. array] or true / false on error


link_db_read


Description
This function loads the link management database for reading without locking

Syntax
link_db_read ($site)

Input parameters
  • $site ... publication name [string]

global input parameters
  • $mgmt_config

Output
  • link database [2 dim. array] or true / false on error


link_db_close


Description
closes and unlocks the link management database.

Syntax
link_db_close ($site, $user)

Input parameters
  • $site ... publication name [string]
  • $user ... user name [string]

global input parameters
  • $mgmt_config

Output
  • true/false


link_db_save


Description
This function saves und unlocks the link management database

Syntax
link_db_save ($site, $link_db, $user)

Input parameters
  • $site ... link database [array]
  • $link_db ... publication name [string]
  • $user ... user name [string]

global input parameters
  • $mgmt_config

Output
  • true/false on error


link_db_update


Description
This function inserts, updates and removes objects and their links from the link management database (add or update a link)
depending on which link is left empty:
link_curr = "": add new link (just one link matching given category)
link_new = "": delete current link in use (just one link matching given category)
link_curr & link_new are not empty and not equal: update current link with the new one

Syntax
link_db_update ($site, $link_db, $attribute, $contentfile="", $cat="", $link_curr="", $link_new="", $option="unique")

Input parameters
  • $site ... publication name [string]
  • $link_db ... link database [2 dim. array]
  • $attribute ... attribute [object, link]
  • $contentfile ... content container [string] (optional)
  • $cat ... link category [comp, page] (optional)
  • $link_curr ... current link must be an URL or absolute/relative path [string] (optional)
  • $link_new ... new link must be an URL or absolute/relative path [string] (optional)
  • $option ... update option [all, unique]

global input parameters
  • $mgmt_config

Output
  • link database [array] or true if link index database is not used / false on error


link_db_insert


Description
This function inserts a new record in the link management database
optionally the created object can be also inserted

Syntax
link_db_insert ($site, $link_db, $contentfile, $cat, $object="")

Input parameters
  • $site ... publication name [string]
  • $link_db ... link database [2 dim. array]
  • $contentfile ... content container name [string]
  • $cat ... link category [comp, page]
  • $object ... object name (optional)

global input parameters
  • $mgmt_config

Output
  • link database [2 dim. array] or true / false


link_db_delete


Description
This function deletes a record in the link management database

Syntax
link_db_delete ($site, $link_db, $contentfile)

Input parameters
  • $site ... link database [2 dim. array]
  • $link_db ... content container name [string]
  • $contentfile

global input parameters
  • $mgmt_config

Output
  • link database [2 dim. array] or true / false on error


link_db_getobject


Description
This function splits the object string into an array of objects.

Syntax
link_db_getobject ($multiobject)

Input parameters
  • $multiobject ... link database attribut (references to objects seperated by |) [string]

global input parameters
  • $mgmt_config

Output
  • objects [array] / false on error


link_update


Description
This function updates the link of the published and working content container and link file

Syntax
link_update ($site, $container, $link_old, $link_new)

Input parameters
  • $site ... publication name [string]
  • $container ... container name [string]
  • $link_old ... old link (converted) [string]
  • $link_new ... new link (converted) [string]

global input parameters
  • $user
  • $mgmt_config

Output
  • true/false


getlinkedobject


Description
This function gets all objects which link to the given object.
works with pages (page links) and components (component links) if link management is enabled.

Syntax
getlinkedobject ($site, $location, $page, $cat)

Input parameters
  • $site ... publication name [string]
  • $location ... location [string]
  • $page ... object (name and extension) [string]
  • $cat ... category [page, comp] (optional)

global input parameters
  • $mgmt_config

Output
  • objects which link to the given object [array] or true / false


getconnectedobject


Description
This function gets all objects which use the same content container and are therefore connected.

Syntax
getconnectedobject ($container, $type="work")

Input parameters
  • $container ... container name or ID [string]
  • $type ... container type [work, published, version] (optional)

global input parameters
  • $mgmt_config
  • $user

Output
  • connected objects[array]


extractlinks


Description
This function extracts all links based on it's identifier from a text and returns an array of all links

Syntax
extractlinks ($textcontent, $identifier)

Input parameters
  • $textcontent ... text content [string]
  • $identifier ... link identifiert ["href" for hyperreferences, "src" for image references or embed references (flash), "value" for paramter (flash)]

global input parameters
  • $mgmt_config

Output
  • object links [array] / false on error


This website uses cookies to ensure you get the best experience on our website. More info