tag_name

Saurus API Cheat Sheet parameter parameter description

Global variables, general init, sysword, custom configuration, trail, language, section attribute attribute description
global variables init_*
$id ID number of active object name variable name where the result is returned
$title title of the website id object ID
$meta_keywords meta keywords of the website title title of the object
$meta_description meta description of the website buttons action-buttons for section editing
$encoding encoding of the current language created_user_id user ID who initially created the object
$lang abbreviation of current website language created_user_name user full name who initially created the object
$protocol protocol value from site configuration settings changed_user_id user ID who made the last object saving
$hostname website hostname changed_user_name user full name who made the last object saving
$wwwroot website root folder created_time creating time of the object in format dd.mm.yyyy hh:ii
$current_level current level in site hierarchy (level of the section) fcreated_time creating time of the object in database default format
$current_class class name of current active object, class names here and changed_time last saving time of the object in format dd.mm.yyyy hh:ii
other places are: section, article, link, image, comment, poll, fchanged_time last saving time of the object in database default format
document, article's list, link list, login-box, subject, album, comment_count the number of comments
iframe-box, event, asset, productcategory last_commented_time the last comment time in format dd.mm.yyyy hh:ii
$tpl ID number of the current SAPI page template <name>_newbutton prints "New" action-button for creating a new object
$c_tpl ID number of the current SAPI content template <name>_count the number of returned objects
$page_tpl name of the current SAPI page template <name>_counttotal total number of objects found, not affected by "limit" parameter
$content_tpl name of the current SAPI content template
init_section
$in_editor value 1 if user is in the editor environment
level level from where to get sections
$user value 1 if registered user is logged in
parent object ID (section)
$userdata->all array of the currently logged in user data
position location of objects on the page
$EXTENSION_NAME array of the extension's configuration data
start the starting row number to return
sysword limit the number of rows to return
name buttons which action buttons are displayed to the site editor
word unique identifying string of the system word on_create allows to publish all objects immediately if set to "publish"
type word group (category) classes object types to display (comma separated list)
show_missing show original system word even if the translation is missing order sorting order
href link to the section
init_language is_selected value is 1 if section is active (selected)
href link to the language changing page class class name of the object
name language full name
extension abbreviation of language custom_conf_save
id object ID id object ID (section)
home_id home section ID <parameter1> custom parameter name
<parameter2> custom parameter name
init_trail ...
id object ID
href link to the object custom_conf_load
title title of the object id object ID (section)
hide_in_menu 1 if object is hidden in menu
 tag_name
Saurus API Cheat Sheet parameter parameter description
Objects, articles, assets attribute attribute description

init_objects init_articles
level level from where to get sections parent object ID (section)
parent object ID (section) position location of objects on the page
position location of objects on the page start the starting row number to return
start the starting row number to return limit the number of rows to return
limit the number of rows to return buttons which action buttons are displayed to the site editor
buttons which action buttons are displayed to the site editor on_create allows to publish all objects immediately if set to "publish"
on_create allows to publish all objects immediately if set to "publish" start_date defines starting date of the article list. Format dd.mm.yyyy
classes object types to display (comma separated list) end_date defines end date of the article list. Format dd.mm.yyyy
where additional filtering criteria using WHERE SQL syntax profile defines the profile(s) of the articles
select additional table fields to return using SELECT SQL syntax select additional table fields to return using SELECT SQL syntax
group grouping using GROUP BY SQL syntax where additional filtering criteria using WHERE SQL syntax
order sorting order classes object types to display (comma separated list)
href link to detailed view order sorting order
is_selected value is 1 if section is active (selected) href link to the section
class class name of the object is_selected value is 1 if section is active (selected)
class class name of the object
init_object
id object ID
buttons which action buttons are displayed to the site editor init_article
href link to detailed view id object ID
is_selected value is 1 if section is active (selected) buttons which action buttons are displayed to the site editor
buttons action-buttons for section editing on_create allows to publish all objects immediately if set to "publish"
class class name of the object system_message alias of the system article to return
href link to the article
init_assets is_selected value is 1 if section is active (selected)
parent object ID (section) buttons action-buttons for section editing
position location of objects on the page lead lead part of the article
start the starting row number to return body body part of the article
limit the number of rows to return date date of the article
profile defines the profile(s) of the articles fdate date of the article in database default format
select additional table fields to return using SELECT SQL syntax comment_count the number of comments in comment board
where additional filtering criteria using WHERE SQL syntax forum_allowed value is 1 if forum is allowed for the article
contains search string, allows search from all asset fields as %string% show_headline value is 1 if headline is visible for the article
fields defines which fields are included in the assets' list author author of the article
order sorting order <attribute> returns data field value of the profile
<attribute> the specific data field of the custom asset type
profile_data the array of the attributes
 tag_name
Saurus API Cheat Sheet parameter parameter description
Folders and files, documents attribute attribute description

init_folders init_documents
name parent object ID (section)
parent object ID (folder) start the starting row number to return
order parent folder name where to get the folders limit the number of rows to return
id object ID buttons which action buttons are displayed to the site editor
parent object ID (folder) on_create allows to publish all objects immediately if set to "publish"
title title of the folder where additional filtering criteria using WHERE SQL syntax
fullpath absolute path to the folder position location of objects on the page
file_count the number of files in the folder order sorting order
parent object ID (section)
init_files is_selected value is 1 if document is active (selected)
parent object ID (folder) date date of the file
start the starting row number to return details_link hyperlink of the detailed view of the document
limit the number of rows to return download_link hyperlink for downloading the document
buttons which action buttons are displayed to the site editor filename name of the document
select additional table fields to return using SELECT SQL syntax description description of the document
where additional filtering criteria using WHERE SQL syntax size size of the document in bytes
icons relative path to the icons folder size_formatted formatted size of the document in bytes
profile defines the profile(s) of the articles author author of the document
order sorting order mimetype MIME type of the file
href link to the file
parent parent folder ID init_document
folder_fullpath absolute path to the parent folder id object ID (section)
fullpath absolute path to the file, including filename buttons which action buttons are displayed to the site editor
filename filename on_create allows to publish all objects immediately if set to "publish"
mimetype MIME type of the file parent object ID (section)
profile_id profile ID of the file is_selected value is 1 if document is active (selected)
icon relative path to file type icon class class name of the object
class class name of the object date date of the file
date date of the file download_link link for downloading the document
fdate date of the file in database default format filename name of the document
extension extension of the filename description description of the document
size size of the document in bytes
sync_folders size_formatted formatted size of the document in bytes
id folder ID or album ID author author of the document
path relative path of the folder to synchronise mimetype MIME type of the file
 tag_name
Saurus API Cheat Sheet parameter parameter description
Forum, comments, search, favorites attribute attribute description

init_subjects init_message
id object ID (section) id object ID (forum message)
start the starting row number to return on_create allows to publish all objects immediately if set to "publish"
limit the number of rows to return class class name of the object
on_create allows to publish all objects immediately if set to "publish" parent_href link to the upper level
parent object ID (section) body body text of the message
class class name of the object date date of the message
detail_href link to detailed view author author of the message
parent_href link to the upper level author_email e-mail of the message's author
message_count the number of messages in current subject message_replies the number of replies to the message
started date of creation of current subject message_count the number of messages in current subject
last_message date of last message in current subject parent_subject message's parent subject
parent_subject_id ID of the message's parent subject
init_messages parent_subject_title title of the message's parent subject
parent object ID (section, forum thread) parent_section message's parent
start the starting row number to return parent_section_id ID of the message's parent
limit the number of rows to return parent_section_title title of the message's parent
order sorting order started date of creation of current subject
on_create allows to publish all objects immediately if set to "publish" last_message date of last message in current subject
parent object ID (section)
class class name of the object init_search_results
detail_href link to detailed view classes defines the object classes
parent_href link to the upper level start the starting row number to return
body body text of the message limit the number of rows to return
date date of the message title class title of the object (translated)
author author of the message name class name of the object
author_email e-mail of the message's author count the number of returned objects in that class
message_replies the number of replies to the message counttotal total number of objects found, not affected by "limit" parameter
message_count the number of messages in current subject results array of search results
started date of creation of current subject each result has the following:
last_message date of last message in current subject id the ID number of the object
title title of the object
init_favorites href link to detailed view
classes object types to display (comma separated list) class class name of the object
order sorting order excerpt excerpt from an article
id object ID
href link to the object
title title of the object
icon relative path to the favorite icon file
all array of all object's general data
 tag_name
Saurus API Cheat Sheet parameter parameter description
Gallery, events, mailinglist attribute attribute description

init_albums init_picture
parent object ID (section) id object ID (picture)
position location of objects on the page buttons which action buttons are displayed to the site editor
start the starting row number to return on_create allows to publish all objects immediately if set to "publish"
limit the number of rows to return album_href ID number of the album where this picture belongs
buttons which action buttons are displayed to the site editor thumbnail thumbnail of the image
on_create allows to publish all objects immediately if set to "publish" image_height image height in pixels, only for filesystem-based album
thumbnail_type how an intro-thumbnail image is chosen (first, random) image_width image width in pixels, only for filesystem-based album
order sorting order <name>_source html-tags to display the picture
href link to detailed view <name>_thumbnail html-tags to display the picture thumbnail
is_selected value is 1 if section is active (selected) <name>_next ID number of the next picture in the album
description description of the album <name>_previous ID number of the previous picture in the album
thumbnail relative path to the first/random thumbnail image in album
thumbnail_size size of thumbnail images, in pixels init_events
image_size size of images, in pixels parent object ID (section)
folder_id images source folder position location of objects on the page
folder_path images source folder path start the starting row number to return
class class name of the object limit the number of rows to return
start_time return from date, format dd.mm.yyyy
init_images end_time return before date, format dd.mm.yyyy
parent object ID (album) user list of users to display
start the starting row number to return buttons which action buttons are displayed to the site editor
limit the number of rows to return on_create allows to publish all objects immediately if set to "publish"
where additional filtering criteria using WHERE SQL syntax where additional filtering criteria using WHERE SQL syntax
size size of the displayed image in bytes order sorting order
actual_image_size size of the original image in bytes href link to detailed view
filename filename of the image is_selected value is 1 if section is active (selected)
thumb_path relative path to the thumbnail image start_date start date of the event in format dd.mm.yyyy
thumb_height height of the thumbnail image in pixels start_time start time of the event in format hh:mm
thumb_width width of the thumbnail image in pixels start_date_long start date of the event in format dd. month yyyy
image_path relative path to the image end_date end date of the event in format dd.mm.yyyy
image_height height of the image in pixels end_time end time of the event in format hh:mm
image_width width of the image in pixels end_date_long end date of the event in format dd. month yyyy
actual_image_path relative path to the original image description description of the album
actual_image_height height of the original image in pixels
actual_image_width width of the original image in pixels init_mailinglist
<name>_first_image relative path to the first image in the album name_separator string that separates the section name in the full section path
title class title of the object (translated)
<name>_last_image relative path to the first image in the album
user_subscribed if the currently logged in user is subscribed (1) or not (0)