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

Plugin API Functions

plugin_getdefaultconf


Syntax
plugin_getdefaultconf ()

Input parameters

Output
  • default value as array


plugin_readmenu


Description
Reads Menupoints and menugroups from the xml data.
Be carefull with nesting, function getcontent is used and you can't nest groups inside of groups as a subpoint!
Input parameter $pluginFolder contains the directory of the plugin.
Returns an Array containing every group and menupoint with its configuration.

Syntax
plugin_readmenu ($xml, $pluginFolder)

Input parameters
  • $xml ... plugin xml [string]
  • $pluginFolder ... plugin directory [string]

global input parameters
  • $mgmt_config

Output
  • menu point array used by navigator


plugin_parse


Description
Reads the plugin configurations from the file system.
Checks the folder defined in mgmt_config and searched for plugins and their configurations files.
It either takes needed values from the configuration, from the $oldData or defaultConfiguration.

Syntax
plugin_parse ($oldData=array())

Input parameters
  • $oldData ... mgmt_plugin [array] (optional)

global input parameters
  • $mgmt_config

Output
  • mgmt_plugin as array


plugin_generatedefinition


Description
Generates the Array definition used in php for $array with the name of $arrayName.
Run recursively through the array and supports boolean, numeric and string types for the key and value.

Syntax
plugin_generatedefinition ($arrayName, $array)

Input parameters
  • $arrayName ... name of array holding the plugin definitions [string]
  • $array ... configuration containing the values and keys [array]

global input parameters
  • $mgmt_config

Output
  • plugin array / false on error


plugin_saveconfig


Description
Saves the plugin configuration $configuration into the configuration file.
The configuration file is located in the data/config directory and is named plugin.conf.php.

Syntax
plugin_saveconfig ($configuration)

Input parameters
  • $configuration ... configuration [array]

global input parameters
  • $mgmt_config

Output
  • true / false on error


plugin_generatelink


Description
Generates a link to be used when linking to other pages inside of a plugin

Syntax
plugin_generatelink ($plugin, $page, $control=false, $additionalGetParameters=false)

Input parameters
  • $plugin ... plugin name [string]
  • $page ... plugin page (relative reference to the plugins main page) [string]
  • $control ... control (relative reference to the plugins control page) [string]
  • $additionalGetParameters ... additional GET parameters [string]

global input parameters
  • $mgmt_config

Output
  • plugin link


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