Symbols Documentation

Here we have a documentation view of Magic Data symbols currently installed on this site. This list is by no means complete because there are more addons providing Magic Data symbols that are not installed on this site!

end_​comment */

Package:
Magic Data
Symbol handle:
end_​comment
Description:
End a comment. Use this to end a comment. If used out of context, just does nothing.

comment /*

Package:
Magic Data
Symbol handle:
comment
Description:
Start a comment. Following symbols are ignored until the symbol */ is encountered or the token ends. Any previous result is returned. For example: 'Administrators AS_​GROUP /* we have just extracted a list of the administrators group */ LIST_​USERS 10 APPLY_​EACH EMAIL AS_​LINK END_​APPLY_​EACH HTML_​OL'. IMPORTANT Be sure to separate this symbol from adjacent symbols with a white space!

add +

Package:
Magic Data Symbols1
Symbol handle:
add
Description:
Adds two numbers. Takes the previous result as a number and adds the following number. For example: 'SET "10" + "1" .'.

ADD_​CURRENT_​USER_​TO_​GROUP

Package:
Black Magic Data
Symbol handle:
add_​current_​user_​to_​group
Description:
Adds the current user to a group. Taking the result of preceding symbols as a user group, adds the current user to the group. For example: 'SET "Editors" AS_​GROUP ADD_​CURRENT_​USER_​TO_​GROUP'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

ADD_​FILE_​TO_​SET

Package:
Black Magic Data
Symbol handle:
add_​file_​to_​set
Description:
Add a file to a fileset. Using the result of preceding symbols as file and a following parameters as a file set, adds the file to the set. Returns the file id. For example: 'SET "europe_​valencia_​hemispheric.jpg" AS_​FILE ADD_​FILE_​TO_​SET ( SET "Banners" AS_​FILESET )'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

ADD_​TEMPLATE_​CLASS

Package:
Magic Data Templates1
Symbol handle:
add_​template_​class
Description:
Add a class for a magic data template Takes the preceding result as a class, adding it to the list of classes for a magic data template. Returns the currently accumulated classes as an html class attribute. An optional following parameter can be used to set a template key and defaults to outer. The template key can be any one of inner, outer, all_​list_​inner, all_​list_​outer. For example: 'SET "my_​outer_​class" ADD_​TEMPLATE_​CLASS SET "my_​inner_​class" ADD_​TEMPLATE_​CLASS "inner"'.

ADD_​TEMPLATE_​STYLE

Package:
Magic Data Templates1
Symbol handle:
add_​template_​style
Description:
Add a style for a magic template Takes the preceding result as the value of the style and the following parameter as the name of the style, adding them to the list of styles for a magic data template. Returns the currently accumulated styles as an html style attribute. A further optional following parameter can be used to set a template key and defaults to outer. The template key can be any one of inner, outer, all_​list_​inner, all_​list_​outer. For example: 'SET "pink" ADD_​TEMPLATE_​STYLE "background_​color" SET "10px" ADD_​TEMPLATE_​STYLE "margin" "inner" SET "green 1px solid" ADD_​TEMPLATE_​STYLE "border" "inner"'.

ADD_​TO_​CART_​BUTTON

Package:
Magic Data Commerce
Symbol handle:
add_​to_​cart_​button
Description:
Add to cart button for a product Taking the result of preceding symbols as a Product ID, returns html for an add to cart button. The immediately following parameter must be the label for the button. A further optional following parameter may give a quantity. For example: 'SET 'ruddy duck' AS_​PRODUCT ADD_​TO_​CART_​BUTTON "Instant Purchase" 1 '.

ADD_​USER_​TO_​GROUP

Package:
Black Magic Data
Symbol handle:
add_​user_​to_​group
Description:
Adds a user to a group. The result of preceding symbols and the immediately following parameter should identify a user and a group, or a group and a user. The user is then added to the group. For example: 'SET "Editors" AS_​GROUP ADD_​USER_​TO_​GROUP ( SET 'JohntheFish' AS_​USER ) For example: 'SET "JohntheFish" AS_​USER ADD_​USER_​TO_​GROUP ( SET 'Editors' AS_​GROUP ) '. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

AND_​EXCLUDE

Package:
Uber List
Symbol handle:
and_​exclude
Description:
Specify an exclusion filter for a list symbol. Applied as part of any LIST_​ALL_​xxxx_​WITH_​FILTER or LIST_​ALL_​xxxx_​WITH_​FILTER_​CONTAINING, this symbol can be used to specify further pairs of parameters to exclude from the list. For example: 'SET 1 LIST_​ALL_​PAGES_​WITH_​FILTER "my_​attibute_​name" "required_​attribute_​value" AND_​EXCLUDE "my_​other_​attibute_​name" "unwanted_​attribute_​value" 20 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​UL' Filters can be any attribute name that is in the search index. Some lists also support "Keywords", "Tags", "Owner", "Name", "Group", "Path", "Published After" as filters. Please check the debug trace in the symbol tester for error messages to confirm a filter is supported.

AND_​EXCLUDE_​CONTAINING

Package:
Uber List
Symbol handle:
and_​exclude_​containing
Description:
Specify a loose exclusion filter for a list symbol. Applied as part of any LIST_​ALL_​xxxx_​WITH_​FILTER or LIST_​ALL_​xxxx_​WITH_​FILTER_​CONTAINING, this symbol can be used to specify further pairs of parameters to loosely exclude from the list. For example: 'SET 1 LIST_​ALL_​PAGES_​WITH_​FILTER "my_​attibute_​name" "required_​attribute_​value" AND_​EXCLUDE_​CONTAINING "my_​other_​attibute_​name" "unwanted_​attribute_​value" 20 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​UL' Filters can be any attribute name that is in the search index. Some lists also support "Keywords", "Tags", "Owner", "Name", "Group", "Path", "Published After" as filters. Please check the debug trace in the symbol tester for error messages to confirm a filter is supported.

AND_​EXCLUDE_​REGEX

Package:
Uber List
Symbol handle:
and_​exclude_​regex
Description:
Specify an additional regular expression exclusion filter for a list symbol. Applied as part of any LIST_​ALL_​xxxx_​WITH_​FILTER or LIST_​ALL_​xxxx_​WITH_​FILTER_​CONTAINING, can be used to specify further regular expression parameters to exclude from the list by. For example: 'SET 1 LIST_​ALL_​PAGES_​WITH_​FILTER "my_​attibute_​name" "required_​attribute_​value" AND_​EXCLUDE_​REGEX "my_​other_​attibute_​name" "value1|value2|value3" 20 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​UL' Filters can be any attribute name that is in the search index. Regular expressions follow the MySQL REGEXP documentation. Some lists also support "Keywords", "Tags", "Owner", "Name", "Group", "Path", "Published After" as filters. Please check the debug trace in the symbol tester for error messages to confirm a filter is supported.

AND_​SORT_​BY

Package:
Uber List
Symbol handle:
and_​sort_​by
Description:
Specify sorting for a list symbol. Applied as part of any LIST_​ALL_​xxxx_​WITH_​FILTER or LIST_​ALL_​xxxx_​WITH_​FILTER_​CONTAINING, this symbol can be used to specify a sorting condition. For example: 'SET 1 LIST_​ALL_​PAGES_​WITH_​FILTER "my_​attibute_​name" "required_​attribute_​value" AND_​SORT_​BY "my_​other_​attibute_​name" "forward" 20 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​UL' Sorting can be by keywords specific to the type of list or by any attribute name that is in the search index. The direction must be specified as "Forward" or "Reverse".

AND_​WITH_​FILTER

Package:
Uber List
Symbol handle:
and_​with_​filter
Description:
Specify an additional filter for a list symbol. Applied as part of any LIST_​ALL_​xxxx_​WITH_​FILTER or LIST_​ALL_​xxxx_​WITH_​FILTER_​CONTAINING, can be used to specify further pairs of parameters to filter the list by. For example: 'SET 1 LIST_​ALL_​PAGES_​WITH_​FILTER "my_​attibute_​name" "required_​attribute_​value" AND_​WITH_​FILTER "my_​other_​attibute_​name" "another_​required_​attribute_​value" 20 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​UL' Filters can be any attribute name that is in the search index. Some lists also support "Keywords", "Tags", "Owner", "Name", "Group", "Path", "Published After" as filters. Please check the debug trace in the symbol tester for error messages to confirm a filter is supported.

AND_​WITH_​FILTER_​CONTAINING

Package:
Uber List
Symbol handle:
and_​with_​filter_​containing
Description:
Specify an additional loose filter for a list symbol. Applied as part of any LIST_​ALL_​xxxx_​WITH_​FILTER or LIST_​ALL_​xxxx_​WITH_​FILTER_​CONTAINING, can be used to specify further pairs of parameters to loosely filter the list by. For example: 'SET 1 LIST_​ALL_​PAGES_​WITH_​FILTER "my_​attibute_​name" "required_​attribute_​value" AND_​WITH_​FILTER_​CONTAINING "my_​other_​attibute_​name" "part_​of_​another_​required_​attribute_​value" 100 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​UL' Filters can be any attribute name that is in the search index. Some lists also support "Keywords", "Tags", "Owner", "Name", "Group", "Path", "Published After" as filters. Please check the debug trace in the symbol tester for error messages to confirm a filter is supported.

AND_​WITH_​REGEX

Package:
Uber List
Symbol handle:
and_​with_​regex
Description:
Specify an additional regular expression filter for a list symbol. Applied as part of any LIST_​ALL_​xxxx_​WITH_​FILTER or LIST_​ALL_​xxxx_​WITH_​FILTER_​CONTAINING, can be used to specify further regular expression parameters to filter the list by. For example: 'SET 1 LIST_​ALL_​PAGES_​WITH_​FILTER "my_​attibute_​name" "required_​attribute_​value" AND_​WITH_​REGEX "my_​other_​attibute_​name" "value1|value2|value3" 20 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​UL' Filters can be any attribute name that is in the search index. Regular expressions follow the MySQL REGEXP documentation. Some lists also support "Keywords", "Tags", "Owner", "Name", "Group", "Path", "Published After" as filters. Please check the debug trace in the symbol tester for error messages to confirm a filter is supported.

API_​EVALUATE

Package:
Black Magic Data
Symbol handle:
api_​evaluate
Description:
Following symbol evaluation is sent to a remote API. Takes the previous result and all following symbols up until END_​USE_​API and passes evaluation of those symbols to the currently set API server. For example: 'SET 'remote_​name' AS_​API_​SERVER WITH_​API_​SERVER SET 'home' API_​EVALUATE AS_​PAGE LIST_​ALL_​PAGES 10 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH API_​EVALUATE_​END'.

API_​EVALUATE_​END

Package:
Black Magic Data
Symbol handle:
api_​evaluate_​end
Description:
Ends an API_​EVALUATE section. Use this to end a list of symbols that follows an API_​EVALUATE symbol. If used out of context, just does nothing.

API_​EVALUATE_​EXTENDED

Package:
Black Magic Data
Symbol handle:
api_​evaluate_​extended
Description:
Following symbol evaluation is sent to a remote API. Similar to API_​EVALUATE, but also passes any Magic Data memories to the API server. NOTE Memory content may not make sense in the context of the server site.

API_​SERVER_​URL

Package:
Black Magic Data
Symbol handle:
api_​server_​url
Description:
Returns the URL for an API server. Takes the previous result as an API server and retuirns the URL for that server. For example: 'SET 'remote_​name' AS_​API_​SERVER API_​SERVER_​URL'.

APPEND

Package:
Magic Data Symbols1
Symbol handle:
append
Description:
Join two lists together. Takes the previous result as a list or single item and the following parameter as a list or single item and concatenates them into a single list. The context remains that of the preceding list. This differs from MERGE in that duplicates and null entries are not removed. For example: 'SET "A,B,C,D" AS_​LIST "," APPEND ( SET "B,C,D,E" AS_​LIST "," ) HTML_​OL '. Compare this to: 'SET "A,B,C,D" AS_​LIST "," MERGE ( SET "B,C,D,E" AS_​LIST "," ) HTML_​OL '.

APPEND_​FILE_​WITH

Package:
Black Magic Data
Symbol handle:
append_​file_​with
Description:
Append to a file. Using the result of preceding symbols to identify a file, appends the file with the following parameter and returns the file ID. For example: 'SET "output_​file.txt" AS_​FILE APPEND_​FILE_​WITH "some text" '. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

APPEND_​INTO

Package:
Magic Data Symbols1
Symbol handle:
append_​into
Description:
Append a list into a memory. Takes the previous result as a list or single item and appends it into a memory specified by the following parameter. The context remains that of the preceding list and the resulting list is returned. Memory storage is transient, lasting only while the page is rendering. This differs from MERGE_​INTO in that duplicates and null entries are not removed. For example: 'SET "A,B,C,D" AS_​LIST "," SAVE m1 SET "B,C,D,E" AS_​LIST "," APPEND_​INTO m1 HTML_​OL '.

APPEND_​TO_​FILE

Package:
Black Magic Data
Symbol handle:
append_​to_​file
Description:
Append to a file. Takes the result of preceding symbols as text and the following parameter as a file, appending the text to the file and returning the file ID. For example: 'SET "some text" APPEND_​TO_​FILE ( SET "output_​file.txt" AS_​FILE )'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

APPLY_​EACH

Package:
Magic Data Symbols1
Symbol handle:
apply_​each
Description:
Applies the following symbols to each element of a list. Takes the previous result as a list and applies the subexpression of following symbols to each element of the list. Continues until the end of a token or until the symbol END_​APPLY_​EACH is encountered. If the list is empty, nothing is processed and null is returned. For example: 'Administrators AS_​GROUP LIST_​USERS 10 APPLY_​EACH EMAIL AS_​LINK END_​APPLY_​EACH HTML_​OL'.

APPLY_​SNIPPET

Package:
Magic Data Symbols1
Symbol handle:
apply_​snippet
Description:
Applies a snippet of Magic Data. The following parameter should specify the name of the Magic Data snippet. That subexpression from the snippet will be applied to the result of preceding symbols. For example: 'SET "About" AS_​PAGE APPLY_​SNIPPET "my snippet name"'

APPLY_​SNIPPET_​FILE

Package:
Magic Data Symbols1
Symbol handle:
apply_​snippet_​file
Description:
Applies a snippet of Magic Data loaded from a file. The following parameter should specify a text file by fID containing a snippet of Magic Data. That Magic Data subexpression will be applied to the result of preceding symbols. For example: 'SET "About" AS_​PAGE APPLY_​SNIPPET_​FILE ( SET "my_​snippet_​name.txt" AS_​FILE )'

APPROVE_​PAGE

Package:
Black Magic Data
Symbol handle:
approve_​page
Description:
Approve the latest version of a page. Takes the result of preceding symbols as a page and approves the most recent version of the page. The following parameter is used as a version comment. For example: 'SET "about" AS_​PAGE APPROVE_​PAGE "I just approved it!"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

AS_​API_​SERVER

Package:
Black Magic Data
Symbol handle:
as_​api_​server
Description:
Identifies an API server. Identifies the previous result as an API server and remembers that as the current server. Returns the server and sets the context as API Server. For example: 'SET 'remote_​name' AS_​API_​SERVER'.

AS_​AREA

Package:
Universal Content Puller Sources1
Symbol handle:
as_​area
Description:
Confirms an area name Tries to find the result of preceding symbols as a regular area name (so can be used to validate a an area name), returning the area name or null. Sets the context as 'Page Area' or null. For example: 'SET "Main" AS_​AREA'.

AS_​BLOCK_​TYPE

Package:
Magic Data Developer
Symbol handle:
as_​block_​type
Description:
Get an installed block type by handle, id or name Tries to find the result of preceding symbols as a an installed block type by handle or ID, returning the item. The context will be 'Block' or null.

AS_​C5_​USER

Package:
Magic Data Developer
Symbol handle:
as_​c5_​user
Description:
Get a user from concrete5.org by id Tries to find the result of preceding symbols as a concrete5.org user ID, returning the user. The context will be 'C5User' or null.

AS_​COUNTRY

Package:
Country State Manager
Symbol handle:
as_​country
Description:
Identifies a country and sets the context Given a country, identifies the country and returns the appropriate country code. For example: 'LIST_​COUNTRIES 200 APPLY_​EACH COUNTRY_​NAME END_​APPLY_​EACH HTML_​OL'.

AS_​DATE

Package:
Magic Data Symbols1
Symbol handle:
as_​date
Description:
Synonym for DATE Uses the result of preceding symbols as a time and translates it into a formatted date according to the following symbol. If the following symbol can be found as a constant, uses that as the format. Otherwise uses the following symbol as a date format string. If the format string contains %, then translates it using strftime(), otherwise translates it using date(). Sets the context as 'Date' or null. For example: 'TIME DATE "d M Y"'. 'UID PREVIOUS_​LOGIN DATE DATE_​APP_​GENERIC_​MDYT_​FULL'.

AS_​FID

Package:
Magic Data Symbols1
Symbol handle:
as_​fid
Description:
Synonym for AS_​FILE Tries to find the result of preceding symbols as a File name or ID, returning a File ID or null. WARNING A file name may not be unique, in which case the most recent file will be returned.. The context will be 'File' or null.

AS_​FILE

Package:
Magic Data Symbols1
Symbol handle:
as_​file
Description:
Get a File ID from a file name Tries to find the result of preceding symbols as a File name or ID, returning a File ID or null. WARNING A file name may not be unique, in which case the most recent file will be returned.. The context will be 'File' or null.

AS_​FILESET

Package:
Magic Data Symbols1
Symbol handle:
as_​fileset
Description:
Synonym for AS_​FSID Tries to find the result of preceding symbols as a Fileset name or ID, returning a Fileset ID or null. The context will be 'Fileset' or null.

AS_​FILESET_​FOR_​UID

Package:
Black Magic Data
Symbol handle:
as_​fileset_​for_​uid
Description:
Identifies a fileset suffixed with the id for a specified user. Tries to find the result of preceding symbols as a fileset name and the following parameter as a user, returning the fileset ID or null. For example: 'SET "Special Files" AS_​FILESET_​FOR_​UID ( SET "JohntheFish" AS_​USER ) FILESET_​NAME'.

AS_​FILESET_​WITH_​UID

Package:
Black Magic Data
Symbol handle:
as_​fileset_​with_​uid
Description:
Identifies a fileset suffixed with the current user id. Tries to find the result of preceding symbols as a fileset name with the added suffix of the user ID, to ensure a fileset name unique to the user. Returns the fileset ID or null. For example: 'SET "Special Files" AS_​FILESET_​WITH_​UID'.

AS_​FORM

Package:
Magic Data Forms
Symbol handle:
as_​form
Description:
Sets a form. Takes the result of previous symbols as a form name and sets the current form. Sets the context as 'Form' . For example: 'SET "Core Form" AS_​FORM_​INTERFACE WITH_​FORM_​INTERFACE SET "Contact Us" AS_​FORM WITH_​FORM LIST_​FORM_​RESPONSES 10'

AS_​FORM_​FIELD

Package:
Magic Data Forms
Symbol handle:
as_​form_​field
Description:
Sets a field for use in following symbols. Matches a question against those available in a form and returns the exact field in context. For example: 'SET 'core_​form' WITH_​FORM_​INTERFACE SET "Contact Us" WITH_​FORM SET "email" AS_​FORM_​FIELD'

AS_​FORM_​INTERFACE

Package:
Magic Data Forms
Symbol handle:
as_​form_​interface
Description:
Identifies and sets a form interface. Takes the result of previous symbols as a form interface handle, name or package, and resolves that as a form interface handle to set the current form interface. Sets the context to 'Form Interface'. For example: 'SET 'Core Form' AS_​FORM_​INTERFACE'

AS_​FSID

Package:
Magic Data Symbols1
Symbol handle:
as_​fsid
Description:
Get a Fileset ID from a fileset name Tries to find the result of preceding symbols as a Fileset name or ID, returning a Fileset ID or null. The context will be 'Fileset' or null.

AS_​GID

Package:
Magic Data Symbols1
Symbol handle:
as_​gid
Description:
Get a user Group ID from a group name Tries to find the result of preceding symbols as a Group name or ID, returning a Group ID or null. The context will be 'Group' or null.

AS_​GLOBAL_​AREA

Package:
Universal Content Puller
Symbol handle:
as_​global_​area
Description:
Get a Global Area ID from a name or ID Tries to find the result of preceding symbols as a Global Area name or ID (so can be used to validate a Global Area ID), returning a Global Area ID or null. Sets the context as 'Global Area' or null. For example: 'SET "Header Nav" AS_​GLOBAL_​AREA GLOBAL_​AREA_​NAME'.

AS_​GROUP

Package:
Magic Data Symbols1
Symbol handle:
as_​group
Description:
Synonym for AS_​GID Tries to find the result of preceding symbols as a Group name or ID, returning a Group ID or null. The context will be 'Group' or null.

AS_​INSTALLED_​PACKAGE

Package:
Magic Data Developer
Symbol handle:
as_​installed_​package
Description:
Get an installed package by handle, id or name Tries to find the result of preceding symbols as a an installed package by package handle or ID, returning the item. The context will be 'InstalledPackage' or null.

AS_​IP

Package:
Magic Data Symbols1
Symbol handle:
as_​ip
Description:
Confirm an IP address Confirms the result of preceding symbols as an IP address, returning the IP address or null. The context will be 'IP' or null.

AS_​LIST

Package:
Magic Data Symbols1
Symbol handle:
as_​list
Description:
Turns a textual list into a list of items Takes the result of preceding symbols as a textual list and the next parameter as a list separator and splits the text into a Magic Data list, trimming white space from each item. If not given, the separator defaults to ','. For example: 'SET "About,Blog,Contact Us" AS_​LIST CONTEXT Page APPLY_​EACH AS_​PAGE PAGE_​LINK END_​APPLY_​EACH HTML_​OL'.

AS_​MAIL_​BCC

Package:
Black Magic Data
Symbol handle:
as_​mail_​bcc
Description:
Set an email "bcc" address. Takes an email address and adds it to the "mail bcc" address list. For example: 'USER EMAIL AS_​MAIL_​CC'.

AS_​MAIL_​BODY

Package:
Black Magic Data
Symbol handle:
as_​mail_​body
Description:
Set an email body text. Takes the result of preceding expressions and sets it as the email body text. For example: 'SET "Magic Data Mail" AS_​MAIL_​BODY'.

AS_​MAIL_​BODY_​HTML

Package:
Black Magic Data
Symbol handle:
as_​mail_​body_​html
Description:
Set an email body html. Takes the result of preceding expressions and sets it as html for the email body. For example: 'SET "Magic Data Mail" AS_​MAIL_​BODY_​HTML'.

AS_​MAIL_​CC

Package:
Black Magic Data
Symbol handle:
as_​mail_​cc
Description:
Set an email "cc" address. Takes an email address and adds it to the "mail cc" address list. For example: 'USER EMAIL AS_​MAIL_​CC'.

AS_​MAIL_​FROM

Package:
Black Magic Data
Symbol handle:
as_​mail_​from
Description:
Set an email "from" address. Takes an email address and sets it as the "mail from" address. For example: 'USER EMAIL AS_​MAIL_​FROM'.

AS_​MAIL_​PARAMETER

Package:
Black Magic Data
Symbol handle:
as_​mail_​parameter
Description:
Set a parameter for a subsequent email template. Takes the result of preceding expressions as a parameter value and an the following parameter as the parameter name (or key), then sets the parameter for subsequent use in a mail template. Important Parameters must be set before the mail template is set.. For example: 'SET "http://www.mysite.com/index.php/profile/view/" . ( UID ) . "/" AS_​MAIL_​PARAMETER "profileURL" SET "private_​message" AS_​MAIL_​TEMPLATE' (The actual template requires further parameters to be set).

AS_​MAIL_​REPLY_​TO

Package:
Black Magic Data
Symbol handle:
as_​mail_​reply_​to
Description:
Set an email "reply to" address. Takes an email address and sets it as the "mail reply to" address. For example: 'USER EMAIL AS_​MAIL_​REPLY_​TO'.

AS_​MAIL_​SUBJECT

Package:
Black Magic Data
Symbol handle:
as_​mail_​subject
Description:
Set an email subject. Takes the result of preceding expressions and sets it as the email subject. For example: 'SET "Magic Data Mail" AS_​MAIL_​SUBJECT'.

AS_​MAIL_​TEMPLATE

Package:
Black Magic Data
Symbol handle:
as_​mail_​template
Description:
Set an email template. Takes the result of preceding expressions as an email template name and an optional following parameter as a package handle. For example: 'SET "my_​template" AS_​MAIL_​TEMPLATE "my_​package_​handle"'. For example: 'SET "private_​message" AS_​MAIL_​TEMPLATE'.

AS_​MAIL_​TO

Package:
Black Magic Data
Symbol handle:
as_​mail_​to
Description:
Set an email "to" address. Takes an email address and adds it to the "mail to" address list. For example: 'USER EMAIL AS_​MAIL_​TO'.

AS_​MARKETPLACE_​ITEM

Package:
Magic Data Developer
Symbol handle:
as_​marketplace_​item
Description:
Get a marketplace item by handle or id Tries to find the result of preceding symbols as a marketplace item by package handle or ID, returning the item. The context will be 'MarketplaceItem' or null.

AS_​NUMBER

Package:
Magic Data Symbols1
Symbol handle:
as_​number
Description:
Reduces previous result to just a number, without any surrounding text. Some symbols return formatted numbers. This will extract just the first number found in the previous result.

AS_​PAGE

Package:
Magic Data Symbols1
Symbol handle:
as_​page
Description:
Get a Page ID from a path or ID Tries to find the result of preceding symbols as a path or Page ID (so can be used to validate a Page ID), returning a Page ID or null. Sets the context as 'Page' or null.

AS_​PAGE_​TYPE

Package:
Magic Data Symbols1
Symbol handle:
as_​page_​type
Description:
Get a Page Type ID from a handle, name or ID Tries to find the result of preceding symbols as a page type by name, handle or ID (so can be used to validate a Page Type ID), returning a Page Type ID or null. Sets the context as 'Page Type' or null. For example: 'SET "Blog Entry" AS_​PAGE_​TYPE'.

AS_​PRODUCT

Package:
Magic Data Commerce
Symbol handle:
as_​product
Description:
Get a Product ID from a product name or ID Tries to find the result of preceding symbols as a Product ID (so can be used to validate a Product ID), returning a Product ID or null. Sets the context as 'Product' or null.

AS_​PRODUCT_​SET

Package:
Magic Data Commerce
Symbol handle:
as_​product_​set
Description:
Get a Product Set ID from a product set name or ID Tries to find the result of preceding symbols as a Product Set ID (so can be used to list a set), returning a Product Set ID or null. Sets the context as 'ProductSet' or null.

AS_​QRCODE

Package:
Magic Data Symbols1
Symbol handle:
as_​qrcode
Description:
Generate a QR code The preceeding result is used as text to generate a QR code and the resulting QR code image shown inline. Optional following parameters are the size of the QR code in pixels and the color in hex or rgba. Size defaults to a 200 pixel minimum and color to black. For example: 'PAGE URL AS_​QRCODE'. WARNING The size of a QR code must be sufficiently large to contain the text you are encoding.The maximum number of characters is 2900.

AS_​RATING

Package:
Magic Data Symbols1
Symbol handle:
as_​rating
Description:
Translates a number into a 5-star rating. Takes any number as a percentage and outputs it as a star rating. For example 'SET 4 AS_​RATING'. Note that integers in the range 1..5 are translated into a percentage. Decimals below 1 are tranlsated into a percentage

AS_​STACK

Package:
Magic Data Symbols1
Symbol handle:
as_​stack
Description:
Get a Stack ID from a name or ID Tries to find the result of preceding symbols as a stack name or ID (so can be used to validate a Stack ID), returning a Stack ID or null. Sets the context as 'Stack' or null. For example: 'SET "Side Nav" AS_​STACK STACK_​NAME'.

AS_​STATE

Package:
Country State Manager
Symbol handle:
as_​state
Description:
Identifies a state and sets the context Given a state or countrys and state, identifies the state/province and returns the appropriate coutry/state code. For example: \'SET \'United Kingdom, Cornwall\' AS_​STATE \'.

AS_​TIME

Package:
Magic Data Symbols1
Symbol handle:
as_​time
Description:
Synonym for STR_​TO_​TIME Takes the previous result as a string and processes it using the php strtotime() function to return a system time value. For example 'SET "next Thursday" STR_​TO_​TIME DATE "DATE_​APP_​GENERIC_​MDYT_​FULL"'.

AS_​UID

Package:
Magic Data Symbols1
Symbol handle:
as_​uid
Description:
Get a user ID from a user name Tries to find the result of preceding symbols as a username, then as an email, then finally as a user ID (so can be used to validate a user ID), returning a user ID or null. Sets the context as 'User' or null.

AS_​USER

Package:
Magic Data Symbols1
Symbol handle:
as_​user
Description:
Synonym for AS_​UID Tries to find the result of preceding symbols as a username, then as an email, then finally as a user ID (so can be used to validate a user ID), returning a user ID or null. Sets the context as 'User' or null.

ATTRIBUTE

Package:
Magic Data Symbols1
Symbol handle:
attribute
Description:
Returns the value of a specified attribute. The immediately following symbol must be an attribute handle. The context of Page, User, File etc and the respective id is taken from the result of preceding symbols. For example 'SET JohntheFish CONTEXT User ATTRIBUTE shipping_​address'. Ideally the attribute handle should be used. However, this symbol will also do its best to work from attribute names and ids.

ATTRIBUTE_​DISPLAY

Package:
Magic Data Symbols1
Symbol handle:
attribute_​display
Description:
Synonym for DISPLAY_​ATTRIBUTE The immediately following symbol must be an attribute handle. The context of Page, User, File etc and the respective id is taken from the result of preceding symbols. For example 'SET JohntheFish CONTEXT User ATTRIBUTE_​DISPLAY shipping_​address'. Ideally the attribute handle should be used. However, this symbol will also do its best to work from attribute names and ids.

ATTRIBUTE_​OBJECT

Package:
Magic Data Templates1
Symbol handle:
attribute_​object
Description:
The object the current Magic Data Attribute is associated with. Within a Magic Data Attribute, returns the item and context of the object the attribute is assciated with. If used outside of a Magic Data attribute, a previous Magic Data Attribute may persist, otherwise the outcome will be null.

ATTRIBUTE_​SEARCH_​INDEX

Package:
Magic Data Symbols1
Symbol handle:
attribute_​search
Description:
Synonym for SEARCH_​INDEX_​ATTRIBUTE The immediately following symbol must be an attribute handle. The context of Page, User, File etc and the respective id is taken from the result of preceding symbols. For example 'SET JohntheFish CONTEXT User ATTRIBUTE_​SEARCH_​INDEX shipping_​address'. Ideally the attribute handle should be used. However, this symbol will also do its best to work from attribute names and ids.

AUTO_​TRIGGER_​BLOCKS_​BY_​AJAX

Package:
Blocks by AJAX
Symbol handle:
auto_​trigger_​blocks_​by_​ajax
Description:
Trigger a blocks_​by_​ajax event in the browser. Takes the preceding result as a jQuery/CSS selector to watch for a change event and the following parameter as jQuery/CSS selector for a Blocks by AJAX block. When the first selector changes, will trigger the blocks_​by_​ajax event. For example: 'SET ".blocks_​by_​ajax" AUTO_​TRIGGER_​BLOCKS_​BY_​AJAX ".blocks_​by_​ajax"'.

AVATAR

Package:
Magic Data Symbols1
Symbol handle:
avatar
Description:
Return an avatar image for a user Tries to find the result of preceding symbols as a user ID or email, returning an associated avatar or gravatar. For example 'UID AVATAR' or 'SET "not-a-user@email.com" AVATAR'.

BADGE_​DESCRIPTION

Package:
Magic Data Developer
Symbol handle:
badge_​description
Description:
The description for a badge. Given a concrete5 badge, returns the description for the badge or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​BADGES 10 APPLY_​EACH BADGE_​DESCRIPTION END_​APPLY_​EACH HTML_​OL'.

BADGE_​ICON

Package:
Magic Data Developer
Symbol handle:
badge_​icon
Description:
The icon for a badge. Given a concrete5 badge, returns an icon for the badge or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​BADGES 100 APPLY_​EACH BADGE_​ICON END_​APPLY_​EACH HTML_​OL'.

BADGE_​NAME

Package:
Magic Data Developer
Symbol handle:
badge_​name
Description:
The name for a badge. Given a concrete5 badge, returns the name for the badge or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​BADGES 100 APPLY_​EACH BADGE_​NAME END_​APPLY_​EACH HTML_​OL'.

BEGINS_​WITH

Package:
Magic Data Symbols1
Symbol handle:
begins_​with
Description:
Tests for a string beginning with another string. Tests whether text from the preceding result begins with the text in the following parameter, returning the previous resultas an equivalent of true.

BEGINS_​WITHC

Package:
Magic Data Symbols1
Symbol handle:
begins_​withc
Description:
Tests for a string beginning with another string, case invariant. Tests whether text from the preceding result begins with the text in the following parameter, ignoring case and returning the previous result as an equivalent of true.

BENCHMARK

Package:
Magic Data Developer
Symbol handle:
benchmark
Description:
Start a benchmark loop. Starts a benchmark loop that is ended with END_​BENCHMARK. An optional following numeric parameter provides the number of iterations. The previous result and context are preserved and provided to the symbols inside the benchmark loop. For example: 'BENCHMARK 20 Administrators AS_​GROUP LIST_​USERS 10 APPLY_​EACH EMAIL AS_​LINK END_​APPLY_​EACH END_​BENCHMARK HTML_​OL . BENCHMARK_​RESULT' WARNING When conducting a number of iterations for a benchmark, any data accumulated such as merged into a list or buffer from a single iteration could be further accumulated for each successive iteration to give an erroneous result. Only use BENCHMARK for timing measurement, then remove to ensure correct results.

BENCHMARK_​RESULT

Package:
Magic Data Developer
Symbol handle:
benchmark_​result
Description:
Show the result of a benchmark loop. Shows the result of a benchmark loop delineated by BENCHMARK .. END_​BENCHMARK. The result is given in seconds for a single iteration of the benchmarked symbols, rounded to 0.001 seconds. For example: 'BENCHMARK 20 Administrators AS_​GROUP LIST_​USERS 10 APPLY_​EACH EMAIL AS_​LINK END_​APPLY_​EACH END_​BENCHMARK HTML_​OL . BENCHMARK_​RESULT'

BLOCK_​DATA_​ITEM

Package:
Universal Content Puller
Symbol handle:
block_​data_​item
Description:
Get a data item for a block. Takes the result of preceding symbols as a block and the following parameter as the name of an item of block data (as in the block XML), returning the data item or null. For example: 'PAGE PARENT LIST_​BLOCKS "Main" 1 BLOCK_​DATA_​ITEM "content" '.

BLOCK_​TYPE_​DESCRIPTION

Package:
Magic Data Developer
Symbol handle:
block_​type_​description
Description:
Returns a block description. Using the result of preceding symbols as an installed block type, returns the block type description or null. For example: 'SET 'jl_​uber_​list' AS_​BLOCK_​TYPE BLOCK_​TYPE_​DESCRIPTION'.

BLOCK_​TYPE_​HANDLE

Package:
Magic Data Developer
Symbol handle:
block_​type_​handle
Description:
Returns a block type handle. Using the result of preceding symbols as an installed block type, returns the block type handle or null. For example: 'SET 'Uber Filter' AS_​INSTALLED_​PACKAGE LIST_​INSTALLED_​BLOCK_​TYPES 100 APPLY_​EACH BLOCK_​TYPE_​HANDLE END_​APPLY_​EACH HTML_​OL'.

BLOCK_​TYPE_​NAME

Package:
Magic Data Developer
Symbol handle:
block_​type_​name
Description:
Returns a block type name. Using the result of preceding symbols as an installed block type, returns the block type name or null. For example: 'SET 'Magic Data Direct' AS_​BLOCK_​TYPE BLOCK_​TYPE_​NAME'.

BLOCK_​TYPE_​PACKAGE

Package:
Magic Data Developer
Symbol handle:
block_​type_​package
Description:
Returns the package that provided a block type. Using the result of preceding symbols as an installed block type, returns the package that provided the block type or null. For example: 'SET 'Cache Free HTML' AS_​BLOCK_​TYPE BLOCK_​TYPE_​PACKAGE MARKETPLACE_​NAME'.

BLOG_​THUMBNAIL

Package:
Uber List
Symbol handle:
blog_​thumbnail
Description:
Given a blog page, returns the associated thumbnail image. Tries to find the result of preceding symbols as a path or Page ID, returning the blog thumbnail image for the page or null. An optional following parameter sets the standard level 1 or 2 thumbnail or a box size in pixels. The deafult size is 220 pixels to correspond with a regular blog thumbnail size. For example: 'SET /blog/hello-world CONTEXT Page BLOG_​THUMBNAIL 100'.

BUFFER_​ADD

Package:
Magic Data Symbols1
Symbol handle:
buffer_​add
Description:
Appends the current value to the buffer. Appends the the result of preceding symbols to the ouput buffer and returns the same value while keeping the context. For example 'SET "Whatever you want" BUFFER_​ADD'.

BUFFER_​ADD_​LINE

Package:
Magic Data Symbols1
Symbol handle:
buffer_​add_​line
Description:
Appends the current value to the buffer and starts a new line. Appends the the result of preceding symbols to the ouput buffer followed by a new line character and returns the same value while keeping the context. For example 'SET "Whatever you want" BUFFER_​ADD_​LINE'.

BUFFER_​CLEAR

Package:
Magic Data Symbols1
Symbol handle:
buffer_​clear
Description:
Clears the buffer content. Clears the buffer and maintains whatever the previous result was (ie. not the buffer content). For example 'SET "Whatever you want" BUFFER_​ADD BUFFER_​CLEAR SET "Whatever else you want" BUFFER_​ADD BUFFER_​GET'.

BUFFER_​GET

Package:
Magic Data Symbols1
Symbol handle:
buffer_​get
Description:
Retrieves the current buffer content. Retrieves the ouput buffer content while keeping buffer intact. For example 'SET "Whatever you want" BUFFER_​ADD SET "Whatever else you want" BUFFER_​ADD BUFFER_​GET'.

BUFFER_​GET_​CLEAR

Package:
Magic Data Symbols1
Symbol handle:
buffer_​get_​clear
Description:
Retrieves the current buffer content and clears the buffer. Retrieves the ouput buffer content and clears the buffer. For example 'SET "Whatever you want" BUFFER_​ADD SET "Whatever else you want" BUFFER_​ADD BUFFER_​GET_​CLEAR'.

BUFFER_​LENGTH

Package:
Magic Data Symbols1
Symbol handle:
buffer_​length
Description:
The length of the buffer. The length of the current buffer content as a character count. For example 'SET "Whatever you want" BUFFER_​ADD SET "Whatever else you want" BUFFER_​LENGTH'.

BY_​AJAX

Package:
Blocks by AJAX
Symbol handle:
by_​ajax
Description:
Following symbol evaluation is delayed and handled by an AJAX request. Takes the previous result and all following symbols up until END_​BY_​AJAX or the end of the expression and delays evaluation until after the page is loaded, when the symbols are then eveluated through an AJAX request back to the server. In the mean time, a spinner is shown as a placeholder. Settings may be adjusted using the Blocks By AJAX Remote Control block or site constants. For example: 'BY_​AJAX UID USERNAME END_​BY_​AJAX'.

C5_​FORUM_​POSTS_​URL

Package:
Magic Data Developer
Symbol handle:
c5_​forum_​posts_​url
Description:
A url to search for a user's forum posts. Using the result of preceding symbols as user on concrete5.org, returns a url to search for the user's forum posts or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​FORUM_​POSTS_​URL'.

C5_​HOWTOS_​URL

Package:
Magic Data Developer
Symbol handle:
c5_​howtos_​url
Description:
A url to search for a user's how-tos. Using the result of preceding symbols as user on concrete5.org, returns a url to search for the user's how-tos or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​HOWTOS_​URL'.

C5_​JOINED

Package:
Magic Data Developer
Symbol handle:
c5_​joined
Description:
The date/time a user joined concrete5.org. Using the result of preceding symbols as user on concrete5.org, returns system time the user joined or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​JOINED DATE "d-m-Y"'.

C5_​KARMA

Package:
Magic Data Developer
Symbol handle:
c5_​karma
Description:
The user's karma. Using the result of preceding symbols as user on concrete5.org, returns user's karma or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​KARMA'.

C5_​PROFILE_​AVATAR

Package:
Magic Data Developer
Symbol handle:
c5_​profile_​avatar
Description:
The avatar from the profile. Using the result of preceding symbols as user on concrete5.org, returns the avatar from the user's profile or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​PROFILE_​AVATAR'.

C5_​PROFILE_​BIO

Package:
Magic Data Developer
Symbol handle:
c5_​profile_​bio
Description:
Biography from the profile. Using the result of preceding symbols as user on concrete5.org, returns the biography from the user's profile or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​PROFILE_​BIO'.

C5_​PROFILE_​IMAGE

Package:
Magic Data Developer
Symbol handle:
c5_​profile_​image
Description:
A profile image for the user. Using the result of preceding symbols as user on concrete5.org, returns the a profile image from the user's profile or null. An optional following parameter provides an index if there is more than one profile image. An second optional following parameter provides a box size for the image. For example: 'SET '51576 ' AS_​C5_​USER C5_​PROFILE_​IMAGE 1 250'.

C5_​PROFILE_​NAME

Package:
Magic Data Developer
Symbol handle:
c5_​profile_​name
Description:
The name from the profile. Using the result of preceding symbols as user on concrete5.org, returns the name from the user's profile or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​PROFILE_​NAME'.

C5_​PROFILE_​SITE_​URL

Package:
Magic Data Developer
Symbol handle:
c5_​profile_​site_​url
Description:
The site url from the profile. Using the result of preceding symbols as user on concrete5.org, returns the site url from the user's profile or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​PROFILE_​SITE_​URL'.

C5_​TOTAL_​BADGES

Package:
Magic Data Developer
Symbol handle:
c5_​total_​badges
Description:
The total badges awarded. Using the result of preceding symbols as user on concrete5.org, returns the total badges earned by the user or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​TOTAL_​BADGES'.

C5_​TOTAL_​FORUM_​POSTS

Package:
Magic Data Developer
Symbol handle:
c5_​total_​forum_​posts
Description:
The total forum posts made. Using the result of preceding symbols as user on concrete5.org, returns the total forum posts made by the user or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​TOTAL_​FORUM_​POSTS'.

C5_​TOTAL_​FORUM_​POSTS_​MARKED_​BEST

Package:
Magic Data Developer
Symbol handle:
c5_​total_​forum_​posts_​marked_​best
Description:
The number of forum posts marked as best answer. Using the result of preceding symbols as user on concrete5.org, returns the number of times forum posts made by the user have been marked as best answer or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​TOTAL_​FORUM_​POSTS_​MARKED_​BEST'.

C5_​TOTAL_​HOWTOS

Package:
Magic Data Developer
Symbol handle:
c5_​total_​howtos
Description:
The total how-tos posted. Using the result of preceding symbols as user on concrete5.org, returns the total how-tos posted by the user or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​TOTAL_​HOWTOS'.

C5_​USER_​NAME

Package:
Magic Data Developer
Symbol handle:
c5_​user_​name
Description:
The username. Using the result of preceding symbols as user on concrete5.org, returns site username or null. For example: 'SET '51576 ' AS_​C5_​USER C5_​USER_​NAME'.

CACHE

Package:
Uber List
Symbol handle:
cache
Description:
Caches the following subexpression. The symbols CACHE and END_​CACHE are used to enclose a subexpression that is applied to the previous result. The immediately following parameter is an optional cache mode. The next parameter is an optional cache duration in seconds and defaults to 3600 (1 hour). All subsequent symbols are evaluated and the result cached for the duration. For example: 'Administrators AS_​GROUP CACHE "by_​groups_​p" 60 LIST_​USERS 100 APPLY_​EACH EMAIL AS_​LINK END_​APPLY_​EACH HTML_​OL END_​CACHE'. Cache modes are: "global" [Global (default)], "global_​p" [By page], "by_​user" [By individual user (session)], "by_​user_​p" [By individual user (session) and page], "registered" [By guests/users], "registered_​p" [By guests/users and page], "by_​groups" [By groups], "by_​groups_​p" [By groups and page]. IMPORTANT This symbol does not need to be used with list expressions in Uber List or with Magic Data Select attributes which already have caching built in to the list.

CART_​IS_​ABOVE_​MINIMUM

Package:
Magic Data Commerce
Symbol handle:
cart_​is_​above_​minimum
Description:
Returns true if the cart is above the minumum value. The total price of the cart is returned as an equivalent of true.

CART_​MINIMUM

Package:
Magic Data Commerce
Symbol handle:
cart_​minimum
Description:
Returns the minumum cart value. The minimum value is the value a cart must meet or exceed in order to be purchased.

CERTIFICATION_​DESCRIPTION

Package:
Magic Data Developer
Symbol handle:
certification_​description
Description:
The description for a certification. Given a concrete5 certification, returns the description for the certification or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​CERTIFICATIONS 20 APPLY_​EACH CERTIFICATION_​DESCRIPTION END_​APPLY_​EACH HTML_​OL'.

CERTIFICATION_​ICON

Package:
Magic Data Developer
Symbol handle:
certification_​icon
Description:
The icon for a certification. Given a concrete5 certification, returns an icon for the certification or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​CERTIFICATIONS 20 APPLY_​EACH CERTIFICATION_​ICON END_​APPLY_​EACH HTML_​OL'.

CERTIFICATION_​NAME

Package:
Magic Data Developer
Symbol handle:
certification_​name
Description:
The name for a certification. Given a concrete5 certification, returns the name for the certification or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​CERTIFICATIONS 20 APPLY_​EACH CERTIFICATION_​NAME END_​APPLY_​EACH HTML_​OL'.

CHECKOUT_​REQUIRES_​LOGIN

Package:
Magic Data Commerce
Symbol handle:
checkout_​requires_​login
Description:
Returns true if login is required to complete the checkout. When true, a user must be logged in to complete a purchase.

CHECK_​PHP_​CLASS_​EXISTS

Package:
Magic Data Developer
Symbol handle:
check_​php_​class_​exists
Description:
Checks if a php class exists Useful for confirming php intsallation details. Takes the previous result as a PHP class name and confirms if it exists, returning the class name as a true result or null as a false result. For example: 'SET 'PDO' CHECK_​PHP_​CLASS_​EXISTS ZERO_​AS_​THEN_​END "Doesn't Exist"'. IMPORTANT For non built in classes, results will depend on whether the class has been loaded.

CHECK_​PHP_​FUNCTION_​EXISTS

Package:
Magic Data Developer
Symbol handle:
check_​php_​function_​exists
Description:
Checks if a php function exists Useful for confirming php intsallation details. Takes the previous result as a PHP function name and confirms if it exists, returning the function name as a true result or null as a false result. For example: 'SET 'odbc_​connect' CHECK_​PHP_​FUNCTION_​EXISTS ZERO_​AS_​THEN_​END "Doesn't Exist"'.

CID

Package:
Magic Data Symbols1
Symbol handle:
cid
Description:
Returns the current page (collection) ID. Synonym for PAGE. May be used interchangeably.

CLEAN_​TEXT

Package:
Magic Data Symbols1
Symbol handle:
clean_​text
Description:
Clean text by sanitizing and tidying white space. Strips the previous result of all html tags and attributes. Cleans up white space.

CLEAR

Package:
Magic Data Symbols1
Symbol handle:
clear
Description:
Clear a value previously saved. Clear a value previously saved using the result of any previous symbols as a key. As a side efect returns the originally saved value and restores the associated context. For example 'SET "Whatever you want" SAVE my_​key_​name SET my_​key_​name CLEAR' will return "Whatever you want" while clearing the saved value.

CLEAR_​ALL_​FROM_​SESSION

Package:
Black Magic Data
Symbol handle:
clear_​all_​from_​session
Description:
Clears all values previously saved to the user's session. Clear all values previously saved into session memory. For example 'SET "Whatever you want" SAVE_​TO_​SESSION my_​key_​name SET "Whatever else you want" SAVE_​TO_​SESSION my_​other_​key_​name CLEAR_​ALL_​FROM_​SESSION' will return "Whatever you want" while clearing the saved value.

CLEAR_​ATTRIBUTE

Package:
Black Magic Data
Symbol handle:
clear_​attribute
Description:
Clears a specified attribute. The immediately following symbol must be an attribute handle. The context of Page, User, File etc and the respective id is taken from the result of preceding symbols. For example 'USER CLEAR_​ATTRIBUTE "shipping_​address"'. Ideally the attribute handle should be used. However, this symbol will also do its best to work from attribute names and ids. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

CLEAR_​CURRENT_​PRODUCT

Package:
Magic Data Commerce
Symbol handle:
clear_​current_​product
Description:
Clears the currently tracked product Clears the current product tracking system. Use this if product tracking is getting confused, for example, if a product list follows a product that was set through the Magic Data SET_​CURRENT_​PRODUCT symbol, you may need to use an expression containing this symbol between the two blocks.

CLEAR_​FILE

Package:
Black Magic Data
Symbol handle:
clear_​file
Description:
Empty a file. Using the result of preceding symbols to identify a file, clears the file and returns the file ID. For example: 'SET "output_​file.txt" AS_​FILE CLEAR_​FILE '. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

CLEAR_​FROM_​SESSION

Package:
Black Magic Data
Symbol handle:
clear_​from_​session
Description:
Clear a value previously saved to the user's session. Clear a value previously saved into session memory using the result of any previous symbols as a key. As a side effect returns the originally saved value and restores the associated context. For example 'SET "Whatever you want" SAVE_​TO_​SESSION my_​key_​name SET my_​key_​name CLEAR_​FROM_​SESSION' will return "Whatever you want" while clearing the saved value.

CLEAR_​TEMPLATE

Package:
Magic Data Templates1
Symbol handle:
clear_​template
Description:
Clears magic data templates Clears all pending magic data template settings for all template keys.

CLEAR_​TEMPLATE_​STICKY

Package:
Magic Data Templates1
Symbol handle:
clear_​template_​sticky
Description:
Make a template sticky Non-sticky template styling is the default behaviour. You only need to use this symbol if a previous expression has used MAKE_​TEMPLATE_​STICKY. Clears sticky template styling, so that styling doesn not persist through any following Magic Data enabled templates. Returns the previous result. An optional following parameter can be used to set a template key and defaults to outer. The template key can be any one of inner, outer, all_​list_​inner, all_​list_​outer. For example: 'SET "my_​outer_​class" SET_​TEMPLATE_​CLASS CLEAR_​TEMPLATE_​STICKY'.

CLOSEST_​ANCESTOR_​PAGE_​WITH_​ATTRIBUTE

Package:
Magic Data Symbols1
Symbol handle:
closest_​ancestor_​page_​with_​attribute
Description:
Closest page leading to a specified page with an attribute. Taking the previous result as a page and the following parameter as an attribute. Returns the closest ancestor page having that attribute. For example: 'SET 'Hello World' AS_​PAGE CLOSEST_​ANCESTOR_​PAGE_​WITH_​ATTRIBUTE "my_​attribute" '.

concatenate .

Package:
Magic Data Symbols1
Symbol handle:
concatenate
Description:
Concatenation Operator (dot). Concatenates the current value and the next symbol as a string or combines them if either is a list, returning the string or combined list. IMPORTANT Be sure to separate this operator from adjacent symbols with a white space!. For example: '"First String" . " " . "Second String"'. Or for lists: '"A,B,C,D" AS_​LIST "," . ( "E,F,G,H" AS_​LIST "," ) HTML_​UL '.

CONFIG

Package:
Magic Data Symbols1
Symbol handle:
concrete5_​config
Description:
Returns a concrete5 Config value. Tries to find the result of preceding symbols as an entry in the concrete5 Config table. For example 'SET SITE_​APP_​VERSION CONFIG'. This may be of diagnostic use to developers, but is unlikely to be directly relevant to publicly available web pages.

CONSTANT

Package:
Magic Data Symbols1
Symbol handle:
defined_​constant
Description:
Returns the value of a defined constant. Tries to find the result of preceding symbols as a defined php constant. For example 'SET BASE_​URL CONSTANT'.

CONTAINS

Package:
Magic Data Symbols1
Symbol handle:
contains
Description:
Tests for a string containing another string. Tests whether text from the preceding result contains the text in the following parameter, returning the previous result as an equivalent of true.

CONTAINSC

Package:
Magic Data Symbols1
Symbol handle:
containsc
Description:
Tests for a string containing another string, case invariant. Tests whether text from the preceding result contains the text in the following parameter, ignoring case and returning the previous result as an equivalent of true.

CONTAINS_​HTML

Package:
Magic Data Symbols1
Symbol handle:
contains_​html
Description:
Tests if text contains any HTML. Takes the previous result as text and if it contains any HTML tags returns the text as the equivalent of true. If it does not contain any HTML, then returns null.

CONTEXT

Package:
Magic Data Symbols1
Symbol handle:
context
Description:
Sets the current context according to the following symbol/value. Used to set the context within which attributes are retrieved and provide some type hints for other data. Should be Page, User, File etc. Maintains any previous result. For example: 'SET 1 CONTEXT User USERNAME' will return the username for the user with ID 1. Inappropriate context can result in faulty attribute evaluation and errors or warnings in any symbol evaluation.

COUNTRY_​CODE

Package:
Country State Manager
Symbol handle:
country_​code
Description:
Synonym for AS_​COUNTRY Given a country, identifies the country and returns the appropriate country code. For example: 'LIST_​COUNTRIES 200 APPLY_​EACH COUNTRY_​NAME END_​APPLY_​EACH HTML_​OL'.

COUNTRY_​NAME

Package:
Country State Manager
Symbol handle:
country_​name
Description:
Returns the name of a country Given a country, returns the name. For example: 'LIST_​COUNTRIES 200 APPLY_​EACH COUNTRY_​NAME END_​APPLY_​EACH HTML_​OL'.

COUNT_​CHARACTERS

Package:
Magic Data Symbols1
Symbol handle:
count_​characters
Description:
Count characters in text. Treating the previous result as a string, counts the number of words. For example: 'SET /about AS_​PAGE PAGE_​DESCRIPTION COUNT_​CHARACTERS'. IMPORTANT No allowance is made for embedded HTML tags. To be accurate, SANITIZE any HTML string first.

COUNT_​ITEMS

Package:
Magic Data Commerce
Symbol handle:
count_​items
Description:
Returns the number of items in the cart or order. This adds up the number of each product in the cart or order to give an overall total number of items.

COUNT_​LIST

Package:
Magic Data Symbols1
Symbol handle:
count_​list
Description:
Count the number of items in a list. Takes the previous result as a list and counts the number of items in the list.

COUNT_​PRODUCTS

Package:
Magic Data Commerce
Symbol handle:
count_​products
Description:
Returns the number of products in the cart or order. This adds up the number of distinct products in the cart or order (ignoring the quantity of each product).

COUNT_​WORDS

Package:
Magic Data Symbols1
Symbol handle:
count_​words
Description:
Count words in text. Treating the previous result as a string, counts the number of words. For example: 'SET /about AS_​PAGE PAGE_​DESCRIPTION COUNT_​WORDS'. IMPORTANT No allowance is made for embedded HTML tags. To be accurate, SANITIZE any HTML string first.

CREATE_​FILE

Package:
Black Magic Data
Symbol handle:
create_​file
Description:
Create a new file. Using the result of preceding symbols as a file name, creates a new file. Only creates a file if a file with that name does not already exist. Returns the file ID. For example: 'SET "output_​file.txt" CREATE_​FILE '. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

CREATE_​FILESET

Package:
Black Magic Data
Symbol handle:
create_​fileset
Description:
Creates a fileset. Creates a fileset, taking the name from the result of preceding symbols, returning an ID for the fileset. An optional following symbol can be 'public', 'private' or 'starred' and defaults to public. The created fileset is owned by the current user. For example: 'SET "Special Files" CREATE_​FILESET "private" '. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

CREATE_​FILESET_​FOR_​UID

Package:
Black Magic Data
Symbol handle:
create_​fileset_​for_​uid
Description:
Creates a fileset suffixed with the id for a specified user. Similar to CREATE_​FILESET, however a user's user id specified by a following parameter is suffixed to the fileset name to ensure a fileset name unique to the user. Returning the fileset ID or null. For example: 'SET "Special Files" CREATE_​FILESET_​FOR_​UID ( SET "JohntheFish" AS_​USER ) FILESET_​NAME'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

CREATE_​FILESET_​WITH_​UID

Package:
Black Magic Data
Symbol handle:
create_​fileset_​with_​uid
Description:
Creates a fileset suffixed with the current user id. Similar to CREATE_​FILESET, however the current user's user id is suffixed to the fileset name to ensure a fileset name unique to the user. For example: 'SET "Special Files" CREATE_​FILESET_​WITH_​UID "public" '. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

CREATE_​PAGE

Package:
Black Magic Data
Symbol handle:
create_​page
Description:
Create a new page beneath a specified page. Using the result of preceding symbols as a name for a new page and the following two parameters as a parent page and page type, creates a new page. Only creates a page if a page with that name does not already exist. Returns the page ID. For example: 'SET "My New Page" CREATE_​PAGE "about" "Right Sidebar"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

CREATE_​PAGE_​ALWAYS

Package:
Black Magic Data
Symbol handle:
create_​page_​always
Description:
Create a new page beneath a specified page. Using the result of preceding symbols as a name for a new page and the following two parameters as a parent page and page type, creates a new page. If a page with that name already exists, will create another page with an adjusted handle. Returns the page ID. For example: 'SET "My New Page" CREATE_​PAGE_​ALWAYS "about" "Right Sidebar"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

CREATE_​PAGE_​ALWAYS_​BENEATH_​CURRENT

Package:
Black Magic Data
Symbol handle:
create_​page_​always_​beneath_​current
Description:
Create a new page beneath the current page. Using the result of preceding symbols as a name for a new page and the following parameter as a page type, creates a new page. If a page with that name already exists, will create another page with an adjusted handle. Returns the page ID. For example: 'SET "My New Page" CREATE_​PAGE_​ALWAYS_​BENEATH_​CURRENT "Right Sidebar"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

CREATE_​PAGE_​BENEATH_​CURRENT

Package:
Black Magic Data
Symbol handle:
create_​page_​beneath_​current
Description:
Create a new page beneath the current page. Using the result of preceding symbols as a name for a new page and the following parameter as a page type, creates a new page. Only creates a page if a page with that name does not already exist. Returns the page ID. For example: 'SET "My New Page" CREATE_​PAGE_​BENEATH_​CURRENT "Right Sidebar"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

CURRENT_​API_​SERVER

Package:
Black Magic Data
Symbol handle:
current_​api_​server
Description:
Returns the name currently set API server name. API commands act on a currently set server interface, set using the symnol AS_​API_​SERVER. This symbol returns any currently set API server name. For example: 'SET 'remote_​name' AS_​API_​SERVER CURRENT_​API_​SERVER'.

CURRENT_​FORM

Package:
Magic Data Forms
Symbol handle:
current_​form
Description:
Returns the currently set form name. Most form commands act on a currently set form interface and form name, set using the symnols WITH_​FORM_​INTERFACE and WITH_​FORM. This symbol returns any currently set form name. For example: 'SET 'core_​form' AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM CURRENT_​FORM'

CURRENT_​FORM_​INTERFACE

Package:
Magic Data Forms
Symbol handle:
current_​form_​interface
Description:
Returns the currently set form interface. Most form commands act on a currently set form interface and form name, set using the symnols WITH_​FORM_​INTERFACE and WITH_​FORM. This symbol returns any currently set form interface. For example: 'SET 'Core Form' WITH_​FORM_​INTERFACE CURRENT_​FORM_​INTERFACE'

CURRENT_​PRODUCT

Package:
Magic Data Commerce
Symbol handle:
current_​product
Description:
Get the current product On a product page, identifies and returns the product associated with the page as a Product ID or returns null. Within an MD enabled product list, returns the currently listed product or null. Sets the context as 'Product' or null. The current product can also be set using the symbol SET_​CURRENT_​PRODUCT, so that symbol can be used in lists such as UBER_​LIST to list product blocks.

CURRENT_​SYMBOL_​PERMISSION_​SET

Package:
Black Magic Data
Symbol handle:
current_​symbol_​permission_​set
Description:
The currnetly active symbol permission set. Black Magic Data provides a permission system for symbols. This symbol returns the name of the currently active symbol permission set.

CURRENT_​TAB_​HEADING

Package:
Magic Tabs
Symbol handle:
current_​tab_​heading
Description:
Gets the heading for an enclosing magic Tab. Will return the text for the heading of the currently enclosing magic Tab. An optional following parameter can be used to select an enclosing tab level as 'top', 1, 2 or 'parent'. For example 'CURRENT_​TAB_​HEADING' will return the immediately enclosing tab. 'CURRENT_​TAB_​HEADING tgop' will return the outermost enclosing tab. 'CURRENT_​TAB_​HEADING parent' will return the tab enclosing a currently nested tab. WARNING This symbol is extremely susceptible to caching of block content, so be sure to use a cache-free block and evaluate magic data at a suitable point of the view rendering process.

CURRENT_​TAB_​LEVEL

Package:
Magic Tabs
Symbol handle:
current_​tab_​level
Description:
Gets the nesting level of the current tab. Will return the nesting level of the currently enclosing magic Tab. WARNING This symbol is extremely susceptible to caching of block content, so be sure to use a cache-free block and evaluate magic data at a suitable point of the view rendering process.

CURRENT_​USER

Package:
Magic Data Symbols1
Symbol handle:
current_​user
Description:
Returns the current user ID. Synonym for UID. May be used interchangeably.

DATE

Package:
Magic Data Symbols1
Symbol handle:
date
Description:
Formatted date from the time. Uses the result of preceding symbols as a time and translates it into a formatted date according to the following symbol. If the following symbol can be found as a constant, uses that as the format. Otherwise uses the following symbol as a date format string. If the format string contains %, then translates it using strftime(), otherwise translates it using date(). Sets the context as 'Date' or null. For example: 'TIME DATE "d M Y"'. 'UID PREVIOUS_​LOGIN DATE DATE_​APP_​GENERIC_​MDYT_​FULL'.

DELETE_​FILE

Package:
Black Magic Data
Symbol handle:
delete_​file
Description:
Delete a file. Using the result of preceding symbols to identify a file, deletes the file and returns nothing. For example: 'SET "output_​file.txt" AS_​FILE DELETE_​FILE '. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

DELETE_​FORM_​RESPONSE

Package:
Magic Data Forms
Symbol handle:
delete_​form_​response
Description:
Delete a form response. Takes the previous symbol as a form response and returs the uID of the user associated with the response or null. For example: 'SET "core_​form" AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM SET "Name" LIST_​FORM_​RESPONSES_​MATCHING_​VALUE "JohntheFish" 1 DELETE_​FORM_​RESPONSE'

DEVICE_​TYPE

Package:
Magic Data Symbols1
Symbol handle:
device_​type
Description:
Returns 'tablet', 'mobile' or 'normal'. Returns a string depending on whether the browser is a tablet or mobile device. Can be used with a SWITCH to branch depending on device.

DIFFERENCE

Package:
Magic Data Symbols1
Symbol handle:
difference
Description:
Items that appear in the first list but not the second list. Takes the previous result as a list or single item and the following parameter as a list or single item and returns list containing only those items that are solely in the first list. The context remains that of the preceding list. For example: 'Administrators AS_​GROUP LIST_​USERS 10 DIFFERENCE ( Editors AS_​GROUP LIST_​USERS 10 ) '.

DISPLAY_​ATTRIBUTE

Package:
Magic Data Symbols1
Symbol handle:
display_​attribute
Description:
Returns the display value for a specified attribute. The immediately following symbol must be an attribute handle. The context of Page, User, File etc and the respective id is taken from the result of preceding symbols. For example 'SET JohntheFish CONTEXT User DISPLAY_​ATTRIBUTE shipping_​address'. Ideally the attribute handle should be used. However, this symbol will also do its best to work from attribute names and ids.

divide /

Package:
Magic Data Symbols1
Symbol handle:
divide
Description:
Divides two numbers. Takes the previous result as a number and divides it by the following number. For example: 'SET "3.7" - "1.6" .'.

EMAIL

Package:
Magic Data Symbols1
Symbol handle:
email
Description:
Get a user email address from a user ID Tries to find the result of preceding symbols as a user ID or name, returning an email address or null. Sets the context as 'User' or null.

END

Package:
Magic Data
Symbol handle:
end
Description:
Returns the preceding result and ends symbol processing. Use this to forcibly end any series of symbol evaluation before the last symbol.

ENDS_​WITH

Package:
Magic Data Symbols1
Symbol handle:
ends_​with
Description:
Tests for a string ending with another string. Tests whether text from the preceding result ends with the text in the following parameter, returning the previous result as an equivalent of true.

ENDS_​WITHC

Package:
Magic Data Symbols1
Symbol handle:
ends_​withc
Description:
Tests for a string ending with another string, case invariant. Tests whether text from the preceding result ends with the text in the following parameter, ignoring case and returning the previous result as an equivalent of true.

END_​APPLY_​EACH

Package:
Magic Data Symbols1
Symbol handle:
end_​apply_​each
Description:
Ends an APPLY_​EACH list. Use this to end a list of symbols that follows and APPLY_​EACH symbol. If used out of context, just does nothing.

END_​BENCHMARK

Package:
Magic Data Developer
Symbol handle:
end_​benchmark
Description:
Ends an BENCHMARK loop. Use this to end the benchmark loop that follows a BENCHMARK symbol. If used out of context, just does nothing.

END_​BY_​AJAX

Package:
Blocks by AJAX
Symbol handle:
end_​by_​ajax
Description:
Ends a BY_​AJAX list. Use this to end a list of symbols that follows a BY_​AJAX symbol. If used out of context, just does nothing.

END_​CACHE

Package:
Uber List
Symbol handle:
end_​cache
Description:
Ends a CACHE subexpression. Use this to end a list of symbols that follows an CACHE symbol. If used out of context, just does nothing.

END_​FILTER

Package:
Magic Data Symbols1
Symbol handle:
end_​filter
Description:
Ends an FILTER_​LIST sequence. Use this to end a list of symbols that follows and FILTER_​LIST symbol. If used out of context, just does nothing.

END_​FILTER_​LIST

Package:
Magic Data Symbols1
Symbol handle:
end_​filter_​list
Description:
Synonym for END_​FILTER Use this to end a list of symbols that follows and FILTER_​LIST symbol. If used out of context, just does nothing.

END_​FORM_​SELECT

Package:
Blocks by AJAX
Symbol handle:
end_​form_​select
Description:
Ends a FORM_​SELECT list. Use this to end a list of symbols that follows and FORM_​SELECT symbol. If used out of context, just does nothing.

END_​LOG_​DEBUG

Package:
Magic Data Developer
Symbol handle:
end_​log_​debug
Description:
Ends a LOG_​DEBUG section. Use this to end a log-debug section that follows a LOG_​DEBUG symbol. If used out of context, just does nothing.

END_​NO_​DEBUG

Package:
Magic Data Developer
Symbol handle:
end_​no_​debug
Description:
Ends an NO_​DEBUG section. Use this to end a no-debug section that follows a NO_​DEBUG symbol. If used out of context, just does nothing.

END_​ON_​NULL

Package:
Magic Data Symbols1
Symbol handle:
end_​on_​null
Description:
Ends symbol processing if the preceding result is null. Use this to abort any series of symbol evaluation if a null, false or empty result is encounered.

END_​SORT_​BY

Package:
Magic Data Symbols1
Symbol handle:
end_​sort_​by
Description:
Ends a SORT_​BY list. Use this to end a list of symbols that follows and SORT_​BY symbol. If used out of context, just does nothing.

EQ

Package:
Magic Data Symbols1
Symbol handle:
eq
Description:
Tests for equality. Equality between the result of preceding symbols and the next symbol is tested using the loose '==' comparison, returning the previous result value as an equivalent of true.

EQC

Package:
Magic Data Symbols1
Symbol handle:
eqc
Description:
Tests for case-independant equality. Case independant equality between the result of preceding symbols and the next symbol is tested using the loose '==' comparison, returning the previous result value as an equivalent of true.

EQCN

Package:
Magic Data Symbols1
Symbol handle:
eqcn
Description:
Tests for case-independant equality. Case independant equality between the result of preceding symbols and the next symbol is tested using the loose '==' comparison, returning the compared value as an equivalent of true.

ESCAPE_​CSV

Package:
Magic Job
Symbol handle:
escape_​csv
Description:
Escapes as a csv field The preceding result is escaped as a csv field, assuming comma as a delimiter and double quotes as a wrapper.

ESCAPE_​HTML

Package:
Magic Data Symbols1
Symbol handle:
escape_​html
Description:
Escapes HTML tags Takes the previous result as text and escapes any HTML tags and special characters, so it can be viewed on a web page.

EVALUATE_​AS_​MAGIC_​DATA

Package:
Black Magic Data
Symbol handle:
evaluate_​as_​magic_​data
Description:
Evaluates the result of preceding symbols. Takes the result of preceding symbols as a Magic Data expression and evaluates that expression, returning the result. For example: 'SET "UID USERNAME" EVALUATE_​AS_​MAGIC_​DATA'. A more useful example, where a page attribute contains a Magic Data expression: 'PAGE ATTRIBUTE "My Attribute Containing MD" EVALUATE_​AS_​MAGIC_​DATA'. WARNING Be careful about evaluating Magic Data originating from a user input. It could break the security of your site.

EVALUATE_​WITH_​MAGIC_​DATA

Package:
Black Magic Data
Symbol handle:
evaluate_​with_​magic_​data
Description:
Applies a following Magic Data expression. Takes the following parameter as a Magic Data expression and evaluates that expression, passing in the result of preceding symbols and returning the expression result. For example: 'UID EVALUATE_​WITH_​MAGIC_​DATA "EMAIL AS_​LINK"'. A more useful example, where a page attribute contains a Magic Data expression: 'SET "some input value" EVALUATE_​WITH_​MAGIC_​DATA ( PAGE ATTRIBUTE "My Attribute Containing MD" )' WARNING Be careful about evaluating Magic Data originating from a user input. It could break the security of your site.

EXTRACT_​FILES

Package:
Universal Content Puller
Symbol handle:
extract_​files
Description:
Extracts a list of files from html. Takling the previous result as a string of text or html, parses the string to extract a list of files held by the site's file manager. Sets the context as File. For example: 'SET "1" AS_​PAGE RENDER_​PAGE_​AREA "Sidebar" EXTRACT_​FILES APPLY_​EACH FILE_​NAME END_​APPLY_​EACH HTML_​OL'.

EXTRACT_​PAGES

Package:
Universal Content Puller
Symbol handle:
extract_​pages
Description:
Extracts a list of pages from html. Takling the previous result as a string of text or html, parses the string to extract a list of pages within the site. Sets the context as Page. For example: 'SET "1" AS_​PAGE RENDER_​PAGE_​AREA "Sidebar" EXTRACT_​PAGES APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​OL'.

FILESET_​FOR_​USER

Package:
Magic Data Symbols1
Symbol handle:
fileset_​for_​user
Description:
For a user ID, return a Fileset identified by name or ID. Takes a valid user ID from the result of preceding symbols and a Fileset name or ID from the next symbol. If a Fileset is identified by name and does not exist it will be created as a public file set. Returns the Fileset by ID or null. The context will be 'Fileset' or null. Alternatively, will work the other way round and take the Fileset name or ID from the result of preceding symbols and the user ID from the next symbol. For example: 'SET JohntheFish FILESET_​FOR_​USER Mugshots' can also be expressed as 'SET Mugshots FILESET_​FOR_​USER JohntheFish'.

FILESET_​NAME

Package:
Magic Data Symbols1
Symbol handle:
fileset_​name
Description:
Given a fileset, return the fileset name Tries to find the result of preceding symbols as a Fileset name or ID, returning a Fileset Name or null. The context will be 'Fileset' or null.

FILE_​CROP_​THUMBNAIL

Package:
Magic Data Symbols1
Symbol handle:
file_​crop_​thumbnail
Description:
Given a file, returns a thumbnail cropped where necessary. Using the result of preceding symbols as a file or file ID, returns a complete html image tag for the thumbnail, cropped and styled to fit exactly. An optional following parameter sets the standard level 1 or 2 thumbnail or a box size in pixels. Alternatively, a pair of following parameters set the width and height in pixels. For example: 'SET 6 AS_​FILE FILE_​CROP_​THUMBNAIL 150 100'.

FILE_​CROP_​UNSTYLED_​THUMBNAIL

Package:
Magic Data Symbols1
Symbol handle:
file_​crop_​unstyled_​thumbnail
Description:
Given a file, returns a thumbnail cropped where necessary without any styling. Using the result of preceding symbols as a file or file ID, returns a minimal html image tag for the thumbnail, cropped to fit. An optional following parameter sets the standard level 1 or 2 thumbnail or a box size in pixels. Alternatively, a pair of following parameters set the width and height in pixels. For example: 'SET 6 AS_​FILE FILE_​CROP_​UNSTYLED_​THUMBNAIL 150 100'.

FILE_​DATE_​ADDED

Package:
Magic Data Symbols1
Symbol handle:
file_​date_​added
Description:
When the current version was added. Tries to find the result of preceding symbols as a File ID, returning the system time for the current file version or null. For example: 'SET 3 CONTEXT File FILE_​DATE_​ADDED FRIENDLY_​DATE "Human"'.

FILE_​DESCRIPTION

Package:
Magic Data Symbols1
Symbol handle:
file_​description
Description:
Given a file, returns the file description. Tries to find the result of preceding symbols as a File ID, returning the description for the file or null. For example: 'SET 3 CONTEXT File FILE_​DESCRIPTION'.

FILE_​DOWNLOADED_​BY_​USER

Package:
Magic Data Symbols1
Symbol handle:
file_​downloaded_​by_​user
Description:
Given a file, returns when a specified user downloaded it. Tries to find the result of preceding symbols as a File ID and the following parameter as a user. Returns the time the user most recently downloaded the file or null. Sets the context as "Time". For example: 'SET "europe_​england_​stonehenge.jpg" AS_​FILE FILE_​DOWNLOADED_​BY_​USER ( SET "JohntheFish" AS_​USER )'.

FILE_​DOWNLOAD_​COUNT

Package:
Magic Data Symbols1
Symbol handle:
file_​download_​count
Description:
Given a file, returns a count of downloads. Tries to find the result of preceding symbols as a File ID, returning a count of the number of times a file has been downloaded or null. For example: 'SET "europe_​england_​stonehenge.jpg" AS_​FILE FILE_​DOWNLOAD_​COUNT'.

FILE_​DOWNLOAD_​COUNT_​AFTER

Package:
Magic Data Symbols1
Symbol handle:
file_​download_​count_​after
Description:
Given a file, returns a count of downloads since a time. Tries to find the result of preceding symbols as a File ID, returning a count of the number of times a file has been downloaded since a specified date/time. The following parameter should be a date or time. For example: 'SET "europe_​england_​stonehenge.jpg" AS_​FILE FILE_​DOWNLOAD_​COUNT_​AFTER ( SET "yesterday" AS_​TIME )'.

FILE_​DOWNLOAD_​URL

Package:
Magic Data Symbols1
Symbol handle:
file_​download_​url
Description:
Given a file, returns a download url. Tries to find the result of preceding symbols as a File ID, returning a download url to the file or null. For example: 'SET 3 CONTEXT File FILE_​DOWNLOAD_​URL AS_​LINK'.

FILE_​EXTENSION

Package:
Magic Data Symbols1
Symbol handle:
file_​extension
Description:
Given a file, returns the extension. Tries to find the result of preceding symbols as a File ID, returning the file type extension for current version of the file or null. For example: 'SET 3 AS_​FILE FILE_​EXTENSION'.

FILE_​FORCE_​DOWNLOAD_​URL

Package:
Magic Data Symbols1
Symbol handle:
file_​force_​download_​url
Description:
Given a file, returns a download url. Tries to find the result of preceding symbols as a File ID, returning a forced download url for the file or null. For example: 'SET 3 CONTEXT File FILE_​FORCE_​DOWNLOAD_​URL AS_​LINK'.

FILE_​MIME_​TYPE

Package:
Magic Data Symbols1
Symbol handle:
file_​mime_​type
Description:
Given a file, returns the MIME type. Tries to find the result of preceding symbols as a File ID, returning the MIME type for the current version of the file or null. For example: 'SET 3 AS_​FILE FILE_​MIME_​TYPE'.

FILE_​NAME

Package:
Magic Data Symbols1
Symbol handle:
file_​name
Description:
Given a file, returns the file name. Tries to find the result of preceding symbols as a File ID, returning the filename for the current version of the file or null. For example: 'SET 3 CONTEXT File FILE_​NAME'.

FILE_​NICE_​TITLE

Package:
Magic Data Symbols1
Symbol handle:
file_​nice_​title
Description:
Given a file, returns the file title, cleaned up is necessary. As FILE_​TITLE with the fallback of an unhandled filename.

FILE_​SIZE

Package:
Magic Data Symbols1
Symbol handle:
file_​size
Description:
Given a file, returns the size. Tries to find the result of preceding symbols as a File ID, returning the file size in kilobytes for the current version of the file or null. An optional following parameter can be used to specify precision as 0,1,2 or 3 decimal places and defaults to 0. For example: 'SET 3 AS_​FILE FILE_​SIZE 3'.

FILE_​TAGS

Package:
Magic Data Symbols1
Symbol handle:
file_​tags
Description:
List the tags for a file. Tries to find the result of preceding symbols as a File ID, returning a list of the tags for the current version of the file or null. For example: 'SET 3 AS_​FILE FILE_​TAGS'.

FILE_​THUMBNAIL

Package:
Magic Data Symbols1
Symbol handle:
file_​thumbnail
Description:
Given a file, returns the file thumbnail. Using the result of preceding symbols as a file or file ID, returns a complete html image tag for the thumbnail image with styling to limit dimensions. An optional following parameter sets the standard level 1 or 2 thumbnail or a box size in pixels. Alternatively, a pair of following parameters set the width and height in pixels. For example: 'SET 3 AS_​FILE FILE_​THUMBNAIL 2'. Image "alt" tags are automatically generated from the file title or name. Image "title" tags are automatically generated from the file description or tags.

FILE_​TITLE

Package:
Magic Data Symbols1
Symbol handle:
file_​title
Description:
Given a file, returns the file title. Tries to find the result of preceding symbols as a File ID, returning the title for the file or null. For example: 'SET 3 CONTEXT File FILE_​TITLE'.

FILE_​TYPE

Package:
Magic Data Symbols1
Symbol handle:
file_​type
Description:
Given a file, returns the generic file type. Tries to find the result of preceding symbols as a File ID, returning the generic file type for the current version of the file or null. For example: 'SET 3 AS_​FILE FILE_​TYPE'.

FILE_​UNSTYLED_​THUMBNAIL

Package:
Magic Data Symbols1
Symbol handle:
file_​unstyled_​thumbnail
Description:
Given a file, returns a thumbnail without any styling. Using the result of preceding symbols as a file or file ID, returns a minimal html image tag for the thumbnail image. An optional following parameter sets the standard level 1 or 2 thumbnail or a box size in pixels. Alternatively, a pair of following parameters set the width and height in pixels. For example: 'SET 3 AS_​FILE FILE_​UNSTYLED_​THUMBNAIL 300 200'.

FILTER_​LIST

Package:
Magic Data Symbols1
Symbol handle:
filter_​list
Description:
Reduces a list according to the following symbols. Takes the previous result as a list and reduces the list by first removing empty elements and then applying the subexpression of following symbols to each element of the list. Continues until the end of a token or until the symbol END_​FILTER is encountered. Any list elements for which the filter returns zero, false or null will be removed from the returned list.

FILTER_​LIST_​EXCLUDE

Package:
Uber List
Symbol handle:
filter_​list_​exclude
Description:
Reduces a list according to the following symbols. Takes the previous result as a list and reduces the list by first removing empty elements and then applying the subexpression of following symbols to each element of the list. Continues until the end of a token or until the symbol END_​FILTER_​EXCLUDE is encountered. Only list elements for which the filter returns zero, false or null, will be retained in the returned list.

FILTER_​LIST_​EXCLUDE_​LIMIT

Package:
Uber List
Symbol handle:
filter_​list_​exclude_​limit
Description:
Reduces a list according to the following symbols and to a limit. Takes the previous result as a list and reduces the list by first removing empty elements and then applying the subexpression of following symbols to each element of the list, until the limit is reached. Continues until the end of a token or until the symbol END_​FILTER is encountered. Only list elements for which the filter returns zero, false or null, will be retained in the returned list, up to the specified maximum limit.

FILTER_​LIST_​LIMIT

Package:
Uber List
Symbol handle:
filter_​list_​limit
Description:
Reduces a list according to the following symbols and to a limit. Takes the previous result as a list and reduces the list by first removing empty elements and then applying the subexpression of following symbols to each element of the list, until the limit is reached. Continues until the end of a token or until the symbol END_​FILTER is encountered. Any list elements for which the filter returns zero, false or null, or are after the limit, will be removed from the returned list.

FILTER_​TO_​BEGINS_​WITH

Package:
Magic Data Symbols1
Symbol handle:
filter_​to_​begins_​with
Description:
Reduces a list to items that begin with something. Takes the previous result as a list and the following parameter as text to match and reduces the list by removing any items that don't begin with that text.

FILTER_​TO_​BEGINS_​WITHC

Package:
Magic Data Symbols1
Symbol handle:
filter_​to_​begins_​withc
Description:
Reduces a list to items that begin with something, case invariant. Takes the previous result as a list and the following parameter as text to match and reduces the list by removing any items that don't begin with that text, ignoring case.

FILTER_​TO_​ENDS_​WITH

Package:
Magic Data Symbols1
Symbol handle:
filter_​to_​ends_​with
Description:
Reduces a list to items that end with something. Takes the previous result as a list and the following parameter as text to match and reduces the list by removing any items that don't end with that text.

FILTER_​TO_​ENDS_​WITHC

Package:
Magic Data Symbols1
Symbol handle:
filter_​to_​ends_​withc
Description:
Reduces a list to items that end with something, case invariant. Takes the previous result as a list and the following parameter as text to match and reduces the list by removing any items that don't end with that text, ignoring case.

FLAG

Package:
Flags
Symbol handle:
flag
Description:
Insert a flag. The country code for the flag will be taken from the previous result. If numeric, the following symbol will be used to set the flag size. For example 'SET GB FLAG 64' will return '<i class="flag-64 GB"></i>', the css to insert the UK flag.

FORMAT

Package:
Magic Data Symbols1
Symbol handle:
format
Description:
Formats a text string using previously saved values. The text formatting is very simple, replacing anything {{my_​key_​name}} with a value previously stored under that key using 'SAVE'. Note: while this uses mustache like delimiters, it is not a mustache templating system.

FORMAT_​PRICE

Package:
Magic Data Commerce
Symbol handle:
format_​price
Description:
Formats a price. Formats a price according to current eCommerce settings for currency.

FORM_​BOOLEAN_​FILTER_​OF_​FIELDS

Package:
Magic Data Forms
Symbol handle:
form_​boolean_​filter_​of_​fields
Description:
Retrieve the value of specific fields. Using the current form, takes the result of preceding symbols as the identity of a form response and the following symbol as a list of fields, returning a reduced list of fields where the response is not false. For example: 'SET "core_​form" AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM LIST_​FORM_​RESPONSES 1 FORM_​BOOLEAN_​FILTER_​OF_​FIELDS ( SET "Name,email,comment" AS_​LIST )'

FORM_​CSV_​SET_​DATE_​FIELD

Package:
Magic Data Forms CSV
Symbol handle:
form_​csv_​set_​date_​field
Description:
Informs the CSV form interface which field to use for a timestamp. Takes the result of previous symbols as a form field and the following parameter as a date format. For example: 'SET "CSV File With Header" AS_​FORM_​INTERFACE SET "my_​data.csv" AS_​FILE CONTEXT "Form" AS_​FORM SET "Date" FORM_​CSV_​SET_​DATE_​FIELD "m/d/Y" LIST_​FORM_​RESPONSES 10 APPLY_​EACH FORM_​RESPONSE_​TIME DATE "d M Y" END_​APPLY_​EACH HTML_​OL'

FORM_​CSV_​SKIP_​ROWS

Package:
Magic Data Forms CSV
Symbol handle:
form_​csv_​skip_​rows
Description:
Directs the CSV form interface to skip rows before processing. Takes the result of previous symbols as the number of rows to skip. For example: 'SET "CSV File With Header" AS_​FORM_​INTERFACE SET "my_​data_​with_​junk_​rows.csv" AS_​FILE CONTEXT "Form" AS_​FORM SET 3 FORM_​CSV_​SKIP_​ROWS'

FORM_​INPUT_​BUTTON

Package:
Blocks by AJAX
Symbol handle:
form_​input_​button
Description:
Creates a button. Uses the preceding result as a button label and names the button according to the following parameter. For example: 'PAGE FORM_​INPUT_​HIDDEN "page_​id" . ( SET "Click Me" FORM_​INPUT_​BUTTON "my_​button_​name" ) WRAP_​WITH_​BLOCKS_​BY_​AJAX_​TRIGGER ".blocks_​by_​ajax:first"'.

FORM_​INPUT_​CHECKBOX

Package:
Blocks by AJAX
Symbol handle:
form_​input_​checkbox
Description:
Places a value inside a form text input. Uses the preceding value for a checkbox form input and names that input according to the following parameter. A further optional following parameter may set the checked state true or false. For example: 'SET "My Text Value" FORM_​INPUT_​CHECKBOX "my_​checkbox_​input" "true"'.

FORM_​INPUT_​HIDDEN

Package:
Blocks by AJAX
Symbol handle:
form_​input_​hidden
Description:
Places a value inside a hidden form input. Places the preceding value inside a hidden form input and names that input according to the following parameter. For example: 'PAGE FORM_​INPUT_​HIDDEN "page_​id" . ( SET "Click Me" FORM_​INPUT_​BUTTON "my_​button_​name" ) WRAP_​WITH_​BLOCKS_​BY_​AJAX_​TRIGGER ".blocks_​by_​ajax:first"'.

FORM_​INPUT_​RADIO

Package:
Blocks by AJAX
Symbol handle:
form_​input_​radio
Description:
Places a value inside a form text input. Uses the preceding value for a radio form input and names that input according to the following parameter. A further optional following parameter may set the checked state true or false. Radio inputs are usually used with 2 or more buttons having teh same name. For example: 'SET "My Radio A Value" FORM_​INPUT_​RADIO "my_​checkbox_​input" "false"'.

FORM_​INPUT_​TEXT

Package:
Blocks by AJAX
Symbol handle:
form_​input_​text
Description:
Places a value inside a form text input. Places the preceding value inside a form text input and names that input according to the following parameter. For example: 'SET "My Text Value" FORM_​INPUT_​TEXT "my_​text_​input"'.

FORM_​RESPONSE_​AS_​HTML_​DL

Package:
Magic Data Forms
Symbol handle:
form_​response_​as_​html_​dl
Description:
Returns a form response as a definition list. Takes the previous result as a form response, retrieves the fields and presents them as an html definition list. The following symbol may optionally be used to provide a class that will be attached to the DL element. For example: 'SET "core_​form" AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM LIST_​FORM_​RESPONSES 1 FORM_​RESPONSE_​AS_​HTML_​DL'

FORM_​RESPONSE_​FIELD_​VALUES

Package:
Magic Data Forms
Symbol handle:
form_​response_​field_​values
Description:
List the value for all fields of a response. Using the current form, takes the result of preceding symbols as the identity of a form response and list the responses to all fields For example: 'SET "core_​form" AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM LIST_​FORM_​RESPONSES 1 FORM_​RESPONSE_​FIELD_​VALUES'

FORM_​RESPONSE_​TIME

Package:
Magic Data Forms
Symbol handle:
form_​response_​time
Description:
The timestamp a response was made. Takes the previous symbol as a form response and returs the timestamp associated with the response or null. For example: 'SET 'core_​form' AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM LIST_​FORM_​RESPONSES 10 APPLY_​EACH FORM_​RESPONSE_​TIME END_​APPLY_​EACH HTML_​OL'

FORM_​RESPONSE_​USER

Package:
Magic Data Forms
Symbol handle:
form_​response_​user
Description:
The user who made a response. Takes the previous symbol as a form response and returs the uID of the user associated with the response or null. For example: 'SET 'core_​form' AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM LIST_​FORM_​RESPONSES 10 APPLY_​EACH FORM_​RESPONSE_​USER USERNAME END_​APPLY_​EACH HTML_​OL'

FORM_​SELECT

Package:
Blocks by AJAX
Symbol handle:
form_​select
Description:
Creates a form select element from a list. Takes the previous result as a list and applies the subexpression of following symbols to each element of the list. Continues until the end of a token or until the symbol END_​FORM_​SELECT is encountered. The parameter immediately following FORM_​SELECT is used for the name of the select. The value of each item in the list is used as the value of a select option. The result of processing each item is used as the label for the select element. If the list is empty, nothing is processed and null is returned. For example: 'SET "Administrators" AS_​GROUP LIST_​USERS 10 FORM_​SELECT "user_​select" USERNAME END_​FORM_​SELECT'.

FORM_​VALUE_​OF_​FIELD

Package:
Magic Data Forms
Symbol handle:
form_​value_​of_​field
Description:
Retrieve the value to a specific field and response. Using the current form, takes the result of preceding symbols as the identity of a form response and the following symbol as a field, returning the value to the field. Optionally, can take the result of preceding symbols as the question and a following parameter as the identity of a form response For example: 'SET "core_​form" AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM LIST_​FORM_​RESPONSES 1 FORM_​VALUE_​OF_​FIELD "Name" '

FORM_​VALUE_​OF_​FIELDS

Package:
Magic Data Forms
Symbol handle:
form_​value_​of_​fields
Description:
Retrieve the value of specific fields. Using the current form, takes the result of preceding symbols as the identity of a form response and the following symbol as a list of fields, returning the value of the fields. For example: 'SET "core_​form" AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM LIST_​FORM_​RESPONSES 1 FORM_​VALUE_​OF_​FIELDS ( SET "Name,email,comment" AS_​LIST )'

FRIENDLY_​DATE

Package:
Last Updated
Symbol handle:
friendly_​date
Description:
Formats a date or time in human-friendly way. Formats a date or time in a friendly way. Available formats are "Casual", "Contextual", "Formal", "Friendly", "Human", "Relative 1", "Relative 2", "Relative 3", "Unformatted". For example 'PAGE LAST_​UPDATED Main FRIENDLY_​DATE Human ' will return a 'Human' formatted Date/Time for when the Main area of the page was last updated.

FROM_​ENV_​DATA

Package:
Blocks by AJAX
Symbol handle:
from_​env_​data
Description:
Extracts a item from ENV data. Tries to find the result of preceding symbols as a key in the ENV data, returning its value as a single item or list, or null. For example: 'SET "User Entered Text" FROM_​ENV_​DATA'.

FROM_​GET_​DATA

Package:
Blocks by AJAX
Symbol handle:
from_​get_​data
Description:
Extracts a item from GET data. Tries to find the result of preceding symbols as a key in the GET data, returning its value as a single item or list, or null. For example: 'SET "User Entered Text" FROM_​GET_​DATA'.

FROM_​NOW

Package:
Magic Data Symbols1
Symbol handle:
from_​now
Description:
Time difference from now in seconds. Uses the result of preceding symbols as a time and subtracts the current time from it to give a time in seconds. Times in the past will consequently give a negative result.

FROM_​POST_​DATA

Package:
Blocks by AJAX
Symbol handle:
from_​post_​data
Description:
Extracts a item from POST data. Tries to find the result of preceding symbols as a key in the POST data, returning its value as a single item or list, or null. For example: 'SET "User Entered Text" FROM_​POST_​DATA'.

FROM_​REQUEST_​DATA

Package:
Blocks by AJAX
Symbol handle:
from_​request_​data
Description:
Extracts a item from REQUEST data. Tries to find the result of preceding symbols as a key in the REQUEST data, returning its value as a single item or list, or null. For example: 'SET "User Entered Text" FROM_​REQUEST_​DATA'.

FROM_​SERVER_​DATA

Package:
Blocks by AJAX
Symbol handle:
from_​server_​data
Description:
Extracts a item from SERVER data. Tries to find the result of preceding symbols as a key in the SERVER data, returning its value as a single item or list, or null. For example: 'SET "User Entered Text" FROM_​SERVER_​DATA'.

FROM_​SESSION_​DATA

Package:
Blocks by AJAX
Symbol handle:
from_​session_​data
Description:
Extracts an item from SESSION data. Tries to find the result of preceding symbols as a key in the SESSION data, returning its value as a single item or list, or null. For example: 'SET "Session key" FROM_​SESSION_​DATA'.

GE

Package:
Magic Data Symbols1
Symbol handle:
ge
Description:
Tests for greater than or equal to. Comparison between the result of preceding symbols and the next symbol is tested using a '>=' comparison, returning the previous result value as an equivalent of true. Comparison is made as text strings. However, if both values are numeric a numeric comparison is made.

GEO_​LATLNG

Package:
Sorcerer's Map
Symbol handle:
geo_​latlng
Description:
Lookup the Lat/Lng for a location Looks up a location string as a Latitude and Longitude using Google. The result is returned as two fixed point decimals separated by a comma. For example: 'UID ATTRIBUTE "Address" GEO_​LATLNG'. When available, a Google API key will be used from the Sorcerer's Map block or from a site constant API_​KEYS_​GOOGLE_​MAPS.

GET_​CONTEXT

Package:
Magic Data Developer
Symbol handle:
get_​context
Description:
The current context. Returns the current context as a value. Can be of use to developers when debugging new symbols or complex expressions.

GET_​TIME_​FROM_​FORMAT

Package:
Magic Data Forms
Symbol handle:
get_​time_​from_​format
Description:
Parse a date into a time using a format. Takes the result of previous symbols as a date and parses it into a date-timestamp using a format specified in a following parameter. For example: 'SET "14/2/2014" GET_​TIME_​FROM_​FORMAT "d/m/Y"'

GET_​TOKEN

Package:
Tokens
Symbol handle:
get_​token
Description:
Retrieves a token from Whale Tokens. Takes the previous result as the name of a token from Whale Tokens and retrieves the token value. The values of tokens can then be used in more complex symbol expressions. For example: 'SET website GET_​TOKEN AS_​LINK'.

GLOBAL_​AREA_​NAME

Package:
Universal Content Puller
Symbol handle:
global_​area_​name
Description:
Given a global area, returns the global area name. Tries to find the result of preceding symbols as a Global Area or Global Area ID, returning the name for the global area or null. Sets the context as null. For example: 'SET "Header Nav" AS_​GLOBAL_​AREA GLOBAL_​AREA_​NAME'.

GROUP_​DESCRIPTION

Package:
Magic Data Symbols1
Symbol handle:
group_​description
Description:
Given a group, returns the group description. Tries to find the result of preceding symbols as a group or Group ID, returning the name for the description or null. Sets the context as null.

GROUP_​EXIT_​TIME

Package:
Magic Data Symbols1
Symbol handle:
group_​exit_​time
Description:
Returns the time a user has left in a group. Tries to find the result of preceeding symbols as a user and the following item as a group, returns the time the user will exit the group or null if the user is not in the group. If the user is permanently in the group returns the value of PHP_​INT_​MAX. Sets the context as 'Time' or null. For example: 'UID GROUP_​EXIT_​TIME Members INT_​MAX_​AS_​THEN_​END "Forever" ZERO_​AS_​THEN_​END "Not a member" DATE DATE_​APP_​GENERIC_​MDYT'. This can also be used with the FRIENDLY_​DATE symbol provided by the Last Updated addon.

GROUP_​NAME

Package:
Magic Data Symbols1
Symbol handle:
group_​name
Description:
Given a group, returns the group name. Tries to find the result of preceding symbols as a group or Group ID, returning the name for the group or null. Sets the context as 'Group' or null.

GT

Package:
Magic Data Symbols1
Symbol handle:
gt
Description:
Tests for greater than. Comparison between the result of preceding symbols and the next symbol is tested using a '>' comparison, returning the previous result value as an equivalent of true. Comparison is made as text strings. However, if both values are numeric a numeric comparison is made.

HIGHLIGHTED_​RAW

Package:
Magic Data Developer
Symbol handle:
highlighted_​raw
Description:
As RAW, but also applies some highlighting. Use in documentation to show a Magic Data token unprocessed with syntax highlighting. Otherwise identical to RAW

HIGHLIGHT_​TERMS

Package:
Uber List
Symbol handle:
highlight_​terms
Description:
Highlights the supplied terms. Takes the result of preceding symbols as text and the following parameter as a set of space separated terms and return the text with those terms highlighted. The highlighting is provided by calling the core search block.

HOME_​PAGE

Package:
Magic Data Symbols1
Symbol handle:
home_​page
Description:
The home page. Returns the collection ID for the home page (1) and sets the context as 'Page'.

HREF

Package:
Magic Data Symbols1
Symbol handle:
href
Description:
Extract the URL from the href="..." or src="..." attribute of a DOM element. Some Magic Data symbols return complete DOM elements. If you just want the URL, this pulls it out. For example: 'SET '<a href="http://www.concrete5.org"> concrete5 </a>' HREF' will return 'http://www.concrete5.org'.

HTML_​ADD_​ATTRIBUTE

Package:
Universal Content Puller Sources1
Symbol handle:
html_​add_​attribute
Description:
Adds or modifies an attribute within an HTML tag. Takes HTML and adds or modifies an attribute of selected elements. The elements are selected by a css/jQuery selector provided by the following parameter. The second following parameter is the attribute to set or modify and the third parameter is the value to set. For example: 'SET '<p>Some text containing a list<ul><li>Something</li><li class="special">Something Special</li></ul>And some more text</p>' HTML_​ADD_​ATTRIBUTE 'li.special' 'title' 'My special list item' '. NOTE The Box Grabber addon is required for this to work.

HTML_​ADD_​IMAGE_​ALT

Package:
Universal Content Puller Sources1
Symbol handle:
html_​add_​image_​alt
Description:
Adds or modifies image alt tags within HTML. Takes HTML and adds or modifies alt attributes of image tags. The following parameter is the value to set. For example: 'SET '<p>Some text containing a list<ul><li>Something</li><li class="special">Something Special</li><li><img src="{{CCM:FID_​1}}"></li></ul>And some more text</p>' HTML_​ADD_​IMAGE_​ALT 'My image alt text' '. NOTE The Box Grabber addon is required for this to work.

HTML_​BR

Package:
Magic Data Symbols1
Symbol handle:
html_​br
Description:
Formats text using html break elements. Takes the previous result as a list or as text containing line breaks and turns that into text split by html BR elements.

HTML_​DL

Package:
Magic Data Symbols1
Symbol handle:
html_​dl
Description:
Turns the previous result into an definition list. Takes the previous result as a list and the following parameter as a list of terms to turn that into an html definition list. A further following symbol may optionally be used to provide a class that will be attached to the DL element.

HTML_​EXCLUDE_​SELECTOR

Package:
Universal Content Puller Sources1
Symbol handle:
html_​exclude_​selector
Description:
Remove from html according to a selector. Takes HTML and removes part of it according to a css/jQuery selector provided by the following parameter. For example: 'SET '<p>Some text containing a list<ul><li>Something</li><li class="special">Something Special</li></ul>And some more text</p>' HTML_​EXCLUDE_​SELECTOR 'li.special' '. NOTE The Box Grabber addon is required for this to work.

HTML_​GET_​ATTRIBUTE

Package:
Universal Content Puller Sources1
Symbol handle:
html_​get_​attribute
Description:
Returns an attribute within an HTML tag. Takes HTML and reads an attribute of selected elements. The elements are selected by a css/jQuery selector provided by the following parameter. The second following parameter is the attribute to read. If more than one selected element has the attribute, returns a list. For example: 'SET '<p>Some text containing a list<ul><li title="My Title">Something</li><li class="special" title="Anoter Title">Something Special</li></ul>And some more text</p>' HTML_​GET_​ATTRIBUTE 'li' 'title' '. NOTE The Box Grabber addon is required for this to work.

HTML_​OL

Package:
Magic Data Symbols1
Symbol handle:
html_​ol
Description:
Turns the previous result into an ordered list. Takes the previous result as a list and turns that into an html ordered list. The following symbol may optionally be used to provide a class that will be attached to the OL element.

HTML_​P

Package:
Magic Data Symbols1
Symbol handle:
html_​p
Description:
Formats text using html paragraphs. Takes the previous result as a list or as text containing line breaks and turns that into html paragraphs. The following symbol may optionally be used to provide a class that will be attached to the P elements.

HTML_​REMOVE_​ATTRIBUTE

Package:
Universal Content Puller Sources1
Symbol handle:
html_​remove_​attribute
Description:
Removes an attribute within an HTML tag. Takes HTML and removes an attribute of selected elements. The elements are selected by a css/jQuery selector provided by the following parameter. The second following parameter is the attribute to remove. For example: 'SET '<p>Some text containing a list<ul><li>Something</li><li class="special">Something Special</li></ul>And some more text</p>' HTML_​ADD_​ATTRIBUTE 'li.special' 'title' 'My special list item' '. NOTE The Box Grabber addon is required for this to work.

HTML_​SELECTOR

Package:
Universal Content Puller Sources1
Symbol handle:
html_​selector
Description:
Extract from html according to a selector. Takes HTML and extracts part of it according to a css/jQuery selector provided by the following parameter. For example: 'SET '<p>Some text containing a list<ul><li>Something</li><li class="special">Something Special</li></ul>And some more text</p>' HTML_​SELECTOR 'li.special' '. NOTE The Box Grabber addon is required for this to work.

HTML_​THEAD_​TR

Package:
Magic Data Forms
Symbol handle:
html_​thead_​tr
Description:
Returns the previous result as the heading row of a table. Takes the previous result as a list and turns that into a heading row for an html table. The following symbol may optionally be used to provide a class that will be attached to the TR element. The output will need to be wrapped in a <table> element, as shown in this more complex example:
'SET "core_​form" AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM
LIST_​FORM_​FIELDS HTML_​THEAD_​TR SAVE "header_​row"
CURRENT_​FORM LIST_​FORM_​RESPONSES 5
APPLY_​EACH
FORM_​RESPONSE_​FIELD_​VALUES HTML_​TR MERGE_​INTO "m1"
END_​APPLY_​EACH
SET "m1" RESTORE IMPLODE " " SAVE "m2"
'<table class="table table-striped">{{header_​row}}<tbody>{{m2}}</tbody></table>' FORMAT'

HTML_​TR

Package:
Magic Data Forms
Symbol handle:
html_​tr
Description:
Returns the previous result as a row of a table. Takes the previous result as a list and turns that into a row for an html table. The following symbol may optionally be used to provide a class that will be attached to the TR element. For example: 'SET "core_​form" AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM LIST_​FORM_​RESPONSES 1 APPLY_​EACH FORM_​RESPONSE_​FIELD_​VALUES HTML_​TR' The output will need to be wrapped in a <table> element.

HTML_​UL

Package:
Magic Data Symbols1
Symbol handle:
html_​ul
Description:
Turns the previous result into an unordered list. Takes the previous result as a list and turns that into an html unordered list. The following symbol may optionally be used to provide a class that will be attached to the UL element.

IF

Package:
Magic Data Symbols1
Symbol handle:
if
Description:
Retururns one of two following values. The decision is based on the result from previous symbols. If this is equivalent to false, the immediately following symbol or subexpression is returned. If this is equivalent to true (ie not false), the next symbol or subexpression after that is returned. For example: 'SET true IF "result string a" "result string b"' will return "result string b". 'SET false IF "result string a" "result string b"' will return "result string a". A less abstract example 'PAGE EQ ( "about" AS_​PAGE ) IF ( NULL ) ( PAGE PAGE_​DESCRIPTION )' will return null for all pages except the about page where it returns the page description. Important points to note are spaces about the parenthesis to make sure it is evaluated as a sub-expression rather than used as a string literal.

IMPLODE

Package:
Magic Data Symbols1
Symbol handle:
implode
Description:
Implode a list into a text string. Takes the previous result as a list and implodes the elements of the list, separated by whatever characters are given by the next symbol. If no separator is given, the default will be un-spaced commas ','.

IMPLODE_​NICELY

Package:
Magic Data Symbols1
Symbol handle:
implode_​nicely
Description:
Implode a list into a text string with nice phrasing. Takes the previous result as a list and combines them intelligently into nicely formatted text such as a, b, c and d. The default seaprator is comma and space ', ' for all items with ' and ' between the last pair. However, an optional following parameter may be used to change the comma and space ', ' to any combination of punctuation and spaces.

INDEX

Package:
Magic Data Symbols1
Symbol handle:
index
Description:
Select an item from a list by index. Takes the previous result as a list and selects a single item from the list according to the following index parameter. The first item has an index of 1. Negative numbers index from the end of the list and the last item has an index of -1. For example: 'Administrators AS_​GROUP LIST_​USERS INDEX 1 USERNAME'.

INSERT_​ZERO_​WIDTH_​SPACE

Package:
Magic Data Symbols1
Symbol handle:
insert_​zero_​width_​space
Description:
Insering zero width space characters. Inserts zero width space characters into text, immediately after any non alpha-numeric character. This enables a browser to break long text strings that would not otherwise break, hence avoiding such strings from overflowing their containers. For example: 'SET \"this/is/a/very/long/string/without/spaces\" INSERT_​ZERO_​WIDTH_​SPACE'

INTERLEAVE_​WITH_​MEMORIES

Package:
Magic Data Symbols1
Symbol handle:
interleave_​with_​memories
Description:
Interleaves the values of a list with values from memories. Takes the previous result as a list and interleaves the values with those returned from lists held in one or more memories, removing any duplicates and empty values. The memory keys are taken from the immediately next symbol as a pipe '|' separated list. For example: 'SET "Catalog" AS_​PAGE LIST_​PAGES 100 SAVE m1 SET "Blog" AS_​PAGE LIST_​PAGES 100 SAVE m2 SET "About" AS_​PAGE LIST_​PAGES INTERLEAVE_​WITH_​MEMORIES m1|m2.

INTERSECT

Package:
Magic Data Symbols1
Symbol handle:
intersect
Description:
Items that appear in both lists. Takes the previous result as a list or single item and the following parameter as a list or single item and returns list containing only those items that are in both lists. The context remains that of the preceding list. For example: 'Administrators AS_​GROUP LIST_​USERS 10 INTERSECT ( Editors AS_​GROUP LIST_​USERS 10 ) '.

INT_​MAX_​AS

Package:
Magic Data Symbols1
Symbol handle:
int_​max_​as
Description:
Formats maximum integer values. If the preceding symbols evaluate to PHP_​INT_​MAX, then returns the immediately following value. Otherwise returns the value. PHP_​INT_​MAX is used as a flag by some numerical results to indicate 'infinity' or 'forever'.

INT_​MAX_​AS_​THEN_​END

Package:
Magic Data Symbols1
Symbol handle:
int_​max_​as_​then_​end
Description:
Formats 'infinity' or 'forever' values. PHP_​INT_​MAX is used as a flag by some numerical results to indicate 'infinity' or 'forever'. If the preceding symbols evaluate to PHP_​INT_​MAX, then returns the immediately following value and ends execution. Otherwise returns the value.

IN_​FILESET

Package:
Magic Data Symbols1
Symbol handle:
in_​fileset
Description:
Checks if a file is in a specified fileset. Tries to find the result of preceeding symbols as a file and the following item as a fileset, returns the file ID if the file is in the fileset or null. Sets the context as 'File' or null.

IN_​GROUP

Package:
Magic Data Symbols1
Symbol handle:
in_​group
Description:
Checks if a user is in a specified group. Tries to find the result of preceeding symbols as a user and the following item as a group, returns the user ID if the user is in the group or null. Sets the context as 'User' or null.

IN_​LIST

Package:
Magic Data Symbols1
Symbol handle:
in_​list
Description:
Checks if an item is in a list. Takes the following parameter as a list and checks if the preceding result is in the list, returning the preceding result as the equivalent of true or null. The context remains that of the preceding list. This is the opposite of LIST_​CONTAINS. For example: 'JohnTheFish AS_​UID IN_​LIST ( Administrators AS_​GROUP LIST_​USERS 10 )'.

IP_​ADDRESS

Package:
Magic Data Symbols1
Symbol handle:
ip_​address
Description:
The user's IP address Returns the user's IP address or null. The context will be 'IP' or null.

IP_​TO_​CITY

Package:
Sorcerer's Map
Symbol handle:
ip_​to_​city
Description:
Look up the city for an IP adddress. Taking the previous result as an IP address and returns the city or null using various lookup services. Fastest results will be achieved by installing the GNT Maxmind addon. For example: 'IP_​ADDRESS IP_​TO_​CITY' will look up the city for the browser's ISP. IMPORTANT City information is not available for many countries outside North America.

IP_​TO_​COUNTRY_​CODE

Package:
Sorcerer's Map
Symbol handle:
ip_​to_​country_​code
Description:
Look up the country code for an IP adddress. Taking the previous result as an IP address and returns the country code or null using various lookup services. Fastest results will be achieved by installing the GNT Maxmind addon. For example: 'SERVER_​IP_​ADDRESS IP_​TO_​COUNTRY_​CODE' will look up the country for the site web server.

IP_​TO_​COUNTRY_​STATE_​CODE

Package:
Sorcerer's Map
Symbol handle:
ip_​to_​country_​state_​code
Description:
Look up the country/state code for an IP adddress. Taking the previous result as an IP address and returns the country/state code or null using various lookup services. Fastest results will be achieved by installing the GNT Maxmind addon. For example: 'SET '50.28.56.20' AS_​IP IP_​TO_​COUNTRY_​STATE_​CODE' will look up the country/state for concret5's IP address. IMPORTANT State/County codes are not available for many countries outside North America.

IP_​TO_​LATLNG

Package:
Sorcerer's Map
Symbol handle:
ip_​to_​latlng
Description:
Look up the latitude and longitude for an IP adddress. Taking the previous result as an IP address and returns the latitude and longitude or null using various lookup services. Fastest results will be achieved by installing the GNT Maxmind addon. For example: 'IP_​ADDRESS IP_​TO_​LATLNG' will look up the latitude and longitude for the browser's ISP. IMPORTANT The position returned is based on the registered location of the IP address, not of the user.

IP_​TO_​STATE_​CODE

Package:
Sorcerer's Map
Symbol handle:
ip_​to_​state_​code
Description:
Look up the state code for an IP adddress. Taking the previous result as an IP address and returns the state code or null using various lookup services. Fastest results will be achieved by installing the GNT Maxmind addon. For example: 'SET '50.28.56.20' AS_​IP IP_​TO_​STATE_​CODE' will look up the state for concret5's IP address. IMPORTANT State/County codes are not available for many countries outside North America.

LAST_​LOGIN

Package:
Magic Data Symbols1
Symbol handle:
last_​login
Description:
Get the time a user last logged in. Tries to find the result of preceding symbols as a user ID or name, returning the number of logins or null. Sets the context as null.

LAST_​UPDATED

Package:
Last Updated
Symbol handle:
last_​updated
Description:
The time a page was last updated. Returns the time a page area or areas were last updated as a system time. The page is taken from the previous result. The area name or list of area names is optional and will be taken from the following text. If no area is specified, the default will be 'Main'. For example 'PAGE LAST_​UPDATED Main,Sidebar ' will return the date and time either the Main or Sidebar areas were updated .

LATLNG_​DISTANCE_​KM

Package:
Sorcerer's Map
Symbol handle:
latlng_​distance_​km
Description:
The distance between two Lat/Lng pairs, in km. Takes two latitude/longitude pairs as returned by GEO_​LATLNG and returns the distance between them in km. The first latitude/longitude is taken from the result of preceding symbols. The second latitude/longitude is taken from the immediately following parameter. For example: 'SET "Portland Oregon" GEO_​LATLNG SAVE "concrete5home" UID ATTRIBUTE "Address" GEO_​LATLNG LATLNG_​DISTANCE_​KM ( "concrete5home" RESTORE )'.

LATLNG_​DISTANCE_​MILES

Package:
Sorcerer's Map
Symbol handle:
latlng_​distance_​miles
Description:
The distance between two Lat/Lng pairs, in miles. Takes two latitude/longitude pairs as returned by GEO_​LATLNG and returns the distance between them in miles. The first latitude/longitude is taken from the result of preceding symbols. The second latitude/longitude is taken from the immediately following parameter. For example: 'SET "Portland Oregon" GEO_​LATLNG SAVE "concrete5home" UID ATTRIBUTE "Address" GEO_​LATLNG LATLNG_​DISTANCE_​MILES ( "concrete5home" RESTORE )'.

LATLNG_​TO_​DMD

Package:
Sorcerer's Map
Symbol handle:
latlng_​to_​dmd
Description:
Format a Lat/Lng in Degrees, Minutes and Decimals. Takes a fixed point latitude/longitude pair as returned by GEO_​LATLNG and formats into degrees, minuites and decimals of minutes. For example: 'UID ATTRIBUTE "Address" GEO_​LATLNG LATLNG_​TO_​DMD'.

LATLNG_​TO_​DMS

Package:
Sorcerer's Map
Symbol handle:
latlng_​to_​dms
Description:
Format a Lat/Lng in Degrees, Minutes and Seconds. Takes a fixed point latitude/longitude pair as returned by GEO_​LATLNG and formats into degrees, minuites and seconds. For example: 'UID ATTRIBUTE "Address" GEO_​LATLNG LATLNG_​TO_​DMS'.

LAT_​FROM_​LATLNG

Package:
Sorcerer's Map
Symbol handle:
lat_​from_​latlng
Description:
Gets the latitude part of a Lat/Lng pair. Takes a latitude/longitude pair as returned by GEO_​LATLNG and returns just the latitude. For example: 'UID ATTRIBUTE "Address" GEO_​LATLNG LAT_​FROM_​LATLNG'.

LE

Package:
Magic Data Symbols1
Symbol handle:
le
Description:
Tests for less than or equal to. Comparison between the result of preceding symbols and the next symbol is tested using a '<=' comparison, returning the previous result value as an equivalent of true. Comparison is made as text strings. However, if both values are numeric a numeric comparison is made.

LIMIT

Package:
Magic Data Symbols1
Symbol handle:
limit
Description:
Limit the size of a list. Takes the previous result as a list and crops its length according to the following parameter. The context remains that of the preceding list. For example: 'Administrators AS_​GROUP LIST_​USERS 10 MERGE ( Editors AS_​GROUP LIST_​USERS 10 ) LIMIT 10'.

LIST_​ACTIVE_​USERS

Package:
Magic Data Symbols1
Symbol handle:
list_​active_​users
Description:
Returns a list of currently active users. DANGER Be very cautious about using this for long lists of users. The user IDs of all recently active users are returned as a list, sorted by most active. The result of preceding symbols is taken as a date or time and defaults to 15 minutes ago. An optional following numeric parameter limits the returned list. For example: 'SET "last hour" AS_​TIME LIST_​ACTIVE_​USERS 50 APPLY_​EACH EMAIL AS_​LINK END_​APPLY_​EACH HTML_​OL'.

LIST_​ALL_​FILES_​WITH_​FILTER

Package:
Uber List
Symbol handle:
list_​all_​files_​with_​filter
Description:
Returns a list of all files filtered by matching a file attribute. DANGER Be cautious about using this for long lists of files. A list of file IDs is returned. If the result of preceding symbols matches a file set, then files will be listed from that set. Otherwise files in any set are listed. Compulsory following parameters specify an attribute name and a value to match against. Any files where the attribute matches the value will be returned. A further optional following numeric parameter limits the length of the returned list. For example: 'LIST_​ALL_​FILES_​WITH_​FILTER "my_​attibute_​name" "required_​attribute_​value" 10 APPLY_​EACH FILE_​NAME END_​APPLY_​EACH HTML_​UL'. The list can be sorted within the database query using the following symbol AND_​SORT_​BY and Attribute Key, Author Name, Date Added, Filename, File Set Display Order, Size, Title or an attribute name and "Forward" or "Reverse". This symbol can be used in association with AND_​WITH_​FILTER and AND_​EXCLUDE symbols for extended filtering of the list. IMPORTANT Only attributes included in the search index can be used for filtering within this symbol. You may also need to re-run the Index Search Engine job.

LIST_​ALL_​FILES_​WITH_​FILTER_​CONTAINING

Package:
Uber List
Symbol handle:
list_​all_​files_​with_​filter_​containing
Description:
Returns a list of all files filtered by loosely matching a file attribute. DANGER Be cautious about using this for long lists of files. A list of file IDs is returned. If the result of preceding symbols matches a file set, then files will be listed from that set. Otherwise files in any set are listed. Compulsory following parameters specify an attribute name and a value to match against. Any files where the attribute contains the value will be returned. A further optional following numeric parameter limits the length of the returned list. For example: 'LIST_​ALL_​FILES_​WITH_​FILTER_​CONTAINING "my_​attibute_​name" "part_​of_​required_​attribute_​value" 10 APPLY_​EACH FILE_​NAME END_​APPLY_​EACH HTML_​UL'. The list can be sorted within the database query using the following symbol AND_​SORT_​BY and Attribute Key, Author Name, Date Added, Filename, File Set Display Order, Size, Title or an attribute name and "Forward" or "Reverse". This symbol can be used in association with AND_​WITH_​FILTER and AND_​EXCLUDE symbols for extended filtering of the list. IMPORTANT Only attributes included in the search index can be used for filtering within this symbol. You may also need to re-run the Index Search Engine job.

LIST_​ALL_​PAGES

Package:
Magic Data Symbols1
Symbol handle:
list_​all_​pages
Description:
Returns a list of all descendants of a specified page. DANGER Be cautious about using this for long lists of pages. The page IDs of all desacendant pages at all levels beneath the specified page are returned as a list. An optional following numeric parameter limits the length of the returned list. For example: 'SET 1 LIST_​ALL_​PAGES 3 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH HTML_​OL'.

LIST_​ALL_​PAGES_​OF_​TYPE

Package:
Uber List
Symbol handle:
list_​all_​pages_​of_​type
Description:
Returns a list of all descendants of a specified page with a page type. DANGER Be cautious about using this for long lists of pages. The page IDs of all pages at any level beneath the specified page are returned as a list. A compulsory following parameter must specify a page type or list of page types to match against. A further optional following numeric parameter limits the length of the returned list. For example: 'SET 1 LIST_​ALL_​PAGES_​OF_​TYPE "left_​sidebar" 50 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​UL'. The list can be sorted within the database query using the following symbol AND_​SORT_​BY and Date Added, Date Modified, Date Public, Display Order, Name, Public Date, Relevance or an attribute name and "Forward" or "Reverse". This symbol can be used in association with AND_​WITH_​FILTER and AND_​EXCLUDE symbols for extended filtering of the list. IMPORTANT Only attributes included in the search index can be used for filtering within this symbol. You may also need to re-run the Index Search Engine job.

LIST_​ALL_​PAGES_​WITH_​FILTER

Package:
Uber List
Symbol handle:
list_​all_​pages_​with_​filter
Description:
Returns a list of all descendants of a specified page filtered by matching a page attribute. DANGER Be cautious about using this for long lists of pages. The page IDs of all matched pages at any level beneath the specified page are returned as a list. Compulsory following parameters specify an attribute name and a value to match against. A further optional following numeric parameter limits the length of the returned list. For example: 'SET 1 LIST_​ALL_​PAGES_​WITH_​FILTER "my_​attibute_​name" "required_​attribute_​value" 10 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH HTML_​OL'. The list can be sorted within the database query using the following symbol AND_​SORT_​BY and Date Added, Date Modified, Date Public, Display Order, Name, Public Date, Relevance or an attribute name and "Forward" or "Reverse". This symbol can be used in association with AND_​WITH_​FILTER and AND_​EXCLUDE symbols for extended filtering of the list. IMPORTANT Only attributes included in the search index can be used for filtering within this symbol. You may also need to re-run the Index Search Engine job.

LIST_​ALL_​PAGES_​WITH_​FILTER_​CONTAINING

Package:
Uber List
Symbol handle:
list_​all_​pages_​with_​filter_​containing
Description:
Returns a list of all descendants of a specified page filtered by loosely matching a page attribute. DANGER Be cautious about using this for long lists of pages. The page IDs of all pages at any level beneath the specified page are returned as a list. Compulsory following parameters specify an attribute name and a value to match against. Any pages where the attribute contains the value will be returned. A further optional following numeric parameter limits the length of the returned list. For example: 'SET 1 LIST_​ALL_​PAGES_​WITH_​FILTER_​CONTAINING "my_​attibute_​name" "part_​of_​required_​attribute_​value" 10 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​UL'. The list can be sorted within the database query using the following symbol AND_​SORT_​BY and Date Added, Date Modified, Date Public, Display Order, Name, Public Date, Relevance or an attribute name and "Forward" or "Reverse". This symbol can be used in association with AND_​WITH_​FILTER and AND_​EXCLUDE symbols for extended filtering of the list. IMPORTANT Only attributes included in the search index can be used for filtering within this symbol. You may also need to re-run the Index Search Engine job.

LIST_​ALL_​PRODUCT_​SETS

Package:
Magic Data Commerce
Symbol handle:
list_​all_​product_​sets
Description:
Lists all product sets. Lists all product sets. An optional following numeric parameter limits the returned list. For example: 'LIST_​ALL_​PRODUCT_​SETS 20 APPLY_​EACH PRODUCT_​SET_​NAME END_​APPLY_​EACH IMPLODE ", "'.

LIST_​ALL_​USERS

Package:
Magic Data Symbols1
Symbol handle:
list_​all_​users
Description:
Returns a list of all users. DANGER Be very cautious about using this for long lists of users. The user IDs of all users are returned as a list. An optional following numeric parameter limits the returned list. For example: \LIST_​ALL_​USERS 10 APPLY_​EACH EMAIL AS_​LINK END_​APPLY_​EACH IMPLODE ", "'.

LIST_​ALL_​USERS_​WITH_​FILTER

Package:
Uber List
Symbol handle:
list_​all_​users_​with_​filter
Description:
Returns a list of all users filtered by matching a user attribute. DANGER Be cautious about using this for long lists of users. A list of user IDs is returned. If the result of preceding symbols matches a group, then users will be listed from that group. Otherwise users in any group are listed. Compulsory following parameters specify an attribute name and a value to match against. Any users where the attribute matches the value will be returned. A further optional following numeric parameter limits the length of the returned list. For example: 'LIST_​ALL_​USERS_​WITH_​FILTER "my_​attibute_​name" "required_​attribute_​value" 10 APPLY_​EACH USER_​NAME END_​APPLY_​EACH HTML_​UL'. The list can be sorted within the database query using the following symbol AND_​SORT_​BY and Date Added, Email, Last Login, Last Online, Name, Num Logins or an attribute name and "Forward" or "Reverse". This symbol can be used in association with AND_​WITH_​FILTER and AND_​EXCLUDE symbols for extended filtering of the list. IMPORTANT Only attributes included in the search index can be used for filtering within this symbol. You may also need to re-run the Index Search Engine job.

LIST_​ALL_​USERS_​WITH_​FILTER_​CONTAINING

Package:
Uber List
Symbol handle:
list_​all_​users_​with_​filter_​containing
Description:
Returns a list of all users filtered by loosely matching a user attribute. DANGER Be cautious about using this for long lists of users. A list of user IDs is returned. If the result of preceding symbols matches a group, then users will be listed from that group. Otherwise users in any group are listed. Compulsory following parameters specify an attribute name and a value to match against. Any users where the attribute contains the value will be returned. A further optional following numeric parameter limits the length of the returned list. For example: 'LIST_​ALL_​USERS_​WITH_​FILTER_​CONTAINING "my_​attibute_​name" "part_​of_​required_​attribute_​value" 10 APPLY_​EACH USER_​NAME END_​APPLY_​EACH HTML_​UL'. The list can be sorted within the database query using the following symbol AND_​SORT_​BY and Date Added, Date Modified, Date Public, Display Order, Name, Public Date, Relevance or an attribute name and "Forward" or "Reverse". This symbol can be used in association with AND_​WITH_​FILTER and AND_​EXCLUDE symbols for extended filtering of the list. IMPORTANT Only attributes included in the search index can be used for filtering within this symbol. You may also need to re-run the Index Search Engine job.

LIST_​ANCESTOR_​PAGES

Package:
Magic Data Symbols1
Symbol handle:
list_​ancestor_​pages
Description:
List pages leading to a specified page. Taking the previous result as a page, all ancestor pages leading to the page are returned as a list. An optional following numeric parameter limits the returned list and defaults to 1. For example: 'SET 'Hello World' AS_​PAGE LIST_​ANCESTOR_​PAGES 3 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH IMPLODE ' > ' ' will give a breadcrumb trail.

LIST_​ANCESTOR_​PAGES_​WITH_​ATTRIBUTE

Package:
Magic Data Symbols1
Symbol handle:
list_​ancestor_​pages_​with_​attribute
Description:
List pages leading to a specified page with an attribute. Taking the previous result as a page and the following parameter as an attribute. All ancestor pages leading to the page and having that attribute are returned as a list. A further optional following numeric parameter limits the returned list and defaults to 1. For example: 'SET 'Hello World' AS_​PAGE LIST_​ANCESTOR_​PAGES_​WITH_​ATTRIBUTE "my_​attribute" 10 '.

LIST_​API_​SERVERS

Package:
Black Magic Data
Symbol handle:
list_​api_​servers
Description:
List configured API servers. Lists API servers, as configured through %sAPI Clients and Servers%s. An optional following partameter limits the length of the list. For example: 'LIST_​API_​SERVERS 10 APPLY_​EACH WITH_​API_​SERVER END_​APPLY_​EACH'. For example: 'LIST_​API_​SERVERS 10 APPLY_​EACH WITH_​API_​SERVER SET "home" API_​EVALUATE AS_​PAGE PAGE OWNER USERNAME API_​EVALUATE_​END . " on " . ( CURRENT_​API_​SERVER ) END_​APPLY_​EACH HTML_​UL'.

LIST_​AREAS

Package:
Universal Content Puller Sources1
Symbol handle:
list_​areas
Description:
Returns a list of regular areas. Lists all regular page areas by name (ie not global areas). An optional following numeric parameter limits the list and defaults to 1. For example: 'LIST_​AREAS 15'.

LIST_​BADGES

Package:
Magic Data Developer
Symbol handle:
list_​badges
Description:
A user's concrete5 badges. Using the result of preceding symbols as user on concrete5.org, returns a list of the user's badges or null. The context will be 'Badge' or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​BADGES 100 APPLY_​EACH BADGE_​NAME END_​APPLY_​EACH HTML_​OL'.

LIST_​BLOCKS

Package:
Universal Content Puller
Symbol handle:
list_​blocks
Description:
Lists the blocks in a stack or area. Given a stack, global area or page, will list the blocks in that stack, global area or an area or the page. For pages, an optional following parameter can specify an area of the page and defaults to 'Main'. A further optional following parameter limits the number of blocks returned and defaults to 1. For example: 'SET "Blog" AS_​PAGE LIST_​BLOCKS "Sidebar" 2'.

LIST_​BLOCKS_​OF_​TYPE

Package:
Universal Content Puller
Symbol handle:
list_​blocks_​of_​type
Description:
Lists the blocks in a stack from a list of block types. Given a stack, global area or page, will list the blocks in that stack, global area or an area or the page. The immediately following parameter should list one or more block types by name or handle. The list of blocks returned will be limited to those specified. For pages, the next optional following parameter can specify an area of the page and defaults to 'Main'. A further optional following parameter limits the number of blocks returned and defaults to 1. For example: 'SET 1 AS_​PAGE LIST_​BLOCKS_​OF_​TYPE "Content,html" "Sidebar" 2'.

LIST_​BLOCK_​DATA_​ITEMS

Package:
Universal Content Puller
Symbol handle:
list_​block_​data_​items
Description:
List the data items available for a block. Takes the result of preceding symbols as a block and lists the names of block data items (as in the block XML). For example: 'PAGE PARENT LIST_​BLOCKS "Main" 1 LIST_​BLOCK_​DATA_​ITEMS'.

LIST_​CERTIFICATIONS

Package:
Magic Data Developer
Symbol handle:
list_​certifications
Description:
A user's concrete5 certifications. Using the result of preceding symbols as user on concrete5.org, returns a list of the user's certifications or null. The context will be 'C5Certification' or null. An optional following numeric parameter limits the returned list. For example: 'SET '51576 ' AS_​C5_​USER LIST_​CERTIFICATIONS 20 APPLY_​EACH CERTIFICATION_​NAME END_​APPLY_​EACH HTML_​OL'.

LIST_​CONTAINS

Package:
Magic Data Symbols1
Symbol handle:
list_​contains
Description:
Checks if a list contains an item. Takes the previous result as a list and checks if the following parameter is in the list, returning the following parameter as the equivalent of true or null. The context remains that of the preceding list. This is the opposite of IN_​LIST. For example: 'Administrators AS_​GROUP LIST_​USERS 10 LIST_​CONTAINS ( JohnTheFish AS_​UID )'.

LIST_​COUNTRIES

Package:
Country State Manager
Symbol handle:
list_​countries
Description:
Provides a list of countries Provides a list of countries as country codes. An optional following parameter limits the length of the list. For example: 'LIST_​COUNTRIES APPLY_​EACH COUNTRY_​NAME END_​APPLY_​EACH HTML_​OL'.

LIST_​ENV_​DATA_​KEYS

Package:
Blocks by AJAX
Symbol handle:
list_​env_​data_​keys
Description:
List the keys from ENV data. Lists all keys in the ENV data, returning its value as a single item or list, or null. For example: 'LIST_​ENV_​DATA_​KEYS APPLY_​EACH FROM_​ENV_​DATA END_​APPLY_​EACH IMPLODE'.

LIST_​FILES

Package:
Magic Data Symbols1
Symbol handle:
list_​files
Description:
Returns a list of files in a fileset. DANGER Be very cautious about using this for long lists of files. The file IDs of all files in a set are returned as a list in database order. An optional following numeric parameter limits the returned list. For example: 'banners LIST_​FILES 10 APPLY_​EACH FILE_​NAME END_​APPLY_​EACH HTML_​OL'.

LIST_​FILESETS

Package:
Magic Data Symbols1
Symbol handle:
list_​filesets
Description:
Returns a list of filesets. Given a user, the fileset IDs of all filesets available to a user are returned as a list. Given a file, the fileset IDs of all filesets the file is a member is in are returned as a list. An optional following numeric parameter limits the returned list. For example: 'UID LIST_​FILESETS 3 APPLY_​EACH FILE_​NAME END_​APPLY_​EACH IMPLODE ", "'.

LIST_​FILES_​IN_​DISPLAY_​ORDER

Package:
Magic Data Symbols1
Symbol handle:
list_​files_​in_​display_​order
Description:
Returns a list of files in a fileset. DANGER Be very cautious about using this for long lists of files. The file IDs of all files in a set are returned as a list in display order. An optional following numeric parameter limits the returned list. For example: 'banners LIST_​FILES_​IN_​DISPLAY_​ORDER 10 APPLY_​EACH FILE_​NAME END_​APPLY_​EACH HTML_​OL'.

LIST_​FORMS

Package:
Magic Data Forms
Symbol handle:
list_​forms
Description:
List all forms by name. Takes the result of preceding symbols as a form interface and returns a list of all forms for that interface or (if not set), for the current interface. An optional following numeric parameter limits the size of the returned list and defaults to 1. For example: 'SET 'core_​form' WITH_​FORM_​INTERFACE LIST_​FORMS 10'

LIST_​FORM_​FIELDS

Package:
Magic Data Forms
Symbol handle:
list_​form_​fields
Description:
List all fields of a form. Takes the result of preceding symbols as a form name and returns a list of fields for the current form interface. If no form name is specified, uses the currently set form name. An optional following numeric parameter limits the size of the returned list and defaults to 1. For example: 'SET 'core_​form' WITH_​FORM_​INTERFACE SET "Contact Us" WITH_​FORM LIST_​FORM_​FIELDS 10'

LIST_​FORM_​INTERFACES

Package:
Magic Data Forms
Symbol handle:
list_​form_​interfaces
Description:
List form interfaces. Returns a list of form interfaces by handle. An optional following numeric parameter limits the size of the returned list and defaults to 1. For example: 'LIST_​FORM_​INTERFACES 10'

LIST_​FORM_​RESPONSES

Package:
Magic Data Forms
Symbol handle:
list_​form_​responses
Description:
List all responses to a form. Takes the result of preceding symbols as a form name and returns a list of responses for the current form interface. If no form name is specified, uses the currently set form name. An optional following numeric parameter limits the size of the returned list and defaults to 1. For example: 'SET 'core_​form' AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM LIST_​FORM_​RESPONSES 3'

LIST_​FORM_​RESPONSES_​AFTER

Package:
Magic Data Forms
Symbol handle:
list_​form_​responses_​after
Description:
List a user's responses. Takes the result of preceding symbols as date or time and list responses to the current form since that date. An optional following numeric parameter limits the size of the returned list to the most recent responses and defaults to 1. For example: 'SET 'core_​form' AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM "last week" AS_​TIME LIST_​FORM_​RESPONSES_​AFTER 20'

LIST_​FORM_​RESPONSES_​FOR_​USER

Package:
Magic Data Forms
Symbol handle:
list_​form_​responses_​for_​user
Description:
List a user's responses. Takes the result of preceding symbols as user and list responses by the user to the current form. An optional following numeric parameter limits the size of the returned list to the most recent responses and defaults to 1. For example: 'SET 'core_​form' AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM USER LIST_​FORM_​RESPONSES_​FOR_​USER 3'

LIST_​FORM_​RESPONSES_​MATCHING_​VALUE

Package:
Magic Data Forms
Symbol handle:
list_​form_​responses_​matching_​value
Description:
List responses to a form where a specific field has a specific value. Using the current form, takes the result of preceding symbols as a field and the following symbol as the desired value, returning the rersponses matching the value. A second optional following numeric parameter limits the size of the returned list to the most recent responses and defaults to 1. The name and value may optionally be specified the other way round. For example: 'SET "core_​form" AS_​FORM_​INTERFACE SET "Contact Us" AS_​FORM SET "Name" LIST_​FORM_​RESPONSES_​MATCHING_​VALUE "JohntheFish" 5'

LIST_​GET_​DATA_​KEYS

Package:
Blocks by AJAX
Symbol handle:
list_​get_​data_​keys
Description:
List the keys from GET data. Lists all keys in the GET data, returning its value as a single item or list, or null. For example: 'LIST_​GET_​DATA_​KEYS APPLY_​EACH FROM_​GET_​DATA END_​APPLY_​EACH IMPLODE'.

LIST_​GLOBAL_​AREAS

Package:
Universal Content Puller
Symbol handle:
list_​global_​areas
Description:
Returns a list of all global areas. Lists all global areas by ID. An optional following numeric parameter limits the list and defaults to 1. For example: 'LIST_​GLOBAL_​AREAS 10'.

LIST_​GROUPS

Package:
Magic Data Symbols1
Symbol handle:
list_​groups
Description:
List the groups a user belongs to. Tries to find the result of preceeding symbols as a user and returns a list of group IDs or null. Sets the context as 'Group' or null.

LIST_​INSTALLED_​BLOCK_​TYPES

Package:
Magic Data Developer
Symbol handle:
list_​installed_​block_​types
Description:
List of blocks in a package. Using the result of preceding symbols an installed package, returns a list of the block types installed or null. The context will be 'Block' or null. For example: 'SET 'magic data' AS_​INSTALLED_​PACKAGE LIST_​INSTALLED_​BLOCK_​TYPES 100 APPLY_​EACH BLOCK_​TYPE_​NAME END_​APPLY_​EACH HTML_​OL'.

LIST_​MARKETPLACE_​ITEMS

Package:
Magic Data Developer
Symbol handle:
list_​marketplace_​items
Description:
A user's concrete5 marketplace items. Using the result of preceding symbols as user on concrete5.org, returns a list of the user's marketplace items or null. The context will be 'MarketplaceItem' or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​MARKETPLACE_​ITEMS 10 APPLY_​EACH MARKETPLACE_​NAME END_​APPLY_​EACH IMPLODE_​NICELY'.

LIST_​ORDER

Package:
Magic Data Commerce
Symbol handle:
list_​order
Description:
Returns a list of the products in the cart or an order. The product IDs of all products in the cart or order are returned as a list. For example: 'WITH_​CART LIST_​ORDER IMPLODE'.

LIST_​ORDERS

Package:
Magic Data Commerce
Symbol handle:
list_​orders
Description:
Returns a list of all orders for the current user. The current user's orders are returned as a list. Optional following numeric parameter limit the returned list and filter by order status as any of the order statuses supported. For example: 'LIST_​ORDERS 1 INDEX 1 WITH_​ORDER LIST_​ORDER APPLY_​EACH PRODUCT_​NAME END_​APPLY_​EACH IMPLODE ", "'.

LIST_​PAGES

Package:
Magic Data Symbols1
Symbol handle:
list_​pages
Description:
Returns a list of pages beneath a specified page. DANGER Be cautious about using this for long lists of pages. The page IDs of all pages are returned as a list. An optional following numeric parameter limits the length of the returned list. For example: 'SET 1 LIST_​PAGES 3 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH IMPLODE ", "'. An second optional parameter may provide the number of levels to list as a negative number and defaults to -1. For example: 'HOME_​PAGE LIST_​PAGES 100 -3 SORT_​BY PAGE_​NAME END_​SORT_​BY APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH HTML_​OL'.

LIST_​PAGES_​OF_​TYPE

Package:
Magic Data Symbols1
Symbol handle:
list_​pages_​of_​type
Description:
Returns a list of pages of a specified type beneath a specified page. DANGER Be very cautious about using this for long lists of pages. The page IDs of all pages are returned as a list. A following parameter must be a page type and an optional additional following numeric parameter limits the returned list. For example: 'SET 1 LIST_​PAGES_​OF_​TYPE "left_​sidebar" 3 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH IMPLODE ", "'.

LIST_​PAGE_​AREAS

Package:
Universal Content Puller Sources1
Symbol handle:
list_​page_​areas
Description:
Returns a list of not-empty areas on a page. Taking the result of previous symbols as a page, lists all areas on the page, including global areas, that contain one or more blocks. An optional following numeric parameter limits the list and defaults to 1. For example: 'SET "about" AS_​PAGE LIST_​PAGE_​AREAS 15'.

LIST_​PAGE_​GLOBAL_​AREAS

Package:
Universal Content Puller Sources1
Symbol handle:
list_​page_​global_​areas
Description:
Returns a list of not-empty global areas on a page. Taking the result of previous symbols as a page, lists all global areas on the page that contain one or more blocks. An optional following numeric parameter limits the list and defaults to 1. For example: 'SET "about" AS_​PAGE LIST_​PAGE_​GLOBAL_​AREAS 15'.

LIST_​PAGE_​REGULAR_​AREAS

Package:
Universal Content Puller Sources1
Symbol handle:
list_​page_​regular_​areas
Description:
Returns a list of not-empty regular areas on a page. Taking the result of previous symbols as a page, lists all regular areas on the page that contain one or more blocks. An optional following numeric parameter limits the list and defaults to 1. For example: 'SET "about" AS_​PAGE LIST_​PAGE_​REGULAR_​AREAS 15'.

LIST_​POST_​DATA_​KEYS

Package:
Blocks by AJAX
Symbol handle:
list_​post_​data_​keys
Description:
List the keys from POST data. Lists all keys in the POST data, returning its value as a single item or list, or null. For example: 'LIST_​POST_​DATA_​KEYS IMPLODE'.

LIST_​PRODUCTS

Package:
Magic Data Commerce
Symbol handle:
list_​products
Description:
Returns a list of all products. DANGER Be very cautious about using this for long lists of products. The product IDs of all products in are returned as a list. An optional following numeric parameter limits the returned list. For example: 'LIST_​PRODUCTS 10 APPLY_​EACH PRODUCT_​NAME END_​APPLY_​EACH IMPLODE ", "'.

LIST_​PRODUCTS_​PURCHASED

Package:
Magic Data Commerce
Symbol handle:
list_​products_​purchased
Description:
Returns a list of all products purchased. The current user's orders are combined into a list of all products previously purchased. An optional following numeric parameter limits the returned list and an optional status parameter filters by order status as any of the order statuses supported. For example: 'LIST_​PRODUCTS_​PURCHASED "Shipped" APPLY_​EACH PRODUCT_​PAGE_​LINK END_​APPLY_​EACH HTML_​UL'.

LIST_​PRODUCT_​SET

Package:
Magic Data Commerce
Symbol handle:
list_​product_​set
Description:
Returns a list of the products in a product set. DANGER Be very cautious about using this for big product sets. The product IDs of all products in the product set are returned as a list. An optional following numeric parameter limits the returned list. For example: '"mandarin ducks" LIST_​PRODUCT_​SET APPLY_​EACH PRODUCT_​NAME END_​APPLY_​EACH IMPLODE ", "'.

LIST_​PRODUCT_​SETS

Package:
Magic Data Commerce
Symbol handle:
list_​product_​sets
Description:
Lists all sets a product is in. Taking the previous result as a product, lists all product sets the product is a member of. An optional following numeric parameter limits the returned list. For example: 'SET "marvin mandarin" AS_​PRODUCT LIST_​PRODUCT_​SETS 20 APPLY_​EACH PRODUCT_​SET_​NAME END_​APPLY_​EACH IMPLODE ", "'.

LIST_​RECENT_​COMMON_​PURCHASED_​PRODUCTS

Package:
Magic Data Commerce
Symbol handle:
list_​recent_​common_​purchased_​products
Description:
Returns a list of recent most commonly purchased products. DANGER Be very cautious about using this for long lists of products. The product IDs of all products in are returned as a list with the most commonly purchased product first. Products are only counted once for each cart, no matter how many were added to the cart. The immediately following parameter is either a date/time or a negative number of days to limit how far back the list should go. An optional following numeric parameter limits the returned list. For example: 'LIST_​RECENT_​COMMON_​PURCHASED_​PRODUCTS -30 10 APPLY_​EACH PRODUCT_​NAME END_​APPLY_​EACH HTML_​OL' will list the top purchases for the last 30 days.

LIST_​RECENT_​PAGES

Package:
Magic Data Symbols1
Symbol handle:
list_​recent_​pages
Description:
Returns a list of pages beneath a specified page. DANGER Be very cautious about using this for long lists of pages. The page IDs of all pages are returned as a list with the most recently added page first. An optional following numeric parameter limits the returned list. For example: 'SET 1 LIST_​RECENT_​PAGES 3 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH IMPLODE_​NICELY'.

LIST_​RECENT_​PAGES_​OF_​TYPE

Package:
Magic Data Symbols1
Symbol handle:
list_​recent_​pages_​of_​type
Description:
Returns a list of pages of a specified type beneath a specified page. DANGER Be very cautious about using this for long lists of pages. The page IDs of all pages are returned as a list with the most recently added page first. A following parameter must be a page type and an optional additional following numeric parameter limits the returned list. For example: 'SET /blog AS_​PAGE LIST_​RECENT_​PAGES_​OF_​TYPE "Blog Entry" 2 APPLY_​EACH PAGE_​NAME END_​APPLY_​EACH IMPLODE_​NICELY'.

LIST_​RECENT_​PRODUCTS

Package:
Magic Data Commerce
Symbol handle:
list_​recent_​products
Description:
Returns a list of products, most recently added first. DANGER Be very cautious about using this for long lists of products. The product IDs of all products in are returned as a list, ordered with the most recent first. An optional following numeric parameter limits the returned list. For example: 'LIST_​RECENT_​PRODUCTS 10 APPLY_​EACH PRODUCT_​NAME END_​APPLY_​EACH IMPLODE ", "'.

LIST_​RECENT_​TOP_​PURCHASED_​PRODUCTS

Package:
Magic Data Commerce
Symbol handle:
list_​recent_​top_​purchased_​products
Description:
Returns a list of recent top purchased products. DANGER Be very cautious about using this for long lists of products. The product IDs of all products in are returned as a list with the top purchased product first. The immediately following parameter is either a date/time or a negative number of days to limit how far back the list should go. An optional following numeric parameter limits the returned list. For example: 'LIST_​RECENT_​TOP_​PURCHASED_​PRODUCTS -30 10 APPLY_​EACH PRODUCT_​NAME END_​APPLY_​EACH HTML_​OL' will list the top purchases for the last 30 days.

LIST_​REQUEST_​DATA_​KEYS

Package:
Blocks by AJAX
Symbol handle:
list_​request_​data_​keys
Description:
List the keys from REQUEST data. Lists all keys in the REQUEST data, returning its value as a single item or list, or null. For example: 'LIST_​REQUEST_​DATA_​KEYS APPLY_​EACH FROM_​REQUEST_​DATA END_​APPLY_​EACH HTML_​UL'.

LIST_​SALE_​PRODUCTS

Package:
Magic Data Commerce
Symbol handle:
list_​sale_​products
Description:
Returns a list of sale products. DANGER Be very cautious about using this for long lists of products. The product IDs of all sale products in are returned as a list. An optional following numeric parameter limits the returned list. For example: 'LIST_​SALE_​PRODUCTS 5 APPLY_​EACH PRODUCT_​NAME END_​APPLY_​EACH IMPLODE ", "'.

LIST_​SERVER_​DATA_​KEYS

Package:
Blocks by AJAX
Symbol handle:
list_​server_​data_​keys
Description:
List the keys from SERVER data. Lists all keys in the SERVER data, returning its value as a single item or list, or null. For example: 'LIST_​SERVER_​DATA_​KEYS APPLY_​EACH FROM_​SERVER_​DATA END_​APPLY_​EACH IMPLODE'.

LIST_​SESSION_​DATA_​KEYS

Package:
Blocks by AJAX
Symbol handle:
list_​session_​data_​keys
Description:
List the keys from SESSION data. Lists all keys in the SESSION data, returning its value as a single item or list, or null. For example: 'LIST_​SESSION_​DATA_​KEYS APPLY_​EACH FROM_​SESSION_​DATA END_​APPLY_​EACH IMPLODE'.

LIST_​SHOWCASE_​SITES

Package:
Magic Data Developer
Symbol handle:
list_​showcase_​sites
Description:
A user's concrete5 showcase items. Using the result of preceding symbols as user on concrete5.org, returns a list of the user's showcase sites or null. The context will be 'ShowcaseSite' or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​SHOWCASE_​SITES 5 APPLY_​EACH SHOWCASE_​ICON_​LINK END_​APPLY_​EACH HTML_​OL '.

LIST_​STACKS

Package:
Universal Content Puller
Symbol handle:
list_​stacks
Description:
Returns a list of all stacks. Lists all stacks by ID. An optional following numeric parameter limits the list and defaults to 1. For example: 'LIST_​STACKS 20'.

LIST_​STATES

Package:
Country State Manager
Symbol handle:
list_​states
Description:
List the states in a country Given a country, returns a list of the states in the country. An optional following parameter limits the length of the list. For example: 'SET "United Kingdom" AS_​COUNTRY LIST_​STATES 200 APPLY_​EACH STATE_​NAME END_​APPLY_​EACH HTML_​OL'.

LIST_​TOP_​PURCHASED_​PRODUCTS

Package:
Magic Data Commerce
Symbol handle:
list_​top_​purchased_​products
Description:
Returns a list of top purchased products. DANGER Be very cautious about using this for long lists of products. The product IDs of all products in are returned as a list with the top purchased product first. An optional following numeric parameter limits the returned list. For example: 'LIST_​TOP_​PURCHASED_​PRODUCTS 1 PRODUCT_​NAME'.

LIST_​UID_​FILESETS

Package:
Black Magic Data
Symbol handle:
list_​uid_​filesets
Description:
Lists all filesets Takes the result of preceding symbols as a fileset name and lists all uID suffixed filesets that begin with that name. Returns a list of fileset IDs or null. An optional following parameter limits the size of the list and defaults to 1. For example: 'SET "Special Files" LIST_​UID_​FILESETS APPLY_​EACH FILESET_​NAME END_​APPLY_​EACH HTML_​OL'.

LIST_​USERS

Package:
Magic Data Symbols1
Symbol handle:
list_​users
Description:
Returns a list of users in a group. DANGER Be very cautious about using this for long lists of users. The user IDs of all users in a group are returned as a list. An optional following numeric parameter limits the returned list. For example: 'Administrators AS_​GROUP LIST_​USERS 10 APPLY_​EACH EMAIL AS_​LINK END_​APPLY_​EACH IMPLODE ", "'.

LIST_​VISITED_​PAGES

Package:
Magic Data Symbols1
Symbol handle:
list_​visited_​pages
Description:
Returns a list of pages visited by the current user. DANGER This could be a very time consuming query in the PageStatistics table. The page IDs of pages visited by the current user are returned as a list, sorted by most visited. An optional following numeric parameter limits the returned list. This symbol uses the PageStatistics table, so will only give a result if PageStatistics are enabled. For example: 'LIST_​VISITED_​PAGES 10 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH HTML_​OL'.

LIST_​VISITED_​PAGES_​ALL

Package:
Magic Data Symbols1
Symbol handle:
list_​visited_​pages_​all
Description:
Returns a list of pages visited. DANGER This could be a very time consuming query in the PageStatistics table. The page IDs of pages visited by any user are returned as a list, sorted by most visited. An optional following numeric parameter limits the returned list. This symbol uses the PageStatistics table, so will only give a result if PageStatistics are enabled. For example: 'LIST_​VISITED_​PAGES_​ALL 10 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH HTML_​OL'.

LIST_​VISITED_​PAGES_​ALL_​OF_​TYPE

Package:
Magic Data Symbols1
Symbol handle:
list_​visited_​pages_​all_​of_​type
Description:
Returns a list of pages of a specified type visited by any user. DANGER This could be a very time consuming query involving both the PageStatistics table and CollectionVersions table. The page IDs of pages visited are returned as a list, sorted by most visited. A following parameter must be a page type and an optional additional following numeric parameter limits the returned list. This symbol uses the PageStatistics table, so will only give a result if PageStatistics are enabled. For example: 'LIST_​VISITED_​PAGES_​ALL_​OF_​TYPE "Right Sidebar" 10 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH HTML_​OL'.

LIST_​VISITED_​PAGES_​BY_​DATE

Package:
Magic Data Symbols1
Symbol handle:
list_​visited_​pages_​by_​date
Description:
Returns a list of pages visited by the current user. DANGER This could be a very time consuming query in the PageStatistics table. The page IDs of pages visited by the current user are returned as a list, sorted by date. An optional following numeric parameter limits the returned list. This symbol uses the PageStatistics table, so will only give a result if PageStatistics are enabled. For example: 'LIST_​VISITED_​PAGES_​BY_​DATE 10 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH HTML_​OL'.

LIST_​VISITED_​PAGES_​BY_​DATE_​ALL

Package:
Magic Data Symbols1
Symbol handle:
list_​visited_​pages_​by_​date_​all
Description:
Returns a list of pages visited. DANGER This could be a very time consuming query in the PageStatistics table. The page IDs of pages visited by any user are returned as a list, sorted by date. An optional following numeric parameter limits the returned list. This symbol uses the PageStatistics table, so will only give a result if PageStatistics are enabled. For example: 'LIST_​VISITED_​PAGES_​BY_​DATE_​ALL 10 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH HTML_​OL'.

LIST_​VISITED_​PAGES_​OF_​TYPE

Package:
Magic Data Symbols1
Symbol handle:
list_​visited_​pages_​of_​type
Description:
Returns a list of pages of a specified type visited by the current user. DANGER This could be a very time consuming query involving both the PageStatistics table and CollectionVersions table. The page IDs of pages visited by the current user are returned as a list, sorted by most visited. A following parameter must be a page type and an optional additional following numeric parameter limits the returned list. This symbol uses the PageStatistics table, so will only give a result if PageStatistics are enabled. For example: 'LIST_​VISITED_​PAGES_​OF_​TYPE "Right Sidebar" 10 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH HTML_​OL'.

LIST_​VISITED_​PRODUCTS

Package:
Magic Data Commerce
Symbol handle:
list_​visited_​products
Description:
Returns a list of most visited products. DANGER Be very cautious about using this for long lists of products. The product IDs of all products in are returned as a list with the most visited proiduct first. An optional following numeric parameter limits the returned list. For example: 'LIST_​VISITED_​PRODUCTS 5 APPLY_​EACH PRODUCT_​NAME END_​APPLY_​EACH IMPLODE ", "'.

LNG_​FROM_​LATLNG

Package:
Sorcerer's Map
Symbol handle:
lng_​from_​latlng
Description:
Gets the longitude part of a Lat/Lng pair. Takes a latitude/longitude pair as returned by GEO_​LATLNG and returns just the longitude. For example: 'UID ATTRIBUTE "Address" GEO_​LATLNG LNG_​FROM_​LATLNG'.

LOAD_​TEXT_​FILE

Package:
Universal Content Puller Sources2
Symbol handle:
load_​text_​file
Description:
Load a text file. Tries to find the result of preceding symbols as a File ID and returns the content of that file. For example: 'SET "my_​text.txt" AS_​FILE LOAD_​TEXT_​FILE SANITIZE '. NOTE The file content may need to be sanitized before display.

LOCALE

Package:
Magic Data Symbols1
Symbol handle:
locale
Description:
Returns the current locale. Locale is returned in the format en_​US.

LOG

Package:
Magic Data Developer
Symbol handle:
Log
Description:
Make a note in the concrete5 log. Records the previous result in the concrete5 log and return the previous result.

LOG_​DEBUG

Package:
Magic Data Developer
Symbol handle:
log_​debug
Description:
Trace debug to the log. Debug trace is logged until END_​LOG_​DEBUG. The previous result and context are preserved. Can be useful to target logging of the debug trace to problem areas during development of expressions. For example: 'SET /about AS_​PAGE PAGE_​DESCRIPTION LOG_​DEBUG TRUNCATE_​TO_​WORD 10 END_​LOG_​DEBUG'.

LT

Package:
Magic Data Symbols1
Symbol handle:
lt
Description:
Tests for less than. Comparison between the result of preceding symbols and the next symbol is tested using a '<' comparison, returning the previous result value as an equivalent of true. Comparison is made as text strings. However, if both values are numeric a numeric comparison is made.

MAGIC_​DATA_​FILL

Package:
Black Magic Data
Symbol handle:
magic_​data_​fill
Description:
Processes Magic Data tokens in text Takes the result of preceding symbols as text and processes any Magic Data tokens embedded within that text, returning the filled text. For example: 'SET "My name is [%UID USERNAME%] and I came from Magic Data" MAGIC_​DATA_​FILL' A more useful example, where a page attribute contains text including Magic Data tokens: 'PAGE ATTRIBUTE "My attribute containing tokens" MAGIC_​DATA_​FILL' WARNING Be careful about evaluating Magic Data originating from a user input. It could break the security of your site.

MAKE_​TEMPLATE_​STICKY

Package:
Magic Data Templates1
Symbol handle:
make_​template_​sticky
Description:
Make a template sticky Makes Magic Data template styling sticky, so that styling persists through all following Magic Data enabled templates. Returns the previous result. An optional following parameter can be used to set a template key and defaults to outer. The template key can be any one of inner, outer, all_​list_​inner, all_​list_​outer. For example: 'SET "my_​outer_​class" SET_​TEMPLATE_​CLASS MAKE_​TEMPLATE_​STICKY'.

MARKETPLACE_​BODY

Package:
Magic Data Developer
Symbol handle:
marketplace_​body
Description:
The body from the marketplace page Using the result of preceding symbols as a marketplace item or package, returns the body text from the marketplace page. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​BODY'.

MARKETPLACE_​DESCRIPTION

Package:
Magic Data Developer
Symbol handle:
marketplace_​description
Description:
Returns marketplace item or package description. Using the result of preceding symbols as a marketplace item or package, returns the marketplace or package description or null. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​DESCRIPTION'.

MARKETPLACE_​ICON

Package:
Magic Data Developer
Symbol handle:
marketplace_​icon
Description:
Gets the icon for a package or marketplace item. Using the result of preceding symbols as a marketplace item or package, returns the associated icon or null. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​ICON'. For example: 'SET 'jl_​magic_​data' AS_​INSTALLED_​PACKAGE MARKETPLACE_​ICON'.

MARKETPLACE_​NAME

Package:
Magic Data Developer
Symbol handle:
marketplace_​name
Description:
Returns marketplace item or package name. Using the result of preceding symbols as a marketplace item or package, returns the marketplace or package item name or null. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​NAME'.

MARKETPLACE_​NUMBER_​RATINGS

Package:
Magic Data Developer
Symbol handle:
marketplace_​number_​ratings
Description:
The number of ratrings posted for a marketplace item. Using the result of preceding symbols as a marketplace item or package, returns the number of ratings made for the item. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​NUMBER_​RATINGS '.

MARKETPLACE_​PRICE

Package:
Magic Data Developer
Symbol handle:
marketplace_​price
Description:
The price in the marketplace Using the result of preceding symbols as a marketplace item or package, returns the price quoted on the marketplace page. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​PRICE'.

MARKETPLACE_​RATING

Package:
Magic Data Developer
Symbol handle:
marketplace_​rating
Description:
The rating for a marketplace item. Using the result of preceding symbols as a marketplace item or package, returns the rating for the marketplace item as a percentage. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​RATING AS_​RATING'.

MARKETPLACE_​REVIEWS_​URL

Package:
Magic Data Developer
Symbol handle:
marketplace_​reviews_​url
Description:
Returns a URL for the marketplace review page. Using the result of preceding symbols as a marketplace item or package, returns a URL for the marketplace review page. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​REVIEWS_​URL'.

MARKETPLACE_​SCREENSHOT

Package:
Magic Data Developer
Symbol handle:
marketplace_​screenshot
Description:
A screenshot from the marketplace Using the result of preceding symbols as a marketplace item or package, returns a marketplace screenshot for the item. An optional following parameter indexes into the screenshots. WARNING Screenshots will have been cropped to fit a 400 pixel box. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​SCREENSHOT 2'.

MARKETPLACE_​URL

Package:
Magic Data Developer
Symbol handle:
marketplace_​url
Description:
Returns a URL for the marketplace page. Using the result of preceding symbols as a marketplace item or package, returns a URL for the marketplace page. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​URL'. For example: 'SET 'jl_​magic_​data' AS_​INSTALLED_​PACKAGE MARKETPLACE_​URL'.

MARKETPLACE_​VERSION

Package:
Magic Data Developer
Symbol handle:
marketplace_​version
Description:
Returns marketplace item or package version. Using the result of preceding symbols as a marketplace item or package, returns the marketplace or package version or null. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​VERSION'. For example: 'SET 'jl_​magic_​data' AS_​INSTALLED_​PACKAGE MARKETPLACE_​VERSION'.

MARKETPLACE_​VERSION_​HISTORY

Package:
Magic Data Developer
Symbol handle:
marketplace_​version_​history
Description:
The version history for a marketplace item. Using the result of preceding symbols as a marketplace item or package, returns the version history text from the marketplace. For example: 'SET 'jl_​magic_​data' AS_​MARKETPLACE_​ITEM MARKETPLACE_​VERSION_​HISTORY'.

MATCHES_​REGEX

Package:
Black Magic Data
Symbol handle:
matches_​regex
Description:
Tests for a string matching a regular expression. Tests whether text from the preceding result matches a regular expression from the following parameter, returning the previous result as an equivalent of true. For example: 'SET "Some more new content" MATCHES_​REGEX "/more/"'. DANGER Faulty use of this symbol can break your site.

MAXMIND_​CITY

Package:
MaxMind IP-GeoLoc
Symbol handle:
maxmind_​city
Description:
Look up the city for an IP adddress. Taking the previous result as an IP address, looks up the address in the maxmind database and returns the city name or null. An optional following parameter can be used to request a language by 2-character country code (and if the language is available). For example: 'SET '50.28.56.20' AS_​IP MAXMIND_​CITY' will look up the city for concret5's IP address. For example: 'IP_​ADDRESS MAXMIND_​CITY fr' will look up the city for the current visitors IP address and, if available, return the name in French.

MAXMIND_​COUNTRY

Package:
MaxMind IP-GeoLoc
Symbol handle:
maxmind_​country
Description:
Look up the country for an IP adddress. Taking the previous result as an IP address, looks up the address in the maxmind database and returns the country name or null. An optional following parameter can be used to request a language by 2-character country code (and if the language is available). For example: 'SET '50.28.56.20' AS_​IP MAXMIND_​COUNTRY' will look up the country for concrete5's IP address. For example: 'IP_​ADDRESS MAXMIND_​COUNTRY fr' will look up the country for the current visitors IP address and, if available, return the name in French.

MAXMIND_​COUNTRY_​CODE

Package:
MaxMind IP-GeoLoc
Symbol handle:
maxmind_​country_​code
Description:
Look up the country code for an IP adddress. Taking the previous result as an IP address, looks up the address in the maxmind database and returns the country code. For example: 'SET '50.28.56.20' AS_​IP MAXMIND_​COUNTRY_​CODE'.

MAY_​VIEW_​BLOCK

Package:
Universal Content Puller
Symbol handle:
may_​view_​block
Description:
Given a block, confirms the current user can view it. Takes the result of preceding symbols as a block and confirms it is visible to the current user. Returns the block id as true, or null as false. For example: 'PAGE PARENT LIST_​BLOCKS "Main" 1 MAY_​VIEW_​BLOCK ZERO_​AS_​THEN_​END 'Invisible' RENDER_​BLOCK '.

MERGE

Package:
Magic Data Symbols1
Symbol handle:
merge
Description:
Merge two lists together. Takes the previous result as a list or single item and the following parameter as a list or single item and merges them into a single list with duplicates and null entries removed. The context remains that of the preceding list. Also see APPEND for combining lists without removing duplicates. For example: 'Administrators AS_​GROUP LIST_​USERS 10 MERGE ( Editors AS_​GROUP LIST_​USERS 10 ) '. Also compare the outcome of: 'SET "A,B,C,D" AS_​LIST "," MERGE ( SET "B,C,D,E" AS_​LIST "," ) HTML_​OL '. With: 'SET "A,B,C,D" AS_​LIST "," APPEND ( SET "B,C,D,E" AS_​LIST "," ) HTML_​OL '.

MERGE_​INTO

Package:
Magic Data Symbols1
Symbol handle:
merge_​into
Description:
Merge a list into a memory. Takes the previous result as a list or single item and merges it into a memory specified by the following parameter, with duplicates and null entries removed. The context remains that of the preceding list and the merged list is returned. Memory storage is transient, lasting only while the page is rendering. Also see APPEND_​INTO for a similar symbol that does not remove duplicates. For example: 'SET 1 AS_​PAGE LIST_​PAGES 100 MERGE_​INTO m1 SET "Blog" CONTEXT "Page" AS_​PAGE LIST_​PAGES 100 MERGE_​INTO m1 APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH HTML_​OL '. In a more abstract form: 'SET "A,B,C,D" AS_​LIST "," SAVE m1 SET "B,C,D,E" AS_​LIST "," APPEND_​INTO m1 HTML_​OL '.

multiply *

Package:
Magic Data Symbols1
Symbol handle:
multiply
Description:
Multiplies two numbers. Takes the previous result as a number and multiplies by the following number. For example: 'SET "3.7" - "1.6" .'.

MY_​C5_​PROFILE

Package:
Magic Data Developer
Symbol handle:
my_​c5_​profile
Description:
Get your user profile from concrete5.org Similar to AS_​C5_​USER, but returns the concrete5.org profile set in the Magic Data Developer dashboard page.

NE

Package:
Magic Data Symbols1
Symbol handle:
ne
Description:
Tests for inequality. Inquality between the result of preceding symbols and the next symbol is tested using the loose '!=' comparison, returning the previous result value as an equivalent of true.

NEC

Package:
Magic Data Symbols1
Symbol handle:
nec
Description:
Tests for case-independant inequality. Case independant inequality between the result of preceding symbols and the next symbol is tested using the loose '==' comparison, returning the previous result value as an equivalent of true.

NECN

Package:
Magic Data Symbols1
Symbol handle:
necn
Description:
Tests for case-independant inequality. Case independant inequality between the result of preceding symbols and the next symbol is tested using the loose '==' comparison, returning the compared value as an equivalent of true.

NEWLINE

Package:
Magic Job
Symbol handle:
newline
Description:
Appends a new line Takes the previous result and returns it with a new line appended.

NEW_​MAIL

Package:
Black Magic Data
Symbol handle:
new_​mail
Description:
Begin a new email. Clears all mail settings, ready for a new email.

NOT

Package:
Magic Data Symbols1
Symbol handle:
not
Description:
Returns the logical inverse of the previous result. For example: 'SET 1 NOT IF "result string a" "result string b"' will return "result string a". 'SET 0 NOT IF "result string a" "result string b"' will return "result string b".

NOT_​BEGINS_​WITH

Package:
Magic Data Symbols1
Symbol handle:
not_​begins_​with
Description:
Tests for a string not beginning with another string. Tests whether text from the preceding result does not begin with the text in the following parameter, returning the previous resultas an equivalent of true.

NOT_​BEGINS_​WITHC

Package:
Magic Data Symbols1
Symbol handle:
not_​begins_​withc
Description:
Tests for a string not beginning with another string, case invariant. Tests whether text from the preceding result does not begin with the text in the following parameter, ignoring case and returning the previous result as an equivalent of true.

NOT_​CONTAINS

Package:
Magic Data Symbols1
Symbol handle:
not_​contains
Description:
Tests for a string not containing another string. Tests whether text from the preceding result does not contain the text in the following parameter, returning the previous result as an equivalent of true.

NOT_​CONTAINSC

Package:
Magic Data Symbols1
Symbol handle:
not_​containsc
Description:
Tests for a string not containing another string, case invariant. Tests whether text from the preceding result does not contain the text in the following parameter, ignoring case and returning the previous result as an equivalent of true.

NOT_​CONTAINS_​HTML

Package:
Magic Data Symbols1
Symbol handle:
not_​contains_​html
Description:
Tests if text does not contain any HTML. Takes the previous result as text and if it does not contain any HTML tags returns the text as the equivalent of true. If it contains any HTML, then returns null.

NOT_​ENDS_​WITH

Package:
Magic Data Symbols1
Symbol handle:
not_​ends_​with
Description:
Tests for a string not ending with another string. Tests whether text from the preceding result does not end with the text in the following parameter, returning the previous result as an equivalent of true.

NOT_​ENDS_​WITHC

Package:
Magic Data Symbols1
Symbol handle:
not_​ends_​withc
Description:
Tests for a string not ending with another string, case invariant. Tests whether text from the preceding result does not end with the text in the following parameter, ignoring case and returning the previous result as an equivalent of true.

NO_​DEBUG

Package:
Magic Data Developer
Symbol handle:
no_​debug
Description:
Switch off the debug trace. Debug trace is disabled until END_​NO_​DEBUG. The previous result and context are preserved. Can be useful to de-clutter the output when developing complex expressions or during benchmarking. For example: 'NO_​DEBUG BENCHMARK 20 Administrators AS_​GROUP LIST_​USERS 10 APPLY_​EACH EMAIL AS_​LINK END_​APPLY_​EACH END_​BENCHMARK END_​NO_​DEBUG HTML_​OL . BENCHMARK_​RESULT'.

NULL

Package:
Magic Data
Symbol handle:
null
Description:
Returns null.

NUMBER_​OF_​LOGINS

Package:
Magic Data Symbols1
Symbol handle:
number_​of_​logins
Description:
Get the number of times a user has logged in. Tries to find the result of preceding symbols as a user ID or name, returning the time of last login or null. Sets the context as 'Time' or null.

NUM_​CHILDREN

Package:
Magic Data Symbols1
Symbol handle:
num_​children
Description:
Given a page, returns the number of child pages. Tries to find the result of preceding symbols as a path or Page ID, returning the number of children or null. For example: 'SET /about NUM_​CHILDREN'.

OEMBED

Package:
Oembed for UCP and Magic Data
Symbol handle:
oembed
Description:
Transform URLs with Oembed The preceeding result is tested to see if it can be processed by Oembed and then evaluated and replaced. Note that a directly entered URL is best enclosed in quotes to avoid confusion with the '.' operator.

OR

Package:
Magic Data Symbols1
Symbol handle:
or
Description:
Logical OR. If the preceding symbols evaluate to a non-false value, then completes by returning that value. Otherwise continues evaluating symbols after the OR.

ORDER_​INVOICE_​NUMBER

Package:
Magic Data Commerce
Symbol handle:
order_​invoice_​number
Description:
Returns the invoice number for an order. The invoice number for an order is formatted as 6 digits with leading 0, or null if the order has no invoice number, such as it still being a cart.

ORDER_​PRODUCT_​PRICE

Package:
Magic Data Commerce
Symbol handle:
order_​product_​price
Description:
Returns the actual price of a product in the cart or order. Finds if a product is in the cart or order and returns the actual price.

ORDER_​PRODUCT_​QUANTITY

Package:
Magic Data Commerce
Symbol handle:
order_​product_​quantity
Description:
Synonym for QTY_​IN_​ORDER Finds if a product is in the cart or order and returns the quantity or 0. For example: 'WITH_​CART SET 'ruddy duck' AS_​PRODUCT QTY_​IN_​ORDER'.

ORDER_​STATUS

Package:
Magic Data Commerce
Symbol handle:
order_​status
Description:
Returns the status of an order. The order status, or null if the order has no status, such as it still being a cart. Order status will be one of the order statuses supported.

ORDER_​STATUS_​DATE

Package:
Magic Data Commerce
Symbol handle:
order_​status_​date
Description:
Returns the date at which the status of an order was set. The order status, or null if the order has no status, such as it still being a cart. Order status will be one of the order statuses supported.

ORDER_​TOTAL

Package:
Magic Data Commerce
Symbol handle:
order_​total
Description:
Returns the total price of the cart or order. The total price of the cart or order includes adjustments and shipping. Accuracy depends on a shipping address being known. For example: 'WITH_​CART ORDER_​TOTAL'.

ORDER_​VALUE

Package:
Magic Data Commerce
Symbol handle:
order_​value
Description:
Returns the total value of items in the cart or an order. This adds up the number of each product in the cart or order and its price to give an overall value. For example: 'WITH_​CART ORDER_​VALUE'.

ORIGINAL_​PAGE

Package:
Magic Data Symbols1
Symbol handle:
original_​page
Description:
Returns the page (collection) ID of the original page. Returns the original page ID, which could be a page in a page list or the current page, depending on context. IMPORTANT: When processed within a page list this symbol will only return the original page ID if the page list uses a Magic Data enabled Page List Template. By default, returns the current page ID

OWNER

Package:
Magic Data Symbols1
Symbol handle:
owner
Description:
The owner for a page or file. Given a file or page, returns the User ID for the file or page owner. For example: 'SET /about OWNER USERNAME'.

PAGE

Package:
Magic Data Symbols1
Symbol handle:
page
Description:
Returns the current page (collection) ID. Synonym for CID. May be used interchangeably.

PAGE_​ADDED_​DATE

Package:
Magic Data Symbols1
Symbol handle:
page_​added_​date
Description:
The date/time a page was first added to the site. Returns the date/time the page was added to the site an unprocessed database date/time stamp. The page is taken from the previous result. For example 'PAGE PAGE_​ADDED_​DATE'.

PAGE_​ADDED_​TIME

Package:
Magic Data Symbols1
Symbol handle:
page_​added_​time
Description:
The date/time a page was first added to the site. Returns the date/time the page was added to the site as a system epoch time. The page is taken from the previous result. For example 'PAGE PAGE_​ADDED_​TIME DATE "d-m-Y"'. Note: this may not be the same as PAGE_​PUBLIC_​TIME.

PAGE_​AT_​PATH

Package:
Magic Data Symbols1
Symbol handle:
page_​at_​path
Description:
Given a page (collection) path, returns the page ID. Tries to find the result of preceding symbols as a path, returning a Page ID or null. Sets the context as 'Page' or null.

PAGE_​DESCRIPTION

Package:
Magic Data Symbols1
Symbol handle:
page_​description
Description:
Given a page, returns the page description. Tries to find the result of preceding symbols as a path or Page ID, returning the description for the page or null. Sets the context as null. For example: 'SET /about CONTEXT Page PAGE_​DESCRIPTION'.

PAGE_​HANDLE

Package:
Magic Data Symbols1
Symbol handle:
page_​handle
Description:
Given a page, returns the page handle. Tries to find the result of preceding symbols as a path or Page ID, returning the handle (url slug) for the page or null. Sets the context as null. For example: 'PAGE PAGE_​HANDLE'.

PAGE_​IS_​NOT_​ADMIN

Package:
Magic Data Symbols1
Symbol handle:
page_​is_​not_​admin
Description:
Returns true if a page is not an admin page. Tries to find the result of preceding symbols as a path or Page ID, returning page id as the equivalent of true if the page is not an admin (dashboard) page. For example: 'SET /about CONTEXT Page PAGE_​IS_​NOT_​ADMIN'.

PAGE_​IS_​NOT_​SYSTEM

Package:
Magic Data Symbols1
Symbol handle:
page_​is_​not_​system
Description:
Returns true if a page is not a system page. Tries to find the result of preceding symbols as a path or Page ID, returning the page id as the equivalent of true if the page is not a system page. For example: 'SET /about CONTEXT Page PAGE_​IS_​NOT_​SYSTEM'.

PAGE_​IS_​VISIBLE_​TO

Package:
Magic Data Symbols1
Symbol handle:
page_​is_​visible_​to
Description:
Returns true if a page is visible to a group. Tries to find the result of preceding symbols as a path or Page ID, then the following parameter as a group, returning the Page id as the equivalent of true if the page is visible to the group. For example: 'SET /about AS_​PAGE PAGE_​IS_​VISIBLE_​TO 'Guest''.

PAGE_​LAST_​VISITED

Package:
Magic Data Symbols1
Symbol handle:
page_​last_​visited
Description:
The time the current user last visited a page. Tries to find the result of preceding symbols as a path or Page ID, returning the time the current user last visited the page or null. Sets the context as time. This symbol uses the PageStatistics table, so will only give a result if PageStatistics are enabled. For example: '"/about" AS_​PAGE PAGE_​LAST_​VISITED "d-m-Y"'. Can also be useful for testing if a 'page' is an actual page (it has a type handle) or not.

PAGE_​LAST_​VISITED_​ALL

Package:
Magic Data Symbols1
Symbol handle:
page_​last_​visited_​all
Description:
The time a page was last visted by any user. Tries to find the result of preceding symbols as a path or Page ID, returning the time the any user last visited the page or null. Sets the context as time. This symbol uses the PageStatistics table, so will only give a result if PageStatistics are enabled. For example: '"/about" AS_​PAGE PAGE_​LAST_​VISITED_​ALL DATE "d-m-Y"'. Can also be useful for testing if a 'page' is an actual page (it has a type handle) or not.

PAGE_​NAME

Package:
Magic Data Symbols1
Symbol handle:
page_​name
Description:
Given a page, returns the page name. Tries to find the result of preceding symbols as a path or Page ID, returning the name for the page or null. Sets the context as null. For example: 'SET /about CONTEXT Page PAGE_​NAME'.

PAGE_​PATH

Package:
Magic Data Symbols1
Symbol handle:
page_​path
Description:
Given a page, returns the page path. Tries to find the result of preceding symbols as a path or Page ID, returning the path for the page or null. Sets the context as 'Page' or null. Not to be confused with URL, which returns the full URL of a page. For example: 'SET 1 CONTEXT Page PAGE_​PATH'.

PAGE_​PUBLIC_​DATE

Package:
Magic Data Symbols1
Symbol handle:
page_​public_​date
Description:
The date/time a page version was published. Returns the date/time the page version was published as an unprocessed database date/time stamp. The page is taken from the previous result. For example 'PAGE PAGE_​PUBLIC_​DATE '.

PAGE_​PUBLIC_​TIME

Package:
Magic Data Symbols1
Symbol handle:
page_​public_​time
Description:
The time a page version was published. Returns the date/time the page version was published as a system epoch time. The page is taken from the previous result. For example 'PAGE PAGE_​PUBLIC_​TIME DATE "d-m-Y"'. Note: this may not be the same as PAGE_​ADDED_​TIME.

PAGE_​TEASER

Package:
Uber List
Symbol handle:
page_​teaser
Description:
Given a page, returns a teaser for the page. Tries to find the result of preceding symbols as a path or Page ID, returning a teaser extracted from the page 'Main' content. An optional following parameter sets the number of blocks to show in the teaser. If the Page List Teasers addon is not installed the page description will be returned. For example: 'SET /blog/hello-world CONTEXT Page PAGE_​TEASER 2'.

PAGE_​TYPE_​HANDLE

Package:
Magic Data Symbols1
Symbol handle:
page_​type_​handle
Description:
Given a page, returns the page type handle. Tries to find the result of preceding symbols as a path or Page ID, returning the page type handle for the page or null. Sets the context as null. For example: 'PAGE PAGE_​TYPE_​HANDLE'. Can also be useful for testing if a 'page' is an actual page (it has a type handle) or not.

PAGE_​TYPE_​NAME

Package:
Magic Data Symbols1
Symbol handle:
page_​type_​name
Description:
Given a page type, returns the page type name. Tries to find the result of preceding symbols as a page type by name, handle or ID (so can be used to validate a Page Type ID), returning a Page Type ID or null. Sets the context as 'Page Type' or null. For example: 'SET "blog_​entry" AS_​PAGE_​TYPE PAGE_​TYPE_​NAME'.

PAGE_​VERSION_​TIME

Package:
Magic Data Symbols1
Symbol handle:
page_​version_​time
Description:
The time the current version of a page was created. Returns the time the current page version was created as a system time. The page is taken from the previous result. For example 'PAGE PAGE_​VERSION_​TIME DATE "d-m-Y"'. Note: this may not be the same as PAGE_​PUBLIC_​TIME.

PAGE_​VISITS

Package:
Magic Data Symbols1
Symbol handle:
page_​visits
Description:
The number of times the current user has visited a page. Tries to find the result of preceding symbols as a page, returning the number of times the current user has visited the page or null. This symbol uses the PageStatistics table, so will only give a result if PageStatistics are enabled. For example: 'PAGE PAGE_​VISITS'.

PAGE_​VISITS_​ALL

Package:
Magic Data Symbols1
Symbol handle:
page_​visits_​all
Description:
The number of times the current page has been visited. Tries to find the result of preceding symbols as a page, returning the number of times the page has been visited or null. This symbol uses the PageStatistics table, so will only give a result if PageStatistics are enabled. For example: 'PAGE PAGE_​VISITS_​ALL'.

PARENT

Package:
Magic Data Symbols1
Symbol handle:
parent
Description:
Given a page, returns the parent page (collection) ID. Tries to find the result of preceding symbols as a path or Page ID, returning the Page ID of the parent page or null. Sets the context as 'Page' or null. For example: 'SET /about CONTEXT Page PARENT PAGE_​NAME'. An optional following numeric parameter can be used to set the number of ancestors to retreat. For example: 'PAGE PARENT 3 PAGE_​NAME' is equivalent to 'PAGE PARENT PARENT PARENT PAGE_​NAME'.

parenthesis_​close )

Package:
Magic Data
Symbol handle:
parenthesis_​close
Description:
Parenthesis. Use parenthesis ( ... ) to group symbols into subexpressions within an expression. Usually used in association with SET. For example: 'SET ( CID ATTRIBUTE alternate_​user USERNAME OR CID OWNER USERNAME )'. IMPORTANT There must be white space either side of opening or closing parenthesis in order for the symbol to be recognised.

parenthesis_​open (

Package:
Magic Data
Symbol handle:
parenthesis_​open
Description:
Parenthesis. Use parenthesis ( ... ) to group symbols into subexpressions within an expression. Usually used in association with SET. For example: 'SET ( CID ATTRIBUTE alternate_​user USERNAME OR CID OWNER USERNAME )'. IMPORTANT There must be white space either side of opening or closing parenthesis in order for the symbol to be recognised.

PARENT_​FROM_​TOP

Package:
Magic Data Symbols1
Symbol handle:
parent_​from_​top
Description:
Returns the ancestor page (collection) ID indexed from the top. Tries to find the result of preceding symbols as a path or Page ID, returning an acestor indexing down from the home page. Sets the context as 'Page' or null. An optional following parameter provides a number of levels to descend from the home page and defaults to 1. For example: 'SET 1 PARENT_​FROM_​TOP 1 PAGE_​NAME'.

PATH

Package:
Magic Data Symbols1
Symbol handle:
path
Description:
Given a page, returns the page path. Synonym for PAGE_​PATH Tries to find the result of preceding symbols as a path or Page ID, returning the path for the page or null. Sets the context as 'Page' or null. Not to be confused with URL, which returns the full URL of a page. For example: 'SET 1 CONTEXT Page PAGE_​PATH'.

PAYMENT_​METHOD

Package:
Magic Data Commerce
Symbol handle:
payment_​method
Description:
Synonym for PAYMENT_​METHODS For an order this is a single payment method. For a cart it will be a list of available payment options.

PAYMENT_​METHODS

Package:
Magic Data Commerce
Symbol handle:
payment_​methods
Description:
Returns the payment method(s) For an order this is a single payment method. For a cart it will be a list of available payment options.

PERMISSION_​SET_​DESCRIPTION

Package:
Black Magic Data
Symbol handle:
permission_​set_​description
Description:
Get the description for a permission set. Takes the result of preceding symbols as a symbol permission set name and returns the description for that set. For example: 'CURRENT_​SYMBOL_​PERMISSION_​SET PERMISSION_​SET_​DESCRIPTION'.

PREVIOUS_​LOGIN

Package:
Magic Data Symbols1
Symbol handle:
previous_​login
Description:
Get the time a user previously logged in. Tries to find the result of preceding symbols as a user ID or name, returning the time of previous login or null. Sets the context as 'Time' or null.

PRIVATE_​FILESET_​FOR_​USER

Package:
Magic Data Symbols1
Symbol handle:
private_​fileset_​for_​user
Description:
For a user ID, return a private Fileset identified by name or ID. As FILESET_​FOR_​USER, but returns a private fileset

PROCESS_​MARKDOWN

Package:
Universal Content Puller Sources2
Symbol handle:
process_​markdown
Description:
Process markdown formatted text to HTML. Given markdown formatted text, processes it into HTML. For example: 'SET "my_​markdown.md" AS_​FILE LOAD_​TEXT_​FILE PROCESS_​MARKDOWN '.

PRODUCT_​ALLOW_​NEGATIVE_​QUANTITY

Package:
Magic Data Commerce
Symbol handle:
product_​allow_​negative_​quantity
Description:
Given a product, returns true if negative quantities are allowed. Using the result of preceding symbols as a product or product ID, returns true if negative quantities of the product are allowed. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​ALLOW_​NEGATIVE_​QUANTITY'.

PRODUCT_​ALT_​THUMBNAIL

Package:
Magic Data Commerce
Symbol handle:
product_​alt_​thumbnail
Description:
Given a product, returns the alternate thumbnail. Using the result of preceding symbols as a product or product ID, returns a complete html image tag for the alternate product thumbnail. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​ALT_​THUMBNAIL'.

PRODUCT_​DATE_​ADDED

Package:
Magic Data Commerce
Symbol handle:
product_​date_​added
Description:
Given a product, returns the date added. Using the result of preceding symbols as a product or product ID, returns the date the was added or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​DATE_​ADDED'.

PRODUCT_​DESCRIPTION

Package:
Magic Data Commerce
Symbol handle:
product_​description
Description:
Given a product, returns the product description. Using the result of preceding symbols as a product or product ID, returns the description for the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​DESCRIPTION'.

PRODUCT_​DIMENSIONS

Package:
Magic Data Commerce
Symbol handle:
product_​dimensions
Description:
Given a product, returns the product dimensions. Using the result of preceding symbols as a product or product ID, returns the dimensions of the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​DIMENSIONS'.

PRODUCT_​FOR_​PAGE

Package:
Magic Data Commerce
Symbol handle:
product_​for_​page
Description:
Get the product associated with a page Taking the result of preceding symbols as a page, identifies and returns the product associated with the page as a Product ID or returns null. Sets the context as 'Product' or null. For example: 'SET "Martin Mandarin" AS_​PAGE PRODUCT_​FROM_​PAGE PRODUCT_​NAME' NOTE In many cases CURRENT_​PRODUCT is a more suitable symbol to use .

PRODUCT_​HEIGHT

Package:
Magic Data Commerce
Symbol handle:
product_​height
Description:
Given a product, returns the product height. Using the result of preceding symbols as a product or product ID, returns the height of the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​HEIGHT'.

PRODUCT_​IMAGE

Package:
Magic Data Commerce
Symbol handle:
product_​image
Description:
Given a product, returns the product image. Using the result of preceding symbols as a product or product ID, returns a complete html image tag for the full size product image. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​IMAGE'.

PRODUCT_​IMAGE_​ID

Package:
Magic Data Commerce
Symbol handle:
product_​image_​id
Description:
Given a product, returns the product image file ID. Using the result of preceding symbols as a product or product ID, returns the fileID of the product image.

PRODUCT_​IN_​SET

Package:
Magic Data Commerce
Symbol handle:
product_​in_​set
Description:
Given a product and a set, returns the product ID if it is in the set. Using the result of preceding symbols as a product or product ID and the following symbol as a product set, returns the product ID name as the equivalent of true if the product is in the set. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​IN_​SET "ruddy ducks"'.

PRODUCT_​IS_​ENABLED

Package:
Magic Data Commerce
Symbol handle:
product_​is_​enabled
Description:
Given a product, returns true if it is enabled. Using the result of preceding symbols as a product or product ID, returns true if the product is enabled. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​IS_​ENABLED'.

PRODUCT_​IS_​PHYSICAL

Package:
Magic Data Commerce
Symbol handle:
product_​is_​physical
Description:
Given a product, returns true if it is a physical product. Using the result of preceding symbols as a product or product ID, returns true if the product is a physical product. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​IS_​PHYSICAL'.

PRODUCT_​LANGUAGE

Package:
Magic Data Commerce
Symbol handle:
product_​language
Description:
Given a product, returns the product language. Using the result of preceding symbols as a product or product ID, returns the language or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​LANGUAGE'.

PRODUCT_​LENGTH

Package:
Magic Data Commerce
Symbol handle:
product_​length
Description:
Given a product, returns the product length. Using the result of preceding symbols as a product or product ID, returns the length of the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​LENGTH'.

PRODUCT_​MAX_​DIMENSION

Package:
Magic Data Commerce
Symbol handle:
product_​max_​dimension
Description:
Given a product, returns the sum of the product dimensions. Using the result of preceding symbols as a product or product ID, returns the maximum dimension of the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​MAX_​DIMENSION'.

PRODUCT_​MEDIUM_​IMAGE

Package:
Magic Data Commerce
Symbol handle:
product_​medium_​image
Description:
Given a product, returns the product medium size image. Using the result of preceding symbols as a product or product ID, returns a complete html image tag for the product medium size image. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​MEDIUM_​IMAGE'.

PRODUCT_​MIN_​PURCHASE_​QUANTITY

Package:
Magic Data Commerce
Symbol handle:
product_​min_​purchase_​quantity
Description:
Given a product, returns the minimum purchase quantity. Using the result of preceding symbols as a product or product ID, returns the minimum purchase quantity for the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​MIN_​PURCHASE_​QUANTITY'.

PRODUCT_​NAME

Package:
Magic Data Commerce
Symbol handle:
product_​name
Description:
Given a product, returns the product name. Using the result of preceding symbols as a product or product ID, returns the name for the product or null. For example: 'SET 2 AS_​PRODUCT PRODUCT_​NAME'.

PRODUCT_​PREVIOUSLY_​PURCHASED

Package:
Magic Data Commerce
Symbol handle:
product_​previously_​purchased
Description:
Returns a count of previous purchases of a product. Taking the result of previous symbols as a product, the current user's orders are checked and a count of all previously purchased is returned. An optional status parameter filters by order status as any of the order statuses supported. As a total of 0 is also equivalent to false, this can be used to test if a user has previously purchased a product. For example: 'SET "Marvin Mandarin" CONTEXT "Product" AS_​PRODUCT PRODUCT_​PREVIOUSLY_​PURCHASED "Shipped"'.

PRODUCT_​PRICE

Package:
Magic Data Commerce
Symbol handle:
product_​price
Description:
Given a product, returns the product price. Using the result of preceding symbols as a product or product ID, returns the price for the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​PRICE FORMAT_​PRICE'.

PRODUCT_​PRICE_​TO_​PAY

Package:
Magic Data Commerce
Symbol handle:
product_​price_​to_​pay
Description:
Given a product, returns the product price. Using the result of preceding symbols as a product, returns the price to pay for the product after special price and attribute modifiers have been applied or null. An optional following quantity will be used to asses tiered pricing. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​PRICE_​TO_​PAY 6 FORMAT_​PRICE'.

PRODUCT_​PURCHASES

Package:
Magic Data Commerce
Symbol handle:
product_​purchases
Description:
Given a product, returns the total product purchases. Using the result of preceding symbols as a product or product ID, returns the total number of times the product has been purchased or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​PURCHASES'.

PRODUCT_​QUANTITY

Package:
Magic Data Commerce
Symbol handle:
product_​quantity
Description:
Given a product, returns the quantity in stock. Using the result of preceding symbols as a product or product ID, returns the stock quantity for the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​QUANTITY'.

PRODUCT_​RECENT_​SALES_​QUANTITY

Package:
Magic Data Commerce
Symbol handle:
product_​recent_​sales_​quantity
Description:
Given a product, returns a count of recent product sales. Using the result of preceding symbols as a product or product ID, returns the total number of times the product has been recently purchased. The immediately following parameter is either a date/time or a negative number of days to limit how far back the purchase count should go. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​RECENT_​SALES_​QUANTITY "last month" '.

PRODUCT_​RECENT_​SALES_​VALUE

Package:
Magic Data Commerce
Symbol handle:
product_​recent_​sales_​value
Description:
Given a product, returns the value of recent product sales. Using the result of preceding symbols as a product or product ID, returns the total value of recent purchases. The immediately following parameter is either a date/time or a negative number of days to limit how far back the purchase count should go. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​RECENT_​SALES_​VALUE "last month" '.

PRODUCT_​REQUIRES_​LOGIN

Package:
Magic Data Commerce
Symbol handle:
product_​requires_​login
Description:
Given a product, returns true if login is required to purchase. Using the result of preceding symbols as a product or product ID, returns true if the product requires login to purchase. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​REQUIRES_​LOGIN'.

PRODUCT_​REQUIRES_​SALES_​TAX

Package:
Magic Data Commerce
Symbol handle:
product_​requires_​sales_​tax
Description:
Given a product, returns true if it requires sales tax. Using the result of preceding symbols as a product or product ID, returns true if the product requires sales tax. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​REQUIRES_​SALES_​TAX'.

PRODUCT_​REQUIRES_​SHIPPING

Package:
Magic Data Commerce
Symbol handle:
product_​requires_​shipping
Description:
Given a product, returns true if it requires shipping. Using the result of preceding symbols as a product or product ID, returns true if the product requires shipping. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​REQUIRES_​SHIPPING'.

PRODUCT_​SET_​NAME

Package:
Magic Data Commerce
Symbol handle:
product_​set_​name
Description:
Given a product set, returns the product set name. Using the result of preceding symbols as a product set or product set ID, returns the name for the product set or null. For example: 'SET 2 AS_​PRODUCT_​SET PRODUCT_​SET_​NAME'.

PRODUCT_​SET_​PAGE

Package:
Magic Data Commerce
Symbol handle:
product_​set_​page
Description:
Given a product set, returns a similarly named page. Using the result of preceding symbols as a product set or product set ID, returns the name for the product set or null. For example: 'SET 2 AS_​PRODUCT_​SET PRODUCT_​SET_​NAME'.

PRODUCT_​SHIPPING_​MODIFIER

Package:
Magic Data Commerce
Symbol handle:
product_​shipping_​modifier
Description:
Given a product, returns the shipping modifier. Using the result of preceding symbols as a product or product ID, returns the shipping modifier for the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​SHIPPING_​MODIFIER'.

PRODUCT_​SOLD_​OUT

Package:
Magic Data Commerce
Symbol handle:
product_​sold_​out
Description:
Given a product, returns true if it is sold out. Using the result of preceding symbols as a product or product ID, returns true if the product is sold out. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​SOLD_​OUT'.

PRODUCT_​SPECIAL_​PRICE

Package:
Magic Data Commerce
Symbol handle:
product_​special_​price
Description:
Given a product, returns the special offer product price. Using the result of preceding symbols as a product or product ID, returns the special offer price for the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​SPECIAL_​PRICE FORMAT_​PRICE'.

PRODUCT_​SUM_​DIMENSIONS

Package:
Magic Data Commerce
Symbol handle:
product_​sum_​dimensions
Description:
Given a product, returns the sum of the product dimensions. Using the result of preceding symbols as a product or product ID, returns the sum of the dimensions of the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​SUM_​DIMENSIONS'.

PRODUCT_​THUMBNAIL

Package:
Magic Data Commerce
Symbol handle:
product_​thumbnail
Description:
Given a product, returns the product thumbnail. Using the result of preceding symbols as a product or product ID, returns a complete html image tag for the product thumbnail image. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​THUMBNAIL'.

PRODUCT_​THUMBNAIL_​ID

Package:
Magic Data Commerce
Symbol handle:
product_​thumbnail_​id
Description:
Given a product, returns the product thumbnail file ID. Using the result of preceding symbols as a product or product ID, returns the fileID of the product thumbnail.

PRODUCT_​UNLIMITED_​QUANTITY

Package:
Magic Data Commerce
Symbol handle:
product_​unlimited_​quantity
Description:
Given a product, returns true if there is an unlimited quantity of the product. Using the result of preceding symbols as a product or product ID, returns true if there is an unlimited quantity of the product. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​UNLIMITED_​QUANTITY'.

PRODUCT_​VIEWS

Package:
Magic Data Commerce
Symbol handle:
product_​views
Description:
Given a product, returns the total product Views. Using the result of preceding symbols as a product or product ID, returns the total number of times the product has been viewed or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​VIEWS'.

PRODUCT_​VOLUME

Package:
Magic Data Commerce
Symbol handle:
product_​volume
Description:
Given a product, returns the product volume. Using the result of preceding symbols as a product or product ID, returns the volume of the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​VOLUME'.

PRODUCT_​WEIGHT

Package:
Magic Data Commerce
Symbol handle:
product_​weight
Description:
Given a product, returns the product weight. Using the result of preceding symbols as a product or product ID, returns the weight of the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​WEIGHT'.

PRODUCT_​WIDTH

Package:
Magic Data Commerce
Symbol handle:
product_​width
Description:
Given a product, returns the product width. Using the result of preceding symbols as a product or product ID, returns the width of the product or null. For example: 'SET 'ruddy duck' AS_​PRODUCT PRODUCT_​WIDTH'.

PROFILE

Package:
Magic Data Symbols1
Symbol handle:
profile
Description:
On a profile page returns the user ID for the profile. Extracts the user ID from the path of a profile page. On any page other than a profile page, or when not showing a specified user within a profile page, will return null.

PURCHASE_​HISTORY

Package:
Magic Data Commerce
Symbol handle:
purchase_​history
Description:
Returns a list of orders containg a product. Taking the result of previous symbols as a product, the current user's orders are returned as a list filtered to those that contain the specified product. An optional following numeric parameter limits the returned list and an optional status parameter filters by order status as any of the order statuses supported. For example: 'SET "Marvin Mandarin" CONTEXT "Product" AS_​PRODUCT PURCHASE_​HISTORY "Shipped" END_​ON_​NULL APPLY_​EACH ORDER_​STATUS_​DATE DATE "d M Y" END_​APPLY_​EACH HTML_​OL'.

QTY_​IN_​ORDER

Package:
Magic Data Commerce
Symbol handle:
qty_​in_​order
Description:
Returns the quantity of a product in the cart or order. Finds if a product is in the cart or order and returns the quantity or 0. For example: 'WITH_​CART SET 'ruddy duck' AS_​PRODUCT QTY_​IN_​ORDER'.

QUEUEABLE_​JOB_​ITEM

Package:
Magic Job
Symbol handle:
queueable_​job_​item
Description:
Get the current queueable job item. Use within Magic Queueable Job to return the current job item and context.

"

Package:
Magic Data
Symbol handle:
quote_​double
Description:
Quotation marks. Use single or double quotation marks to enclose text, including any spaces and punctuation within the text. IMPORTANT There must be white space outside quotes wrapping text in order for the text to be separated from adjoining symbols.

'

Package:
Magic Data
Symbol handle:
quote_​single
Description:
Quotation marks. Use single or double quotation marks to enclose text, including any spaces and punctuation within the text. IMPORTANT There must be white space outside quotes wrapping text in order for the text to be separated from adjoining symbols.

RAW

Package:
Magic Data Developer
Symbol handle:
raw
Description:
Ends symbol processing and returns the original token. Use in documentation to show a Magic Data token unprocessed. This symbol will return the original token but with this RAW symbol removed. If you are in a situation where an area of text is processed twice, each use of RAW will only remove its own symbol once. So you can use 'RAW RAW ....' to return 'RAW ....' and so on. May also be of use to deliberately delay Magic Data processing to a later processor. For example, in delaying processing from a Magic Data enabled template to a Magic Data enabled theme.

RECALL

Package:
Magic Data Symbols1
Symbol handle:
recall
Description:
Synonym for RETRIEVE Retrieve a value and context previously saved from a memory, using the result of any previous symbols as a key and returns the value. Memory storage is transient, lasting only while the page is rendering. For example 'SET "Whatever you want" SAVE my_​key_​name SET my_​key_​name RETRIEVE' will return "Whatever you want".

RECALL_​FROM_​SESSION

Package:
Black Magic Data
Symbol handle:
recall_​from_​session
Description:
Synonym for RETRIEVE_​FROM_​SESSION. Retrieve a value and context previously saved into session memory, using the result of any previous symbols as a key and returns the value. Memory storage is persistent with the session, lasting for the duration of the session. For example 'SET "Whatever you want" SAVE_​TO_​SESSION my_​key_​name SET my_​key_​name RETRIEVE_​FROM_​SESSION' will return "Whatever you want".

REDIRECT

Package:
Magic Data Symbols1
Symbol handle:
redirect
Description:
Given a page or URL, redirects to that page or URL. The preceding result should be a page or URL. Redirects to that page. For example: 'SET /about AS_​PAGE REDIRECT'. NOTE Administrators and the super administrator will not be redirected so a page can still be edited.

REDUCE

Package:
Magic Data Symbols1
Symbol handle:
reduce
Description:
Synonym for REDUCE_​LIST Takes the previous result as a list and reduces the list by removing any empty, null or duplicated items.

REDUCE_​LIST

Package:
Magic Data Symbols1
Symbol handle:
reduce_​list
Description:
Removes empty and duplicate items from a list. Takes the previous result as a list and reduces the list by removing any empty, null or duplicated items.

REMOVE_​CURRENT_​USER_​FROM_​GROUP

Package:
Black Magic Data
Symbol handle:
remove_​current_​user_​from_​group
Description:
Removes the current user from a group. Taking the result of preceding symbols as a user group, removes the current user from the group. For example: 'SET "Editors" AS_​GROUP REMOVE_​CURRENT_​USER_​FROM_​GROUP'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

REMOVE_​FILE_​FROM_​SET

Package:
Black Magic Data
Symbol handle:
remove_​file_​from_​set
Description:
Remove a file from a fileset. Using the result of preceding symbols as file and a following parameters as a file set, removes the file fromthe set. Returns the file id. For example: 'SET "europe_​valencia_​hemispheric.jpg" AS_​FILE REMOVE_​FILE_​FROM_​SET ( SET "Banners" AS_​FILESET )'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

REMOVE_​FROM_​LIST

Package:
Magic Data Symbols1
Symbol handle:
remove_​from_​list
Description:
Removes specified item(s) from a list. Takes the previous result as a list and the following parameter as one or more items to remove from the list, returning a list with those items remoived. For example: 'PAGE LIST_​ANCESTOR_​PAGES 5 REMOVE_​FROM_​LIST ( PAGE ) APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH IMPLODE ' > ' ' will give a breadcrumb trail without the current page.

REMOVE_​USER_​FROM_​GROUP

Package:
Black Magic Data
Symbol handle:
remove_​user_​from_​group
Description:
Removes a user from a group. The result of preceding symbols and the immediately following parameter should identify a user and a group, or a group and a user. The user is then removed from the group. For example: 'SET "Editors" AS_​GROUP REMOVE_​USER_​FROM_​GROUP ( SET 'JohntheFish' AS_​USER ) For example: 'SET "JohntheFish" AS_​USER REMOVE_​USER_​FROM_​GROUP ( SET 'Editors' AS_​GROUP ) '. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

RENDER_​BLOCK

Package:
Universal Content Puller
Symbol handle:
render_​block
Description:
Display a single block. Takes the result of preceding symbols as a block and renders the block view. For example: 'PAGE PARENT LIST_​BLOCKS "Main" 1 RENDER_​BLOCK '. NOTE JavaScript resources pulled in by blocks may not fully load. This symbol is best used for blocks that do not contain JavaScript interaction.

RENDER_​BLOCK_​NO_​ASSETS

Package:
Universal Content Puller
Symbol handle:
render_​block_​no_​assets
Description:
Display a single block, ignoring any required assets. Takes the result of preceding symbols as a block and renders the block view, but without any script or css assets. This content source can improve page loading speed if you are certain that no assets are required or that all assets are already loaded. For example: 'PAGE PARENT LIST_​BLOCKS "Main" 1 RENDER_​BLOCK_​NO_​ASSETS '.

RENDER_​BOX_​GRABBER

Package:
Universal Content Puller Sources1
Symbol handle:
render_​box_​grabber
Description:
Display selected elements from a url. Takes the result of preceding symbols as a url and render the content of that URL. The first following parameter is required to be a jQuery/CSS selector to identify elements within the page. The second following parameter is required to be a jQuery/CSS selector to exclude elements within the page. For example: 'SET "http://www.concrete5.org" RENDER_​BOX_​GRABBER "#home-tour-editors" ".home-tour-button" '. NOTE Unlike a Universal Content Puller block, the url content is not cached by this symbol.

RENDER_​GLOBAL_​AREA

Package:
Universal Content Puller
Symbol handle:
render_​global_​area
Description:
Display a global area. Given a global area, will render the content of the global area. For example: 'SET "Header Nav" AS_​GLOBAL_​AREA RENDER_​GLOBAL_​AREA'. NOTE JavaScript resources pulled in by blocks in a global area may not fully load. This symbol is best used for global areas that do not contain JavaScript interaction.

RENDER_​GLOBAL_​AREA_​NO_​ASSETS

Package:
Universal Content Puller
Symbol handle:
render_​global_​area_​no_​assets
Description:
Display a global area, ignoring any required assets. Given a global area, will render the content of the global area, but without any script or css assets. This content source can improve page loading speed if you are certain that no assets are required or that all assets are already loaded. For example: 'SET "Header Nav" AS_​GLOBAL_​AREA RENDER_​GLOBAL_​AREA_​NO_​ASSETS'.

RENDER_​PAGE_​AREA

Package:
Universal Content Puller Sources1
Symbol handle:
render_​page_​area
Description:
Display an area of a page. Takes the result of preceding symbols as a page and an optional following parameter as an area of the page, the area defaulting to 'Main'. Renders the area of the page. For example: 'PAGE PARENT RENDER_​PAGE_​AREA "Sidebar" '. NOTE JavaScript resources pulled in by blocks in a page area may not fully load. This symbol is best used for page areas that do not contain JavaScript interaction.

RENDER_​PAGE_​AREA_​NO_​ASSETS

Package:
Universal Content Puller Sources1
Symbol handle:
render_​page_​area_​no_​assets
Description:
Display an area of a page, ignoring any required assets. Takes the result of preceding symbols as a page and an optional following parameter as an area of the page, the area defaulting to 'Main'. Renders the area of the page, but without any script or css assets. This content source can improve page loading speed if you are certain that no assets are required or that all assets are already loaded. For example: 'PAGE PARENT RENDER_​PAGE_​AREA_​NO_​ASSETS "Sidebar" '.

RENDER_​STACK

Package:
Universal Content Puller
Symbol handle:
render_​stack
Description:
Display a stack. Given a stack, will render the content of the stack. For example: 'SET "Side Nav" AS_​STACK RENDER_​STACK'. NOTE JavaScript resources pulled in by blocks in a stack may not fully load. This symbol is best used for stacks that do not contain JavaScript interaction.

RENDER_​STACK_​NO_​ASSETS

Package:
Universal Content Puller
Symbol handle:
render_​stack_​no_​assets
Description:
Display a stack, ignoring any required assets. Given a stack, will render the content of the stack, but without any script or css assets. This content source can improve page loading speed if you are certain that no assets are required or that all assets are already loaded. For example: 'SET "Side Nav" AS_​STACK RENDER_​STACK_​NO_​ASSETS'.

REPLACE

Package:
Magic Data Symbols1
Symbol handle:
replace
Description:
Replace text. Takes the result of preceding symbols as text and replaces part of it. The first following parameter is the text to replace. The second following parameter is the text to replace with. All occurances are replaced. For example 'SET "Whatever You and you want" REPLACE "you" "I"'.

REPLACE_​FIRST

Package:
Magic Data Symbols1
Symbol handle:
replace_​first
Description:
Replace text. Takes the result of preceding symbols as text and replaces part of it. The first following parameter is the text to replace. The second following parameter is the text to replace with. Only the first occurance is replaced. For example 'SET "Whatever you and you want" REPLACE_​FIRST "you" "I"'.

REPLACE_​IGNORING_​CASE

Package:
Magic Data Symbols1
Symbol handle:
replace_​ignoring_​case
Description:
Replace text ignoring case. Takes the result of preceding symbols as text and replaces part of it ignoring case. The first following parameter is the text to replace. The second following parameter is the text to replace with. All occurances are replaced. For example 'SET "Whatever You and you want" REPLACE_​IGNORING_​CASE "you" "I"'.

REQUEST_​COLLECTION_​PATH

Package:
Magic Data Symbols1
Symbol handle:
request_​collection_​path
Description:
The request collection path. The current request collection path, not necessarily the same as 'PAGE PATH'.

REQUEST_​PATH

Package:
Magic Data Symbols1
Symbol handle:
request_​path
Description:
The request path. The current request path, not necessarily the same as 'PAGE PATH'.

RESTORE

Package:
Magic Data Symbols1
Symbol handle:
restore
Description:
Synonym for RETRIEVE Retrieve a value and context previously saved from a memory, using the result of any previous symbols as a key and returns the value. Memory storage is transient, lasting only while the page is rendering. For example 'SET "Whatever you want" SAVE my_​key_​name SET my_​key_​name RETRIEVE' will return "Whatever you want".

RESTORE_​FROM_​SESSION

Package:
Black Magic Data
Symbol handle:
restore_​from_​session
Description:
Synonym for RETRIEVE_​FROM_​SESSION. Retrieve a value and context previously saved into session memory, using the result of any previous symbols as a key and returns the value. Memory storage is persistent with the session, lasting for the duration of the session. For example 'SET "Whatever you want" SAVE_​TO_​SESSION my_​key_​name SET my_​key_​name RETRIEVE_​FROM_​SESSION' will return "Whatever you want".

RETRIEVE

Package:
Magic Data Symbols1
Symbol handle:
retrieve
Description:
Retrieve a value previously saved. Retrieve a value and context previously saved from a memory, using the result of any previous symbols as a key and returns the value. Memory storage is transient, lasting only while the page is rendering. For example 'SET "Whatever you want" SAVE my_​key_​name SET my_​key_​name RETRIEVE' will return "Whatever you want".

RETRIEVE_​FROM_​SESSION

Package:
Black Magic Data
Symbol handle:
retrieve_​from_​session
Description:
Retrieve a value previously saved to the user's session. Retrieve a value and context previously saved into session memory, using the result of any previous symbols as a key and returns the value. Memory storage is persistent with the session, lasting for the duration of the session. For example 'SET "Whatever you want" SAVE_​TO_​SESSION my_​key_​name SET my_​key_​name RETRIEVE_​FROM_​SESSION' will return "Whatever you want".

REVERSE

Package:
Magic Data Symbols1
Symbol handle:
reverse
Description:
Reverse a list. Takes a list and turns it round, last element first.

ROUND_​TO

Package:
Magic Data Symbols1
Symbol handle:
round_​to
Description:
Rounds a number to a specified number of decimal places. Given a number as the result of preceding symbols, rounds it to a number of decimal places specified in an optional following parameter. For example: 'SET "2.1234567" ROUND_​TO "3"'.

SANITIZE

Package:
Magic Data Symbols1
Symbol handle:
sanitize
Description:
Sanitize text to remove tags and attributes. Strips the previous result of all html tags and attributes.

SANITIZED_​ATTRIBUTE

Package:
Magic Data Symbols1
Symbol handle:
sanitized_​attribute
Description:
Returns the sanitized display for a specified attribute. The immediately following symbol must be an attribute handle. The context of Page, User, File etc and the respective id is taken from the result of preceding symbols. For example 'SET JohntheFish CONTEXT User SANITIZED_​ATTRIBUTE shipping_​address'. Ideally the attribute handle should be used. However, this symbol will also do its best to work from attribute names and ids.

SANITIZE_​MAGIC_​DATA

Package:
Black Magic Data
Symbol handle:
sanitize_​magic_​data
Description:
Sanitize text to remove Magic Data tokens. Strips the previous result of all Magic Data tokens.

SAVE

Package:
Magic Data Symbols1
Symbol handle:
save
Description:
Save the current value. Saves the the result of preceding symbols and context into a memory using the following symbol as a key and returns the same value while keeping the context. Memory storage is transient, lasting only while the page is rendering. For example 'SET "Whatever you want" SAVE my_​key_​name RETRIEVE my_​key_​name' will return "Whatever you want".

SAVE_​CONTENT_​TO_​PAGE

Package:
Black Magic Data
Symbol handle:
save_​content_​to_​page
Description:
Adds a content block to a specified page and area. Takes the result of preceding symbols as text or html. The following required parameter must be a page. A second optional parameter may be a regular page area (ie, not a global area) and defaults to "Main". A further optional parameter may be used to specify a block template. A content block is then added to the page with the text or html and a new page version created and approved. For example: 'SET "<p>Some content</p>" SAVE_​CONTENT_​TO_​PAGE "about" "Main"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

SAVE_​HTML_​TO_​PAGE

Package:
Black Magic Data
Symbol handle:
save_​html_​to_​page
Description:
Adds an HTML block to a specified page and area. Takes the result of preceding symbols as text or html. The following required parameter must be a page. A second optional parameter may be a regular page area (ie, not a global area) and defaults to "Main". An HTML block is then added to the page with the text or html and a new page version created and approved. For example: 'SET "<p>Some content</p>" SAVE_​HTML_​TO_​PAGE "about" "Sidebar" "Blocks By Ajax"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

SAVE_​TO_​SESSION

Package:
Black Magic Data
Symbol handle:
save_​to_​session
Description:
Save the current value to the user's session. Saves the the result of preceding symbols and context into session memory using the following symbol as a key and returns the same value while keeping the context. Memory storage is persistent with the session, lasting for the duration of the session. For example 'SET "Whatever you want" SAVE_​TO_​SESSION my_​key_​name RETRIEVE_​FROM_​SESSION my_​key_​name' will return "Whatever you want".

SEARCH_​BLOCK_​QUERY

Package:
Uber List
Symbol handle:
search_​block_​query
Description:
The query entered in a search block. Within the search results for a Magic Data enabled search block template will return the query entered in the associated search block.

SEARCH_​INDEX_​ATTRIBUTE

Package:
Magic Data Symbols1
Symbol handle:
search_​attribute
Description:
Returns the search index value for a specified attribute. The immediately following symbol must be an attribute handle. The context of Page, User, File etc and the respective id is taken from the result of preceding symbols. For example 'SET JohntheFish CONTEXT User SEARCH_​INDEX_​ATTRIBUTE shipping_​address'. Ideally the attribute handle should be used. However, this symbol will also do its best to work from attribute names and ids.

SEND_​MAIL

Package:
Black Magic Data
Symbol handle:
send_​mail
Description:
Send the email. Sends a previously assembled email.

SERVER_​IP_​ADDRESS

Package:
Magic Data Symbols1
Symbol handle:
server_​ip_​address
Description:
The server's IP address Returns the server's IP address or null. The context will be 'IP' or null.

SET

Package:
Magic Data
Symbol handle:
set
Description:
Returns the immediately following symbol/value. Use this to set any value. Often used to get things started. For example: 'SET 1 CONTEXT User USERNAME' will return the username for the user with ID 1 (the super user). In may circumstances, any text that is not a recognised symbol will have 'SET' implied. However, use of SET is generally a good idea because it is unambiguous.

SET_​CURRENT_​PAGE_​ATTRIBUTE

Package:
Black Magic Data
Symbol handle:
set_​current_​page_​attribute
Description:
Set an attribute of the current page. Using the result of preceding symbols as a value and the following parameter as an attribute name, sets that page attribute for the current page to the value. Returns the value set. For example: 'PAGE PAGE_​NAME SET_​CURRENT_​PAGE_​ATTRIBUTE "Meta Title"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

SET_​CURRENT_​PRODUCT

Package:
Magic Data Commerce
Symbol handle:
set_​current_​product
Description:
Set the current product Sets the current product, subsequently used by any MD Commerce product template and available through CURRENT_​PRODUCT.

SET_​CURRENT_​USER_​ATTRIBUTE

Package:
Black Magic Data
Symbol handle:
set_​current_​user_​attribute
Description:
Set an attribute of the current user. Using the result of preceding symbols as a value and the following parameter as an attribute name, sets that user attribute for the current user to the value. Returns the value set. For example: 'SET 1 SET_​CURRENT_​USER_​ATTRIBUTE "profile_​private_​messages_​notification_​enabled"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

SET_​FILE_​ATTRIBUTE

Package:
Black Magic Data
Symbol handle:
set_​file_​attribute
Description:
Set an attribute of a specified file. Using the result of preceding symbols as a value and the following parameters as a file and an attribute name, sets that file attribute for the specified file to the value. Returns the value set. For example: Assuming you have a text attribute "Continent" 'SET "Europe" SET_​FILE_​ATTRIBUTE "europe_​valencia_​hemispheric.jpg" "Continent"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

SET_​PAGE_​ATTRIBUTE

Package:
Black Magic Data
Symbol handle:
set_​page_​attribute
Description:
Set an attribute of a specified page. Using the result of preceding symbols as a value and the following parameters as a page and an attribute name, sets that page attribute for the specified page to the value. Returns the value set. For example: 'SET "My About Page" SET_​PAGE_​ATTRIBUTE "about" "Meta Title"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

SET_​PAGE_​TYPE

Package:
Black Magic Data
Symbol handle:
set_​page_​type
Description:
Set the page type of a page. Using the result of preceding symbols as page and the following parameters as a page type, sets the page type. Returns the page ID. For example: 'SET "About" AS_​PAGE SET_​PAGE_​TYPE "Right Sidebar"'. DANGER This symbol can update your database. Please remember to backup your database before disabling the sandbox or deploying expressions that use this symbol.

SET_​TEMPLATE_​ELEMENT

Package:
Magic Data Templates1
Symbol handle:
set_​template_​element
Description:
Set the element for a magic template Template elements automatically default to "div". In the rare cases where alternative elements are required, this symnbol takes the preceding result as a dom element, setting it as the element for a magic data template. Returns the element. An optional following parameter can be used to set a template key and defaults to outer. The template key can be any one of inner, outer, all_​list_​inner, all_​list_​outer. For example: 'SET "article" SET_​TEMPLATE_​ELEMENT SET "span" SET_​TEMPLATE_​ELEMENT "inner"'.

SET_​TEMPLATE_​ID

Package:
Magic Data Templates1
Symbol handle:
set_​template_​id
Description:
Set an id for a magic template Takes the preceding result as an id, setting it as the id for a magic data template. Returns the id as an html id attribute. An optional following parameter can be used to set a template key and defaults to outer. The template key can be any one of inner, outer, all_​list_​inner, all_​list_​outer. For example: 'SET "my_​outer_​id" SET_​TEMPLATE_​ID SET "my_​inner_​id" SET_​TEMPLATE_​ID "inner"'.

SET_​TEMPLATE_​ITEM

Package:
Uber List
Symbol handle:
set_​template_​item
Description:
Set a current Uber List item to pass to a template Use this symbol to set a template item when using an Uber List template by itself, outside of an Uber List. For example: 'SET 1 AS_​PAGE SET_​TEMPLATE_​ITEM\, then in any subsequent stack shown on the page where UBER_​LIST_​ITEM is used, the symbol will return the home page.

SHIPPING_​METHOD

Package:
Magic Data Commerce
Symbol handle:
shipping_​method
Description:
Synonym for SHIPPING_​METHODS For an order this is a single method. For a cart it will be a list of available shipping options, where accuracy depends on a shipping address being known.

SHIPPING_​METHODS

Package:
Magic Data Commerce
Symbol handle:
shipping_​methods
Description:
Returns the shipping method(s) For an order this is a single method. For a cart it will be a list of available shipping options, where accuracy depends on a shipping address being known.

SHIPPING_​METHOD_​PRICE

Package:
Magic Data Commerce
Symbol handle:
shipping_​method_​price
Description:
Given a shipping method, returns shipping price. Given a valid shipping method, returns the associated price or null. Will return the actual price for an order, or the prospective price for a cart. For a cart, the accuracy depends on a shipping address being already known to eCommerce.

SHOWCASE_​ICON

Package:
Magic Data Developer
Symbol handle:
showcase_​icon
Description:
The icon for a showcase site. Given a showcase site, returns icon for the showcase site or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​SHOWCASE_​SITES 100 APPLY_​EACH SHOWCASE_​ICON END_​APPLY_​EACH HTML_​OL'.

SHOWCASE_​NAME

Package:
Magic Data Developer
Symbol handle:
showcase_​name
Description:
The site name for a showcase site. Given a showcase site, returns the showcase site name or null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​SHOWCASE_​SITES 100 APPLY_​EACH SHOWCASE_​NAME END_​APPLY_​EACH HTML_​OL'.

SHOWCASE_​URL

Package:
Magic Data Developer
Symbol handle:
showcase_​url
Description:
The url for a showcase site page. Given a showcase site, returns a url for the showcase page null. For example: 'SET '51576 ' AS_​C5_​USER LIST_​SHOWCASE_​SITES 100 APPLY_​EACH SHOWCASE_​URL AS_​LINK END_​APPLY_​EACH HTML_​OL'.

SHUFFLE

Package:
Magic Data Symbols1
Symbol handle:
shuffle
Description:
Shuffle a list. Takes a list and shuffles it randomly.

SLICE

Package:
Magic Data Symbols1
Symbol handle:
slice
Description:
Take a slice of a list by index and length. Takes the previous result as a list and returns a slice of the list. The following parameter is an index where the first item in the list has an index of 1. Negative numbers index from the end of the list and the last item has an index of -1. A second optional following parameter is the length of the slice. If omitted, all the remaining items in the list are returned For example: 'Administrators AS_​GROUP LIST_​USERS SLICE 1 3 APPLY_​EACH USERNAME END_​APPLY_​EACH'.

SORT_​BY

Package:
Magic Data Symbols1
Symbol handle:
sort_​by
Description:
Sorts a list according to the following symbols. Takes the previous result as a list and applies the following subexpression of symbols to each element of the list. Continues until the end of a token or until the symbol END_​SORT_​BY is encountered. The list is then sorted according to the values returned. For example: 'SET 1 AS_​PAGE LIST_​PAGES 100 SORT_​BY TIME_​PUBLIC END_​SORT_​BY REVERSE APPLY_​EACH PAGE_​LINK END_​APPLY_​EACH HTML_​OL'.

SPACE_​LIST

Package:
Magic Data Symbols1
Symbol handle:
space_​list
Description:
Inserts spaces in a list. Takes a comma separated list and makes sure there is a space after each comma.

SRC

Package:
Magic Data Symbols1
Symbol handle:
src
Description:
Extract the URL from the href="..." or src="..." attribute of a DOM element. Synonym for HREF. May be used interchangeably.

STACK_​NAME

Package:
Universal Content Puller
Symbol handle:
stack_​name
Description:
Given a stack, returns the stack name. Tries to find the result of preceding symbols as a Stack or Stack ID, returning the name for the stack or null. Sets the context as null. For example: 'SET "Side Nav" AS_​STACK STACK_​NAME'.

STATE_​CODE

Package:
Country State Manager
Symbol handle:
state_​code
Description:
Returns the code for a state Given a state, returns the code. For example: 'SET 'gb' AS_​COUNTRY LIST_​STATES 200 APPLY_​EACH STATE_​CODE END_​APPLY_​EACH HTML_​OL'.

STATE_​NAME

Package:
Country State Manager
Symbol handle:
state_​name
Description:
Returns the name of a state Given a state, returns the name. For example: 'SET 'gb' AS_​COUNTRY LIST_​STATES 200 APPLY_​EACH STATE_​NAME END_​APPLY_​EACH HTML_​OL'.

STORE

Package:
Magic Data Symbols1
Symbol handle:
store
Description:
Synonym for SAVE Saves the the result of preceding symbols and context into a memory using the following symbol as a key and returns the same value while keeping the context. Memory storage is transient, lasting only while the page is rendering. For example 'SET "Whatever you want" SAVE my_​key_​name RETRIEVE my_​key_​name' will return "Whatever you want".

STORE_​TO_​SESSION

Package:
Black Magic Data
Symbol handle:
store_​to_​session
Description:
Synonym for SAVE_​TO_​SESSION. Saves the the result of preceding symbols and context into session memory using the following symbol as a key and returns the same value while keeping the context. Memory storage is persistent with the session, lasting for the duration of the session. For example 'SET "Whatever you want" SAVE_​TO_​SESSION my_​key_​name RETRIEVE_​FROM_​SESSION my_​key_​name' will return "Whatever you want".

STR_​TO_​TIME

Package:
Magic Data Symbols1
Symbol handle:
str_​to_​time
Description:
Translates a string to a system time. Takes the previous result as a string and processes it using the php strtotime() function to return a system time value. For example 'SET "next Thursday" STR_​TO_​TIME DATE "DATE_​APP_​GENERIC_​MDYT_​FULL"'.

subtract -

Package:
Magic Data Symbols1
Symbol handle:
subtract
Description:
Subtracts two numbers. Takes the previous result as a number and subtracts the following number. For example: 'SET "3.7" - "1.6" .'.

SWITCH

Package:
Magic Data Symbols1
Symbol handle:
switch
Description:
Retururns one of many following values. The value switched on is taken from the result from previous symbols. The possible values are taken from the immediately next symbol, as a pipe '|' separated list. These first matching position will be used to index into following symbols or subexpressions and returnin the corresponding result of subexpression evaluation. If no match is found then null is returned. For example: 'SET b SWITCH a|b|c|d "result string a" "result string b" "result string c" "result string d"' will return "result string b". A default result can be attached by appending 'OR SET "my default text"'.

T

Package:
Magic Data Symbols1
Symbol handle:
t
Description:
Applies the t translation function. The t translation funtion is applied to the preceding symbols.

THAT

Package:
Magic Data Symbols1
Symbol handle:
that
Description:
Returns value and context from the start of the next-out subexpression Within any type of subsexpression, returns the value and context from the start of the subexression that encloses the current subexpression. Specifically, within symbols like APPLY_​EACH, FILTER_​LIST or APPLY_​SNIPPET_​FILE. For example: 'SET 1 AS_​PAGE LIST_​PAGES 10 APPLY_​EACH PAGE_​NAME . " - " . ( THAT OWNER USERNAME ) END_​APPLY_​EACH HTML_​OL' "THAT" is particularly useful inside parenthesis because opening parenthesis begins a new subexpression and pushes what was THIS further away. Also see THIS and WHATEVER.

THEME

Package:
Magic Data Symbols1
Symbol handle:
theme
Description:
Given a page (collection ) ID, returns the name of the theme. Tries to find the result of preceding symbols as a path or Page ID, returning the theme for the page or null. Sets the context as null.

THIS

Package:
Magic Data Symbols1
Symbol handle:
this
Description:
Returns value and context from the start of the current subexpression Within any type of subsexpression, returns the value and context from the start of the subexression. Specifically, within symbols like APPLY_​EACH, FILTER_​LIST or APPLY_​SNIPPET_​FILE. For example: 'SET 1 AS_​PAGE LIST_​PAGES 10 APPLY_​EACH PAGE_​NAME SAVE "m1" THIS OWNER USERNAME SAVE "m2" "{{m1}} - {{m2}}" FORMAT END_​APPLY_​EACH HTML_​OL' Also see THAT and WHATEVER.

TIME

Package:
Magic Data Symbols1
Symbol handle:
time
Description:
The current server time. Usual unix/linux time as an integer number of seconds since 1970

TIME_​PUBLIC

Package:
Magic Data Symbols1
Symbol handle:
time_​public
Description:
Synonym for PAGE_​PUBLIC_​TIME. Returns the date/time the page version was published as a system epoch time. The page is taken from the previous result. For example 'PAGE PAGE_​PUBLIC_​TIME DATE "d-m-Y"'. Note: this may not be the same as PAGE_​ADDED_​TIME.

TIME_​TODAY

Package:
Magic Data Symbols1
Symbol handle:
time_​today
Description:
The system time for a time on the current day. Takes the previous result as a 24 hour time of format hh or hh:mm or hh:mm:ss and returns that as a system time on the current day. For example 'SET 01:13 TIME_​TODAY DATE "DATE_​APP_​GENERIC_​MDYT_​FULL"'.

TRIGGER_​BLOCKS_​BY_​AJAX_​BUTTON

Package:
Blocks by AJAX
Symbol handle:
trigger_​blocks_​by_​ajax_​button
Description:
Shows a button to trigger a blocks_​by_​ajax event in the browser. Takes the preceding result as a jQuery/CSS selector and the following parameter as a label for the button. Then renders a button which, when clicked, will trigger the blocks_​by_​ajax event on that selector. For example: 'SET ".blocks_​by_​ajax" TRIGGER_​BLOCKS_​BY_​AJAX_​BUTTON "AJAX Now!"'.

TRIGGER_​DOM_​EVENT_​BUTTON

Package:
Blocks by AJAX
Symbol handle:
trigger_​dom_​event_​button
Description:
Shows a button to trigger a DOM event in the browser. Takes the preceding result as a jQuery/CSS selector and the following two parameters as a browser DOM event name and a label for the button. Then renders a button which, when clicked, will trigger that event. For example: 'SET ".blocks_​by_​ajax" TRIGGER_​DOM_​EVENT_​BUTTON "blocks_​by_​ajax" "AJAX Now!"'.

TRIM

Package:
Magic Data Symbols1
Symbol handle:
trim
Description:
Trims leading and trailing white space. Trims any white space characters including new lines and tabs.

TRUNCATE

Package:
Magic Data Symbols1
Symbol handle:
truncate
Description:
Truncates to a number of characters. Treating the previous result as a string, truncates the string according to a numeric character count from an optional following parameter, returning the truncated string. The defult truncation is 100 characters. When truncated, shows elipses. For example: 'SET /about AS_​PAGE PAGE_​DESCRIPTION TRUNCATE 100'. DANGER No allowance is made for embedded HTML tags. To be safe, SANITIZE any HTML string first.

TRUNCATE_​BY_​WORD

Package:
Magic Data Symbols1
Symbol handle:
truncate_​by_​word
Description:
Truncates to a number of words. Treating the previous result as a string, truncates the string according to a numeric word count from an optional following parameter, returning the truncated string. The defult truncation is 20 words. When truncated, shows elipses. For example: 'SET /about AS_​PAGE PAGE_​DESCRIPTION TRUNCATE_​TO_​WORD 10'. DANGER No allowance is made for embedded HTML tags. To be safe, SANITIZE any HTML string first.

TRUNCATE_​TO_​WORD

Package:
Magic Data Symbols1
Symbol handle:
truncate_​to_​word
Description:
Truncates to a number of characters. Treating the previous result as a string, truncates the string according to a numeric character count from an optional following parameter, returning the truncated string. The defult truncation is 100 characters. When truncated, shows elipses. For example: 'SET /about AS_​PAGE PAGE_​DESCRIPTION TRUNCATE_​TO_​WORD 100'. DANGER No allowance is made for embedded HTML tags. To be safe, SANITIZE any HTML string first.

UBER_​LIST_​EXTENDED_​CONTEXT

Package:
Uber List
Symbol handle:
uber_​list_​extended_​context
Description:
Get the current extended context Some Magic Data symbols use an extended context to help maintain state. Returns that state. Can be useful as a diagnostic when developing complex lists.

UBER_​LIST_​INDEX

Package:
Uber List
Symbol handle:
uber_​list_​index
Description:
Get the current offset in an Uber List Use within Uber List to return the current position in the list. The first item has an index of 1.

UBER_​LIST_​ITEM

Package:
Uber List
Symbol handle:
uber_​list_​item
Description:
Get the current Uber List item Use within Uber List to return the current list item and context.

UBER_​LIST_​ITEMS

Package:
Uber List
Symbol handle:
uber_​list_​items
Description:
Get the entire Uber List Use within Uber List to return the entire Uber List and context.

UCP_​CACHE_​MODE_​OVERRIDE

Package:
Universal Content Puller
Symbol handle:
ucp_​cache_​mode_​override
Description:
Override the cache mode of following Universal Content Puller blocks Takes a cache mode for Universal Content Puller as an incoming parameter and sets that to override any following UCP blocks. Passing any unknown cache mode will clear the override. For example: 'SET "by_​groups" UCP_​CACHE_​MODE_​OVERRIDE '. Available cache modes are; "global", "All (default)", "global_​p", "By page", "global_​pp", "By parent page", "global_​ppp", "By grandparent page", "by_​user", "By individual user (session)", "by_​user_​p", "By individual user (session) and page", "by_​user_​pp", "By individual user (session) and parent page", "by_​user_​ppp", "By individual user (session) and grandparent page", "registered", "By guests/users", "registered_​p", "By guests/users and page", "registered_​pp", "By guests/users and parent page", "registered_​ppp", "By guests/users and grandparent page", "by_​groups", "By groups", "by_​groups_​p", "By groups and page", "by_​groups_​pp", "By groups and parent page", "by_​groups_​ppp", "By groups and grandparent page"

UID

Package:
Magic Data Symbols1
Symbol handle:
uid
Description:
Returns the current user ID. Synonym for CURRENT_​USER. May be used interchangeably.

UPDATED_​BY

Package:
Magic Data Symbols1
Symbol handle:
updated_​by
Description:
The user that last updated a page or file. Given a file or page, returns the User ID for the user who last updated the file or page. For example: 'SET /about UPDATED_​BY USERNAME'.

URL

Package:
Magic Data Symbols1
Symbol handle:
url
Description:
The full url for a page or file. Given a file or page, returns the full URL for the file or page or null. For example: 'SET 1 CONTEXT Page URL'.

USER

Package:
Magic Data Symbols1
Symbol handle:
user
Description:
Synonym for CURRENT_​USER and UID Returns the current user.

USERNAME

Package:
Magic Data Symbols1
Symbol handle:
username
Description:
Get a user name from a user ID Tries to find the result of preceding symbols as a user ID or email, returning a user name or null. Sets the context as 'User' or null.

USER_​NAME

Package:
Magic Data Symbols1
Symbol handle:
user_​name1
Description:
Synonym for USERNAME. May be used interchangeably. Tries to find the result of preceding symbols as a user ID or email, returning a user name or null. Sets the context as 'User' or null.

USER_​TIME

Package:
Magic Data Symbols1
Symbol handle:
user_​time
Description:
The current server time. Usual unix/linux time, corrected for the user time zone, as an integer number of seconds since 1970

USER_​TIMEZONE

Package:
Magic Data Symbols1
Symbol handle:
user_​timezone
Description:
Get a user timezone from a user ID Tries to find the result of preceding symbols as a user ID or name, returning the timezone or null. Sets the context as null.

USER_​WITH_​EMAIL

Package:
Magic Data Symbols1
Symbol handle:
user_​with_​email
Description:
Get a user ID from an email address Tries to find the result of preceding symbols as a user email, returning a User ID or null. The context is 'User' or null.

USER_​WITH_​NAME

Package:
Magic Data Symbols1
Symbol handle:
user_​with_​name
Description:
Get a user ID from a user name Tries to find the result of preceding symbols as a user name, returning a User ID or null. The context is 'User' or null.

WHATEVER

Package:
Magic Data Symbols1
Symbol handle:
whatever
Description:
Returns value and context from start of the nth-out subexpression When you need to get subexpression starting value and context beyond what THIS or THAT provide, WHATEVER indexes further out. THIS is equivalent to WHATEVER 1. THAT is equivalent to WHATEVER 2. For example: 'SET 1 AS_​PAGE LIST_​PAGES 10 APPLY_​EACH PAGE_​NAME . " - " . ( WHATEVER 2 OWNER USERNAME ) END_​APPLY_​EACH HTML_​OL' Also see THIS and THAT.

WITH_​API_​SERVER

Package:
Black Magic Data
Symbol handle:
with_​api_​server
Description:
Note the API server for subsequent API evaluations. Takes the previous result as an API server and remembers that as the current server. For example: 'SET 'remote_​name' AS_​API_​SERVER WITH_​API_​SERVER'.

WITH_​CART

Package:
Magic Data Commerce
Symbol handle:
with_​cart
Description:
The shopping cart will be the subject of subsequent order enquiries. Most order enquiries can relate to any order the current cart. This symbol is used by itself to note that the current shopping cart is the subject of any following order enquiries. Any previous result is maintained. For example: 'WITH_​CART'.

WITH_​FORM

Package:
Magic Data Forms
Symbol handle:
with_​form
Description:
Sets a form. Most form commands act on a currently set form interface, and a currently set form, as set by this symbol. This symbol takes the result of previous symbols as a form name and sets the current form . For example: 'SET 'Core Form' WITH_​FORM_​INTERFACE SET 'Contact Us' WITH_​FORM LIST_​FORM_​RESPONSES 10'

WITH_​FORM_​INTERFACE

Package:
Magic Data Forms
Symbol handle:
with_​form_​interface
Description:
Identifies and sets a form interface. Most form commands act on a currently set form interface, as set by this symbol. This symbol takes the result of previous symbols as a form interface handle, name or package, and resolves that as a form interface handle to set the current form interface. For example: 'SET 'Core Form' WITH_​FORM_​INTERFACE'

WITH_​ORDER

Package:
Magic Data Commerce
Symbol handle:
with_​order
Description:
An order will be the subject of subsequent order enquiries. Most order enquiries can relate to any order the current cart. This symbol is used by itself to note that an order indicated from the previous result is the subject of any following order enquiries. For example: 'LIST_​ORDERS 1 Authorized WITH_​ORDER ORDER_​TOTAL FORMAT_​PRICE'.

WRAP

Package:
Magic Data Symbols1
Symbol handle:
wrap
Description:
Wrap a text string. Takes the previous result as a text string and wraps it in text provided by the following two symbols. For example: ' "Hello world" WRAP "<div class="my-class">" "</div>" '.

WRAP_​WITH_​BLOCKS_​BY_​AJAX_​AUTO_​TRIGGER

Package:
Blocks by AJAX
Symbol handle:
wrap_​with_​blocks_​by_​ajax_​auto_​trigger
Description:
Make any form element change into a trigger for a blocks_​by_​ajax event in the browser. Similar to WRAP_​WITH_​BLOCKS_​BY_​AJAX_​TRIGGER, but automatically triggers on any chage of input. For example: 'SET "My Text Value" FORM_​INPUT_​CHECKBOX "my_​checkbox_​input" WRAP_​WITH_​BLOCKS_​BY_​AJAX_​AUTO_​TRIGGER ".blocks_​by_​ajax:first"'.

WRAP_​WITH_​BLOCKS_​BY_​AJAX_​TRIGGER

Package:
Blocks by AJAX
Symbol handle:
wrap_​with_​blocks_​by_​ajax_​trigger
Description:
Make anything into a trigger for a blocks_​by_​ajax event in the browser. Wraps the preceding result in a clickable span and takes the following parameter as a jQuery/CSS selector for a Blocks By AJAX block. When clicked it will trigger the blocks_​by_​ajax event, including any form elements within it. For example: 'PAGE FORM_​INPUT_​HIDDEN "page_​id" . "Click Me" WRAP_​WITH_​BLOCKS_​BY_​AJAX_​TRIGGER ".blocks_​by_​ajax:first"'.

YARR_​PIRATE_​SPEAK

Package:
Pirate Speak
Symbol handle:
yarr_​pirate_​speak
Description:
Translate yer text t' Pirate Speak. Takes the result of preceding symbols as text and translates that text into pirate speak.

ZBS_​ORDER_​SHIPPING_​COST

Package:
Zone Based Shipping
Symbol handle:
zbs_​order_​shipping_​cost
Description:
Returns the ZBS shipping cost for an order. Calculates the shipping cost for an an order. An optional following parameter may specify a delivery option and defaults to the first available delivery option. Accuracy depends on a shipping address being known. For example: 'WITH_​CART ZBS_​ORDER_​SHIPPING_​COST'.

ZBS_​ORDER_​ZONE

Package:
Zone Based Shipping
Symbol handle:
zbs_​order_​zone
Description:
Returns the ZBS shipping zone for an order. The zone as determined by evaluating by Zone Map rules. Accuracy depends on a shipping address being known. For example: 'WITH_​CART ZBS_​ORDER_​ZONE ZBS_​ZONE_​NAME'.

ZBS_​ZONE_​NAME

Package:
Zone Based Shipping
Symbol handle:
zbs_​zone_​name
Description:
Returns the ZBS shipping zone for an order. Get the name for a shipping zone. For example: 'WITH_​CART ZBS_​ORDER_​ZONE ZBS_​ZONE_​NAME'.

ZERO_​AS

Package:
Magic Data Symbols1
Symbol handle:
zero_​as
Description:
Formats zero values. If the preceding symbols evaluate to a false, null or zero equivalent, then returns the immediately following value. Otherwise returns the value.

ZERO_​AS_​NBSP_​THEN_​END

Package:
Magic Data Symbols1
Symbol handle:
zero_​as_​nbsp_​then_​end
Description:
Formats zero values as a non-breaking space and ends. The use of ZERO_​AS_​THEN_​END followed by a non breaking space character is so useful that it has been given a special symbol ZERO_​AS_​NBSP_​THEN_​END. If the preceding symbols evaluate to a false, null or zero equivalent, then returns a non-breaking space   and ends execution. Otherwise returns the value.

ZERO_​AS_​THEN_​END

Package:
Magic Data Symbols1
Symbol handle:
zero_​as_​then_​end
Description:
Formats zero values and ends. If the preceding symbols evaluate to a false, null or zero equivalent, then returns the immediately following value and ends execution. Otherwise returns the value.

Get this addon

You can get Magic Data from the concrete5 marketplace

Documentation & Support

A useful snippet from the Uber List pages

If you have been looking through the exciting list capabilities of the Uber List pages, you will have noticed a common bit of text used in many of ...... more.

Available Symbols

Here we have a list of Magic Data symbols currently installed on this site. This list is by no means complete because there are more addons ...... more.

Developing Symbols

While the symbols provided by Magic Data are extensive and growing all the time, they can never be complete. Magic Data is an addon for developers ...... more.

Entering and Evaluating Magic Data Expressions Inside Blocks

If all you need is to evaluate Magic Data tokens embedded into the text of a block, please see Integrating Magic Data Tokens with other blocks. It ...... more.

Examples of Magic Data in Orders

Some Magic Data Commerce examples to try in the symbol tester. In the symbol tester you can select who the 'current user' is for testing only. ...... more.

Examples of Magic Data in Users and Groups

Some examples to try in the symbol tester for users and group exit times. When learning Magic Data, it often helps to build up sets of symbols ...... more.

Examples of Magic Data when Listing Pages

Some examples to try in the symbol tester for listing pages. When learning Magic Data, it often helps to build up sets of symbols piece by piece ...... more.

Integrating Magic Data Tokens with other blocks

If you know a little php, adding the power of Magic Data token and symbol processing to other blocks is trivial and can easily be directly ...... more.

Magic Data

Powerful token display and symbol processing integrated to core blocks and many other addons. Have you ever thought: 'I want that block to show a ...... more.

Magic Data Enabling a Page List

When enabling a page list template for Magic Data, the basic principle is the same as with Magic Data enabling any block template. Load a Magic ...... more.

Magic Data Enabling for Themes

Theme develoeprs can take the concept of Magic Data templates one step further and enable Magic Data across an entire theme. The concept is very ...... more.

Last updated: over a year ago