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

Report API Functions

createreport


Description
This function creates a new report

Syntax
createreport ($report_name)

Input parameters
  • $report_name ... report name [string]

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

Output
  • result array


editreport


Description
This function saves the configuration of a report.

Syntax
editreport ($report_name, $config)

Input parameters
  • $report_name ... report name [string]
  • $config ... report configuration [array]

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

Output
  • result array


loadreport


Description
This function loads the report configuration file and provides the data as array.

Syntax
loadreport ($report_name)

Input parameters
  • $report_name ... report name [string]

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

Output
  • result array / false


deletereport


Description
This function deletes a report

Syntax
deletereport ($report_name)

Input parameters
  • $report_name ... report name [string]

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

Output
  • result array


analyzeSQLselect


Description
This function analyzes an SQL Select statement and return its parts in an array

Syntax
analyzeSQLselect ($sql)

Input parameters
  • $sql ... SQL statement [string]

Output
  • result array


showpiechart


Description
This function creates the Google Chart Code for a pie chart. The Google Chart API need to be loaded first!

Syntax
showpiechart ($title="", $x_title="", $x_value="", $y_title="", $y_value="", $data_array=array(), $width="100%", $height="100%", $id="hcmsPieChart", $suffix="", $loadAPI=true)

Input parameters
  • $title ... chart title [string]
  • $x_title ... chart x-axis title [string]
  • $x_value ... chart x-axis array key name holding the values [string]
  • $y_title ... chart y-axis title [string]
  • $y_value ... chart y-axis array key name holding the values [string]
  • $data_array ... assoz. data array [array]
  • $width ... chart width [string] (optional)
  • $height ... chart height [string] (optional)
  • $id ... ID of chart [string] (optional)
  • $suffix ... function name suffix [string] (optional)
  • $loadAPI ... load Google Chart API [boolean] (optional)

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

Output
  • Google Chart code / false


showcolumnchart


Description
This function creates the Google Chart Code for a column chart. The Google Chart API need to be loaded first!

Syntax
showcolumnchart ($title="", $x_title="", $x_value="", $y1_title="", $y1_value="", $y2_title="", $y2_value="", $y3_title="", $y3_value="", $data_array=array(), $width="100%", $height="100%", $id="hcmsColumnChart", $suffix="", $loadAPI=true)

Input parameters
  • $title ... chart title [string]
  • $x_title ... chart x-axis title [string]
  • $x_value ... chart x-axis array key name holding the values [string]
  • $y1_title ... chart y1-axis title [string]
  • $y1_value ... chart y1-axis array key name holding the values [string]
  • $y2_title ... chart y2-axis title [string]
  • $y2_value ... chart y2-axis array key name holding the values [string]
  • $y3_title ... chart y3-axis title
  • $y3_value ... chart y3-axis array key name holding the values [string]
  • $data_array ... assoz. data array [array]
  • $width ... chart width [string] (optional)
  • $height ... chart height [string] (optional)
  • $id ... ID of chart [string] (optional)
  • $suffix ... function name suffix [string] (optional)
  • $loadAPI

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

Output
  • Google Chart code / false


showareachart


Description
This function creates the Google Chart Code for an area chart. The Google Chart API need to be loaded first!

Syntax
showareachart ($title="", $x_title="", $x_value="", $y1_title="", $y1_value="", $y2_title="", $y2_value="", $y3_title="", $y3_value="", $data_array=array(), $width="100%", $height="100%", $id="hcmsAreaChart", $suffix="", $loadAPI=true)

Input parameters
  • $title ... chart title [string]
  • $x_title ... chart x-axis title [string]
  • $x_value ... chart x-axis array key name holding the values [string]
  • $y1_title ... chart y1-axis title [string]
  • $y1_value ... chart y1-axis array key name holding the values [string]
  • $y2_title ... chart y2-axis title [string]
  • $y2_value ... chart y2-axis array key name holding the values [string]
  • $y3_title ... chart y3-axis title
  • $y3_value ... chart y3-axis array key name holding the values [string]
  • $data_array ... assoz. data array [array]
  • $width ... chart width [string] (optional)
  • $height ... chart height [string] (optional)
  • $id ... ID of chart [string] (optional)
  • $suffix ... function name suffix [string] (optional)
  • $loadAPI

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

Output
  • Google Chart code / false


showtimelinechart


Description
This function creates the Google Chart Code for a timeline chart. The Google Chart API need to be loaded first!

Syntax
showtimelinechart ($title="", $y_title="", $y_value="", $x1_title="", $x1_value="", $x2_title="", $x2_value="", $data_array=array(), $width="100%", $height="100%", $id="hcmsTimelineChart", $suffix="", $loadAPI=true)

Input parameters
  • $title ... chart title [string]
  • $y_title ... chart y-axis title [string]
  • $y_value ... chart y-axis array key name holding the values [string]
  • $x1_title ... chart x1-axis title
  • $x1_value ... chart x1-axis array key name holding the values [string]
  • $x2_title ... chart x2-axis title [string]
  • $x2_value ... chart x2-axis array key name holding the values [string]
  • $data_array ... assoz. data array [array]
  • $width ... chart width [string] (optional)
  • $height ... chart height [string] (optional)
  • $id ... ID of chart [string] (optional)
  • $suffix ... function name suffix [string] (optional)
  • $loadAPI ... load Google Chart API [boolean] (optional)

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

Output
  • Google Chart code / false


showgeolocationchart


Description
This function creates the Google Maps Code for a geolocation chart. The Google Maps API need to be loaded first!

Syntax
showgeolocationchart ($title="", $marker_value="", $lat_value="", $lng_value="", $link_value="", $data_array=array(), $width="100%", $height="100%", $id="hcmsGeolocationChart", $suffix="", $loadAPI=true)

Input parameters
  • $title ... chart title [string]
  • $marker_value ... array key name holding the value for the marker title [string]
  • $lat_value ... array key name holding the value for the latitude of the marker [string]
  • $lng_value ... array key name holding the value for the longitude of the marker [string]
  • $link_value ... array key name holding the value for the marker link [string]
  • $data_array ... assoz. data array [array]
  • $width ... chart width [string] (optional)
  • $height ... chart height [string] (optional)
  • $id ... ID of chart [string] (optional)
  • $suffix ... function name suffix [string] (optional)
  • $loadAPI ... load Google Maps API [boolean] (optional)

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

Output
  • Google Chart code / false


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