API Dokumentation

API Dokumentation / Wiki

Die folgenden Seiten geben einen Überblick über die Funktionen des API (Programmierschnittstelle) des hyper Content & Digital Asset Management Servers.
Bitte beachten Sie, dass Sie in der Regel nur wenige Funktionen für die Entwicklung von Plugins oder speziellen Template-Funktionen, wie automatische Erstellung einer Navigation, Sitemap und so weiter, benötigen. Bitte studieren Sie den Template Designers Guide und Programers Guide für eine bessere Einsicht in die Handhabung dieser Funktionen.
Das API dient primär für die Umsetzung eigenständiger Anwendungen, die die Funktionen des hyper Content & Digital Asset Management Servers nutzen. Das API ist nicht mit dem OpenAPI zu verwechseln, welchen auf einer SOA (Service Oriented Architecture) basiert und nicht Bestandteil der Free Edition ist.

Fragen und Antworten bitte innerhalb der Google Group.

hyperCMS API Function Reference

▲ User Interface API Functions

windowwidth

Description
Returns the width of the object window when editing/opening an object

Syntax
windowwidth ($type="object")

Input parameters

$type ... type [string] (optional)

global input parameters

$mgmt_config

Output

window width in pixels

windowheight

Description
Returns the height of the object window when editing/opening an object

Syntax
windowheight ($type="object")

Input parameters

$type ... type [string] (optional)

global input parameters

$mgmt_config

Output

window height in pixels

toggleexplorerview

Description
Set explorer objectlist view parameter

Syntax
toggleexplorerview ($view)

Input parameters

$view ... view [detail, small, medium, large]

global input parameters

$mgmt_config

Output

true / false

toggletaskview

Description
Set task view parameter

Syntax
toggletaskview ($view)

Input parameters

$view ... view [boolean]

global input parameters

$mgmt_config

Output

true / false

togglesidebar

Description
Enables or disables the sidebar

Syntax
togglesidebar ($view)

Input parameters

$view ... view [boolean]

global input parameters

$mgmt_config

Output

true / false

setfilter

Description
Set filter settings for object view in session

Syntax
setfilter ($filter_set)

Input parameters

$filter_set ... set of filters as array with keys [comp, image, document, video, audio] and value [0, 1]

global input parameters

$mgmt_config

Output

true / false

objectfilter

Description
If an object name is passing the filter-test. One or more filters need to be set in the session "hcms_objectfilter".

Syntax
objectfilter ($file)

Input parameters

$file ... file name [string]

global input parameters

$mgmt_config
$hcms_ext

Output

true / false

gettoolbarstyle

Description
Unified style definitions for the standard toolbar

Syntax
gettoolbarstyle ($is_mobile, $height=0, $minwidth=580, $maxheight=100)

Input parameters

$is_mobile ... is mobile edition [boolean]
$height ... height in pixels [integer] (optional)
$minwidth ... min. width in pixels of the toolbar for the desktop [integer] (optional)
$maxheight ... max. height of the toolbar for mobile devices in pixels [integer] (optional)

global input parameters

$mgmt_config

Output

CSS style [string]

getinvertcolortheme

Description
Used for portals in order to get the inverted theme names of the primary and hover colors based on the brightness of the primary and hover background color.

Syntax
getinvertcolortheme ($themename)

Input parameters

$themename ... design theme name for CSS class hcmsToolbarBlock [string]

global input parameters

$mgmt_config

Output

result array with inverted themes names or empty names if an inversion is not required based on the brightness of the background color

invertcolorCSS

Description
Used for portals in order to invert the color of elements.
MS IE does not support invert, MS Edge does.

Syntax
invertcolorCSS ($theme="", $css_selector=".hcmsInvertColor", $default=true, $hover=false, $percentage=100)

Input parameters

$theme ... design theme name for CSS class hcmsToolbarBlock [string] (optional)
$css_selector ... CSS selector for elements [string] (optional)
$default ... use class when no event is triggered [boolean] (optional)
$hover ... use class for hover event [boolean] (optional)
$percentage ... invert percentage value [integer] (optional)

global input parameters

$mgmt_config

Output

CSS code

showdynamicCSS

Description
Creates the styles for the CSS classes hcmsInvertColor, hcmsInvertHoverColor, hcmsInvertPrimaryColor, hcmsFloatLeft, and hcmsButtonLabel based on the colors of the design theme.
This is wrapper function that can be used to create the CSS classes and styles.

Syntax
showdynamicCSS ($hcms_themeinvertcolors, $hcms_hoverinvertcolors, $hcms_mainnavigation="left", $is_mainnavigation=false)

Input parameters

$hcms_themeinvertcolors ... design theme name used for the main color [string]
$hcms_hoverinvertcolors ... design theme name used for the hover color [string]
$hcms_mainnavigation ... main navigation position [left, top] (optional)
$is_mainnavigation ... is main navigation [boolean] (optional)

global input parameters

$mgmt_config

Output

CSS code

showdate

Description
Prepares the date and time for the display in the users time zone and format.

Syntax
showdate ($date, $sourceformat="Y-m-d H:i", $targetformat="Y-m-d H:i", $timezone=true)

Input parameters

$date ... date and time [string
$sourceformat ... date input format [string]
$targetformat ... date output format [string]
$timezone ... correct time zone [boolean] (optional)

global input parameters

$mgmt_config

Output

date and time

showshorttext

Description
Reduce the length of a string and add "..." at the end

Syntax
showshorttext ($text, $length=0, $linebreak=false, $charset="UTF-8")

Input parameters

$text ... text [string]
$length ... max. positive length of text or minus value for the length starting from the end [integer] (optional)
$linebreak ... use max. 3 line breaks instead of cut only if length is positive [boolean] (optional)
$charset ... character set for encoding [string] (optional)

Output

shortened text if possible
or orignal text

showtopbar

Description
Returns the standard top bar with or without close button

Syntax
showtopbar ($show, $lang="en", $close_link="", $close_target="", $individual_button="", $id="bar")

Input parameters

$show ... message [string]
$lang ... language code [string] (optional)
$close_link ... close button link [string] (optional)
$close_target ... link target [string] (optional)
$individual_button ... individual button [string] (optional)
$id ... ID of div-layer [string] (optional)

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang

Output

top bar box / false on error

showtopmenubar

Description
Returns the menu top bar with or without close button

Syntax
showtopmenubar ($show, $menu_array, $lang="en", $close_link="", $close_target="", $id="bar")

Input parameters

$show ... message [string]
$menu_array ... menu [array:name => properties/events]
$lang ... language code [string] (optional)
$close_link ... close button link [string] (optional)
$close_target ... link target [string] (optional)
$id ... ID of div-layer [string] (optional)

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang

Output

top bar box / false on error

showhomeboxes

Description
Returns the file path of the home boxes as array. This function does not directly return the rendered HTML code. Therefore the home boxes need to be included in order to display them.

Syntax
showhomeboxes ($homebox_array)

Input parameters

$homebox_array ... home box names [array:file name => readable name]

global input parameters

$mgmt_config

Output

path to home boxes [array] / false on error

showmessage

Description
Returns the standard message box icluding a close button.
The message box has a specific size.

Syntax
showmessage ($show, $width="580px", $height="80px", $lang="en", $style="", $id="hcms_messageLayer")

Input parameters

$show ... message [string]
$width ... width in pixel [integer] (optional)
$height ... height in pixel [integer] (optional)
$lang ... language code [string] (optional)
$style ... additional style definitions of div-layer [string] (optional)
$id ... ID of div-layer [string] (optional)

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang

Output

message box / false on error

showinfopage

Description
Returns a full html info page.

Syntax
showinfopage ($show, $lang="en", $onload="")

Input parameters

$show ... message [string]
$lang ... language code [string] (optional)
$onload ... on load JS events [string] (optional)

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang_codepage
$hcms_lang
$is_mobile

Output

message on html info page / false on error

showinfobox

Description
Returns the infobox as long as it has not been closed. Saves the close event in localstorage of browser.
The infobox does not have a specific size by default compared to the message box.

Syntax
showinfobox ($show, $lang="en", $style="", $id="")

Input parameters

$show ... message [string]
$lang ... language code [string] (optional)
$style ... additional style definitions of div-layer [string] (optional)
$id ... ID of div-layer [string] (optional)

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang_codepage
$hcms_lang

Output

message in div layer / false on error

showhelpbutton

Description
Returns the help button including the help document functionality.

Syntax
showhelpbutton ($pdf_name, $enabled=true, $lang="en", $id="hcms_helpButton", $css_class="")

Input parameters

$pdf_name ... PDF file name without '_langcode' and file extension [$string]
$enabled ... enabled [boolean] (optional)
$lang ... language code [string] (optional)
$id ... ID of div-layer [string] (optional)
$css_class ... add CSS class name [string] (optional)

global input parameters

$mgmt_config
$hcms_themeinvertcolors
$hcms_lang_codepage
$hcms_lang_shortcut
$hcms_lang

Output

button as img tag

showactionicon

Description
Returns the icon image for an action

Syntax
showactionicon ($action, $lang="en", $style="width:64px; height:64px;", $id="hcms_icon")

Input parameters

$action ... action name [$string]
$lang ... language code [string] (optional)
$style ... CSS style [string] (optional)
$id ... ID of image-layer [string] (optional)

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang_codepage
$hcms_lang

Output

icon as img tag / empty string on error

showsharelinks

Description
Returns the presenation of share links of social media platforms

Syntax
showsharelinks ($site, $location, $page, $mediafile, $lang="en", $style="", $id="hcms_shareLayer")

Input parameters

$site ... publication name [string]
$location ... absolute or relative location path [string]
$page ... object name [string]
$mediafile ... media file name [string]
$lang ... language code [string] (optional)
$style ... additional style definitions of div-layer [string] (optional)
$id ... ID of div-layer [string] (optional)

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang_codepage
$hcms_lang

Output

message in div layer / false on error

showmetadata

Syntax
showmetadata ($data, $lang="en", $class_headline="hcmsRowData2")

Input parameters

$data ... metadata [array]
$lang ... 2 digits language code [string]
$class_headline ... CSS-class with background-color for headlines [string] (optional)

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang_codepage
$hcms_lang

Output

result as HTML unordered list / false on error

showobject

Syntax
showobject ($site, $location, $page, $cat="", $name="")

Input parameters

$site ... publication name [string]
$location ... location [string]
$page ... object name [string]
$cat ... category [page, comp] (optional)
$name ... object name [string] (optional)

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang
$hcms_lang_date
$lang
$user

Output

html presentation / false

showmedia

Description
This function requires site, location and cat to be set as global variable in order to validate the access permission of the user

Syntax
showmedia ($mediafile, $medianame, $viewtype, $id="", $width="", $height="", $class="hcmsImageItem", $recognizefaces_service=false)

Input parameters

$mediafile ... mediafile (publication/filename) [string]
$medianame ... name of mediafile for display [string]
$viewtype ... view type [template, media_only, preview, preview_download, preview_no_rendering]
$id ... ID of the HTML media tag [string]
$width ... width in px [integer] (optional)
$height ... height in px [integer] (optional)
$class ... CSS class [string] (optional)
$recognizefaces_service ... recognize faces service in use [boolean] (optional)

global input parameters

$site
$mgmt_config
$mgmt_mediapreview
$mgmt_mediaoptions
$mgmt_imagepreview
$mgmt_docpreview
$mgmt_docoptions
$mgmt_docconvert
$mgmt_maxsizepreview
$hcms_charset
$hcms_lang_codepage
$hcms_lang_date
$hcms_lang
$lang
$site
$location
$cat
$page
$user
$pageaccess
$compaccess
$downloadformats
$hiddenfolder
$hcms_linking
$setlocalpermission
$mgmt_imageoptions
$is_mobile
$is_iphone

Output

html presentation of any media asset / false

showcompexplorer

Description
Creates the component explorer including the search form and upload function

Syntax
showcompexplorer ($site, $dir, $location_esc="", $page="", $compcat="multi", $search_expression="", $search_format="", $mediatype="", $lang="en", $callback="", $scalingfactor="1", $view="list", $thumbsize=100)

Input parameters

$site ... publication name [string]
$dir ... current explorer location [string]
$location_esc ... object location [string] (optional)
$page ... object name [string] (optional)
$compcat ... component category [single, multi, media] (optional)
$search_expression ... search expression [string] (optional)
$search_format ... search format [object, document, image, video, audio, watermark] (optional)
$mediatype ... media-type [audio, binary, component, compressed, flash, image, text, video, watermark] (optional)
$lang ... view tpye [list, gallery] (optional)
$callback ... thumbnail size in pixel [integer] callback of CKEditor [string] (optional)
$scalingfactor ... saclingfactor for images [integer] (optional)
$view
$thumbsize

global input parameters

$mgmt_config
$siteaccess
$pageaccess
$compaccess
$rootpermission
$globalpermission
$localpermission
$hiddenfolder
$html5file
$temp_complocation
$hcms_charset
$hcms_lang
$user

Output

explorer with search / false on error

showeditor

Description
Returns the rich text editor code

Syntax
showeditor ($site, $hypertagname, $id, $contentbot="", $sizewidth=600, $sizeheight=300, $toolbar="Default", $lang="en", $dpi=72)

Input parameters

$site ... publication name [string]
$hypertagname ... hypertag name [string]
$id ... hypertag id [string]
$contentbot ... content [string]
$sizewidth ... width of the editor [integer]
$sizeheight ... height of the editor [integer]
$toolbar ... toolbar set [string]
$lang ... 2 digit language code [string]
$dpi ... dpi for scaling images [integer]

global input parameters

$mgmt_config
$publ_config

Output

rich text editor code / false on error

showinlineeditor_head

Description
Returns the rich text editor code (JS, CSS) for include into the html head section

Syntax
showinlineeditor_head ($lang)

Input parameters

$lang ... 2 digit language code [string]

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang

Output

rich text editor code for html head section / false on error

showinlinedatepicker_head

Description
Returns the date picker code (JS, CSS) for include into the html head section

Syntax
showinlinedatepicker_head ()

Input parameters

global input parameters

$mgmt_config

Output

date picker code for html head section / false on error

showinlineeditor

Description
shows the rich text inline editor

Syntax
showinlineeditor ($site, $hypertag, $id, $contentbot="", $sizewidth=600, $sizeheight=300, $toolbar="Default", $lang="en", $contenttype="", $cat="", $location_esc="", $page="", $contentfile="", $db_connect=0, $token="")

Input parameters

$site ... publication name [string]
$hypertag ... hypertag [string]
$id ... hypertag id [string]
$contentbot ... content [string]
$sizewidth ... width of the editor [integer]
$sizeheight ... height of the editor [integer]
$toolbar ... toolbar set [string]
$lang ... 2 digit language code [string]
$contenttype ... content-type [string]
$cat ... category [page, comp]
$location_esc ... converted location [string]
$page ... object name [string]
$contentfile ... container name [string]
$db_connect ... DB-connect file name [string]
$token ... security token [string]

global input parameters

$mgmt_config
$publ_config
$hcms_charset
$hcms_lang

Output

rich text editor code / false on error

showvideoplayer

Description
Generates a html segment for the video player code

Syntax
showvideoplayer ($site, $video_array, $width=854, $height=480, $logo_url="", $id="", $title="", $autoplay=true, $fullscreen=true, $loop=false, $muted=false, $controls=true, $iframe=false, $force_reload=false, $cleandomain=false)

Input parameters

$site ... video array containing the different video sources [array]
$video_array ... width of the video in pixel [integer]
$width ... height of the video in pixel [integer]
$height ... link to the logo which is displayed before you click on play (If the value is null the default logo will be used) [string]
$logo_url ... ID of the video (will be generated when empty) [string]
$id ... title for this video [string]
$title ... autoplay video on load (true)
$autoplay ... default is false [boolean]
$fullscreen ... view the video in full screen [boolean]
$loop ... play loop [boolean] (optional)
$muted ... muted/no sound [boolean] (optional)
$controls ... player controls and selectable marker/faces gallery [boolean] (optional)
$iframe ... use video in iframe [boolean] (optional)
$force_reload ... reload video sources to prevent the browser cache to show the same video even if it has been changed [boolean] (optional) remove domain name from the URL of the video sources and poster [boolean] (optional)
$cleandomain

global input parameters

$mgmt_config

Output

HTML code of the video player / false on error

showvideoplayer_head

Syntax
showvideoplayer_head ($secureHref=true, $fullscreen=true, $cleandomain=false)

Input parameters

$secureHref ... secure hyperreferences by adding 'hypercms_' [boolean] (optional)
$fullscreen ... is it possible to view the video in fullScreen [boolean] (optional)
$cleandomain ... remove domain name from URLs [bollean] (optional)

global input parameters

$mgmt_config

Output

head for video player / false on error

showaudioplayer

Description
Generates the html segment for the video player code

Syntax
showaudioplayer ($site, $audioArray, $width=320, $height=320, $logo_url="", $id="", $autoplay=false, $loop=false, $controls=true, $force_reload=false, $cleandomain=false)

Input parameters

$site ... publication name [string]
$audioArray ... audio files [array]
$width ... ID of the tag [string] (optional)
$height ... width of the video in pixel [integer]
$logo_url ... height of the video in pixel [integer]
$id ... link to the logo which is displayed before you click on play (If the value is null the default logo will be used) [string]
$autoplay ... ID of the video (will be generated when empty) [string]
$loop ... autoplay (optional) [boolean]
$controls ... play loop (optional) [boolean]
$force_reload ... player controls (optional) [boolean]
$cleandomain ... remove domain name from source and poster URLs [bollean] (optional)

global input parameters

$mgmt_config

Output

code of the HTML5 player / false

showaudioplayer_head

Syntax
showaudioplayer_head ($secureHref=true, $cleandomain=false)

Input parameters

$secureHref ... secure hyperreferences by adding 'hypercms_' [boolean] (optional)
$cleandomain ... remove domain name from source and poster URLs [bollean] (optional)

global input parameters

$mgmt_config

Output

head for audio player

debug_getbacktracestring

Description
Returns the current backtrace as a good readable string.
Ignores debug and debug_getbacktracestring.

Syntax
debug_getbacktracestring ($valueSeparator, $rowSeparator, $ignoreFunctions=array())

Input parameters

$valueSeparator ... separator for arguments [string]
$rowSeparator ... separator for a row on screen/file [string]
$ignoreFunctions ... functionnames to be ignored [array]

Output

debug message

showAPIdocs

Description
Generates the documentation of an API file.
If you only want to display the main API functions that you would normally be interested in, please use this defintion:
$display_functions = array ("is_folder", "is_emptyfolder", "is_supported", "is_date", "is_document", "is_image", "is_rawimage", "is_video", "is_rawvideo", "is_audio", "is_keyword", "is_mobilebrowser", "is_iOS", "createviewlink", "createportallink", "createaccesslink", "createobjectaccesslink", "createwrapperlink", "createdownloadlink", "createmultiaccesslink", "createmultidownloadlink", "restoremediafile", "downloadobject", "downloadfile", "createpublication", "editpublication", "editpublicationsetting", "deletepublication", "createtemplate", "edittemplate", "deletetemplate, "createportal", "editportal", "deleteportal", "createuser", "edituser", "deleteuser", "creategroup", "editgroup", "deletegroup", "createfolder", "renamefolder", "deletefolder", "createobject", "uploadfile", "createmediaobject", "createmediaobjects", "editmediaobject", "editobject", "renameobject", "deleteobject", "cutobject", "copyobject", "copyconnectedobject", "pasteobject", "lockobject", "unlockobject", "publishobject", "unpublishobject", "createqueueentry", "remoteclient", "savelog", "loadlog", "deletelog", "debuglog", "sendlicensenotification", "sendresetpassword", "createfavorite", "deletefavorite", "load_csv", "create_csv", "sendmessage", "savecontent", "hmtl2pdf", "mergepdf");

Syntax
showAPIdocs ($file, $return="html", $html_hr=true, $html_description=true, $html_input=true, $html_globals=true, $html_output=true, $display_functions=array())

Input parameters

$file ... path to API file [string]
$return ... return result as HTML or array [html, array] (optional)
$html_hr ... use horizontal rule as separator in HTML output [boolean] (optional) display description [boolean] (optional)
$html_description ... display input parameters [boolean] (optional)
$html_input ... display global variables [boolean] (optional)
$html_globals ... display output [boolean] (optional)
$html_output ... display only defined function names [array] (optional)
$display_functions

global input parameters

= array()

Output

HTML output of documentation / false on error

readnavigation

Description
Reads the content from the container and collects information about a single navigation item

Syntax
readnavigation ($site, $docroot, $object, $view="publish", $user="sys")

Input parameters

$site ... publication name [string]
$docroot ... location [string]
$object ... object name [string]
$view ... view name (see view parameters of function buildview) [string] (optional)
$user ... user name [string] (optional)

global input parameters

$mgmt_config
$navi_config

Output

navigation item array / false

createnavigation

Description
Generates an associative array (item => nav-item, sub => array with sub-items).
Example
$navi_config = array();
document root definitions
$navi_config['root_path'] = "%abs_page%/";
$navi_config['root_url'] = "%url_page%/";
HTML / CSS class defintions
$navi_config['attr_ul_top'] = "class=\"nav navbar-nav\"";
$navi_config['attr_ul_dropdown'] = "class=\"dropdown-menu\"";
$navi_config['attr_li_active'] = "class=\"active\"";
$navi_config['attr_li_dropdown'] = "class=\"dropdown\"";
$navi_config['attr_href_dropdown'] = "class=\"dropdown-toggle\" data-toggle=\"dropdown\"";
$navi_config['tag_li'] = "<li %attr_li%><a href=\"%link%\" %attr_href%>%title%</a>%sub%</li>\n";
$navi_config['tag_ul'] = "<ul %attr_ul%>%list%</ul>\n";
Language definitions
Session variable name that holds the language setting
$navi_config['lang_session'] = "langcode";
2nd key = langcode & value = text_id of textnode
$navi_config['lang_text_id']['DE'] = "Titel_DE";
$navi_config['lang_text_id']['EN'] = "Titel_EN";
PermaLink definitions
2nd key = langcode & value = text_id of textnode
$navi_config['permalink_text_id']['DE'] = "PermaLink_DE";
$navi_config['permalink_text_id']['EN'] = "PermaLink_EN";
Hide navigation item (any value or empty) and use sort order (number or empty)
$navi_config['hide_text_id'] = "NavigationHide";
$navi_config['sort_text_id'] = "NavigationSortOrder";
Use only index file of directory as navigation item, e.g. index.html or index.php (Keep empty if all objects of a folder should be included)
$navi_config['index_file'] = "";
$navigation = createnavigation ("%publication%", $navi_config['root_path'], $navi_config['root_url'], "%view%", "%abs_location%/%object%");
echo shownavigation ($navigation);

Syntax
createnavigation ($site, $docroot, $urlroot, $view="publish", $currentobject="", $recursive=true)

Input parameters

$site ... publication name [string]
$docroot ... document root for navigation [string]
$urlroot ... URL root for navigation [string]
$view ... view name (see view parameters of function buildview) [string]
$currentobject ... path to current object [string] (optional)
$recursive ... recursive [boolean] (optional)

global input parameters

$mgmt_config
$navi_config

Output

navigation array / false

shownavigation

Description
display navigation as HTML code.
The following example configures the navigation:
$navi_config = array();
document root definitions:
$navi_config['root_path'] = "%abs_page%/";
$navi_config['root_url'] = "%url_page%/";
HTML / CSS class defintions (names between percentage signs are placeholders):
$navi_config['attr_ul_top'] = "class=\"nav navbar-nav\"";
$navi_config['attr_ul_dropdown'] = "class=\"dropdown-menu\"";
$navi_config['attr_li_active'] = "class=\"active\"";
$navi_config['attr_li_dropdown'] = "class=\"dropdown\"";
$navi_config['attr_href_dropdown'] = "class=\"dropdown-toggle\" data-toggle=\"dropdown\"";
$navi_config['tag_li'] = "<li %attr_li%><a href=\"%link%\" %attr_href%>%title%</a>%sub%</li>\n";
$navi_config['tag_ul'] = "<ul %attr_ul%>%list%</ul>\n";
language definitions
Session variable name that holds the language setting
$navi_config['lang_session'] = "langcode";
note: key = langcode & value = text_id of textnode
$navi_config['lang_text_id']['DE'] = "Titel_DE";
$navi_config['lang_text_id']['EN'] = "Titel_EN";
PermaLink defintions
note: key = langcode & value = text_id of textnode
$navi_config['permalink_text_id']['DE'] = "PermaLink_DE";
$navi_config['permalink_text_id']['EN'] = "PermaLink_EN";
Navigation hide and sort order defintions
$navi_config['hide_text_id'] = "NavigationHide";
$navi_config['sort_text_id'] = "NavigationSortOrder";
Use the first object of a folder for the main navigation item and display all following objects as sub navigation items [boolean]
$navi_config['use_1st_folderitem'] = false;

Syntax
shownavigation ($navigation, $level=1)

Input parameters

$navigation ... navigation (created by function readnavigation) [array]
$level ... level [integer] (optional)

global input parameters

$mgmt_config
$navi_config

Output

navigation HTML presentation / false

showselect

Syntax
showselect ($value_array, $only_text=false, $selected_value="", $id="", $attributes="")

Input parameters

$value_array ... values array (array-key = value
$only_text ... array-value = text) [array]
$selected_value ... use values of array as option value and text [boolean] (optional)
$id ... selected value [string] (optional)
$attributes ... attributes of select tags like name or id or events [string] (optional)

Output

HTML select box presentation / false

showtranslator

Syntax
showtranslator ($site, $id, $type, $charset="UTF-8", $lang="en", $style="")

Input parameters

$site ... publication name [string]
$id ... editor/text-tag ID [string]
$type ... unformatted or formatted texttag-type [u, f]
$charset ... character set [string] (optional)
$lang ... 2 digit language code [string] (optional)
$style ... style of div tag [string] (optional)

global input parameters

$mgmt_config
$hcms_lang

Output

HTML translator box presentation / false

showmapping

Description
Present the mapping form of the provided publication.

Syntax
showmapping ($site, $lang="en")

Input parameters

$site ... publication name [string]
$lang ... 2 digit language code [string] (optional)

global input parameters

$mgmt_config
$hcms_charset
$hcms_lang

Output

table with form fields for display / false

showgallery

Description
Presents all objects in a gallery with their thumbnails.

Syntax
showgallery ($multiobject, $thumbsize=100, $openlink="download", $user="sys")

Input parameters

$multiobject ... multiobjects represented by their path or object ID [array]
$thumbsize ... thumbnail size in pixels [integer] (optional)
$openlink ... open or download object on click [open, download] (optional)
$user ... user name [string] (optional)

global input parameters

$mgmt_config
$pageaccess
$compaccess
$hiddenfolder
$hcms_linking
$globalpermission
$setlocalpermission
$hcms_lang
$lang

Output

gallery view / false

showthumbnail

Description
Presents the thumbnail of a single media file that is optionally base64 encoded an can be embedded in HTML pages or e-mails.

Syntax
showthumbnail ($site, $mediafile, $name="", $thumbsize=120, $base64=false, $style="", $theme="standard")

Input parameters

$site ... publication name [string]
$mediafile ... media file name [string]
$name ... display name [string] (optional)
$thumbsize ... thumbnail size in pixels [integer] (optional)
$base64 ... base64 encoding [boolean] (optional)
$style ... CSS style for image [string] (optional) design theme name for icons [string] (optional)
$theme

global input parameters

$mgmt_config

Output

thumbnail view / false

showtaxonomytree

Description
Displays the requested taxonomy tree structure or sub branch with checkboxes for the keywords.

Syntax
showtaxonomytree ($site="", $container_id=array(), $text_id="", $tagname="textk", $taxonomy_lang="en", $expression="", $width=600, $height=500, $charset="UTF-8")

Input parameters

$site ... publication name [string] (optional)
$container_id ... container ID [integer][array]
$text_id ... text ID [string]
$tagname ... language code [string] (optional)
$taxonomy_lang ... taxonomy ID or expression or taxonomy path in the form %taxonomy%/publication-name or %taxonomy%/default/language-code/taxonomy-ID/taxonomy-child-levels [string]
$expression ... width in pixel [integer] (optional)
$width ... height in pixel [integer] (optional)
$height ... character set [string] (optional)
$charset

global input parameters

$mgmt_config
$hcms_lang
$lang
$taxonomy

Output

taxonomy tree view / false

showworkflowstatus

Description
Displays the workflow status information table.

Syntax
showworkflowstatus ($site, $location, $page)

Input parameters

$site ... publication name [string]
$location ... location path [string]
$page ... object name [string]

global input parameters

$mgmt_config
$publ_config
$hcms_charset
$hcms_lang
$lang
$user

Output

workflow status view / false