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

Template Engine API Functions

transformlink


Syntax
transformlink ($viewstore)

Input parameters
  • $viewstore ... view of object

global input parameters
  • $site
  • $location_esc
  • $page
  • $ctrlreload
  • $mgmt_config

Output
  • view with transformed links for easyedit mode


followlink


Syntax
followlink ($site, $follow)

Input parameters
  • $site ... publication name
  • $follow ... link to follow

global input parameters
  • $mgmt_config

Output
  • prepared input (location plus page) for easyedit mode (buildview) / false on error


errorhandler


Syntax
errorhandler ($source_code, $return_code, $error_identifier)

Input parameters
  • $source_code ... source code
  • $return_code ... return code
  • $error_identifier ... error identifier

Output
  • error message and view of the code with line identifiers


viewinclusions


Syntax
viewinclusions ($site, $viewstore, $hypertag, $view, $application, $charset="UTF-8")

Input parameters
  • $site ... view of object
  • $viewstore ... hypertag to create view of inlcuded objects
  • $hypertag ... view parameter
  • $view ... application
  • $application ... character set used (optional) view-parameter explanation: "template or any other word": the standard text (in table) will be included for the view "preview": preview of the content of the included file "publish": view the content of the included file as it is (for publishing)
  • $charset

global input parameters
  • $user
  • $mgmt_config
  • $location
  • $hcms_lang
  • $lang

Output
  • view of the content including the content of included objects


buildview


Description
buildview parameter may have the following values:
"formedit": use form for content editing
"formmeta": use form for content viewing only for meta informations (tag-type must be meta)
"formlock": use form for content viewing
"cmsview": view of page based on template, includes hyperCMS specific code (buttons)
"inlineview": view of page based on template, includes hyperCMS specific code (buttons) and inline text editing
"publish": view of page for publishing based on template without CMS specific code (editing)
"unpublish": execution of the code for unpublishing an object
"preview": view of page based on template for preview (inactive hyperlinks) without CMS specific code (buttons)
"template": view of template based on template for preview (inactive hyperlinks) without CMS specific code (buttons)

Syntax
buildview ($site, $location, $page, $user, $buildview="template", $ctrlreload="no", $template="", $container="", $force_cat="", $execute_code=true, $recognizefaces_service=false)

Input parameters
  • $site ... publication name [string]
  • $location ... location [string]
  • $page ... object name [string]
  • $user ... user name [string]
  • $buildview ... view parameter [string] (optional)
  • $ctrlreload ... reload workplace control frame and add html & body tags if missing [yes, no] (optional)
  • $template ... template name [string] (optional)
  • $container ... container name [string] (optional)
  • $force_cat ... force category to use different location path [page, comp] (optional)
  • $execute_code ... execute_code [boolean] (optional)
  • $recognizefaces_service ... recognize faces service in use [boolean] (optional)

global input parameters
  • $container_collection
  • $eventsystem
  • $db_connect
  • $mgmt_config
  • $siteaccess
  • $adminpermission
  • $setlocalpermission
  • $token
  • $is_mobile
  • $is_iphone
  • $viewportwidth
  • $mgmt_lang_shortcut_default
  • $hcms_charset
  • $hcms_lang_name
  • $hcms_lang_shortcut
  • $hcms_lang_codepage
  • $hcms_lang_date
  • $hcms_lang
  • $lang

Output
  • result array with view of the content / false on error


unescapeview


Syntax
unescapeview ($viewstore, $application="php")

Input parameters
  • $viewstore ... code [string]
  • $application ... application name [string] (optional)

Output
  • unescaped code / false on error


buildsearchform


Syntax
buildsearchform ($site="", $template="", $report="", $ownergroup="", $css_display="inline-block", $css_width_field="90%", $empty_values=true, $title="")

Input parameters
  • $site ... publication name [string] (optional for report)
  • $template ... template name [string] (optional)
  • $report ... or report name [string] (optional)
  • $ownergroup ... group access [array] (optional)
  • $css_display ... CSS display value for label tag [string] (optional)
  • $css_width_field ... CSS field width (optional)
  • $empty_values ... allow empty values [boolean] (optional)
  • $title ... display title [string] (optional)

global input parameters
  • $user
  • $siteaccess
  • $mgmt_config
  • $mgmt_lang_shortcut_default
  • $hcms_charset
  • $hcms_lang_name
  • $hcms_lang_shortcut
  • $hcms_lang_codepage
  • $hcms_lang_date
  • $hcms_lang
  • $lang
  • $is_mobile

Output
  • form view / false on error


buildbarchart


Syntax
buildbarchart ($paper_name, $paper_width=600, $paper_height=300, $paper_top=10, $paper_left=40, $x_axis, $y1_axis, $y2_axis="", $y3_axis="", $paper_style="", $bar1_style="", $bar2_style="", $bar3_style="", $show_value=false, $y_min_value=10)

Input parameters
  • $paper_name ... name/id of paper [string]
  • $paper_width ... width of paper in pixel [integer]
  • $paper_height ... height of paper in pixel [integer]
  • $paper_top ... top space in pixel [integer]
  • $paper_left ... left space in pixel [integer]
  • $x_axis ... x-axis values with index as 1st key and 'value', 'text', 'onclick' as 2nd key [array]
  • $y1_axis ... y1-axis values [array]
  • $y2_axis ... y2-axis values [array] (optional)
  • $y3_axis ... y3-axis values [array] (optional)
  • $paper_style ... paper CSS style [string] (optional)
  • $bar1_style ... 1st bar chart CSS style [string] (optional)
  • $bar2_style ... 2nd bar chart CSS style [string] (optional)
  • $bar3_style ... 3rd bar chart CSS style [string] (optional)
  • $show_value ... show y-value in chart bar [boolean] (optional)
  • $y_min_value ... mininmum y-axis value [integer] (optional)

global input parameters
  • $lang
  • $mgmt_config

Output
  • bar chart view / false on error


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