C5Magic (legacy)
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_LINK
- Package:
- Magic Data Symbols1
- Symbol handle:
- as_link
- Description:
- Turns an email or url into a link If the result of any preceding symbols cannot be turned into a url or link, then leaves it alone as text.
AS_LINK_NEW_WINDOW
- Package:
- Magic Data Symbols1
- Symbol handle:
- as_link_new_window
- Description:
- Turns an email or url into a link If the result of any preceding symbols cannot be turned into a url or link, then leaves it alone as text. Opens the link in a new browser tab or window.
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_NAMED_LINK
- Package:
- Magic Data Symbols1
- Symbol handle:
- as_named_link
- Description:
- Turns an email or url into a link Creates a link from a url or email address and gives the link a name taken from the following parameter. If the preceding symbols cannot be turned into a url or link, then leaves it alone as text.
AS_NAMED_LINK_NEW_WINDOW
- Package:
- Magic Data Symbols1
- Symbol handle:
- as_named_link_new_window
- Description:
- Turns an email or url into a link Creates a link from a url or email address and gives the link a name taken from the following parameter. If the preceding symbols cannot be turned into a url or link, then leaves it alone as text. Opens the link in a new browser tab or window.
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_DESCRIPTION
- Package:
- Magic Data Developer
- Symbol handle:
- block_description
- Description:
- Returns a block description. Using the result of preceding symbols as an installed block, returns the block description or null. For example: 'SET 'jl_uber_list' AS_BLOCK_TYPE BLOCK_DESCRIPTION'.
BLOCK_NAME
- Package:
- Magic Data Developer
- Symbol handle:
- block_name
- Description:
- Returns a block name. Using the result of preceding symbols as an installed block, returns the block name or null. For example: 'SET 'Magic Data Direct' AS_BLOCK_TYPE BLOCK_NAME'.
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_USERNAME
- Package:
- Magic Data Developer
- Symbol handle:
- c5_user_name1
- Description:
- Synonym for C5_USER_NAME. 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'.
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 ) '.
DIRECTIONS_LINK
- Package:
- Sorcerer's Map
- Symbol handle:
- directions_link
- Description:
- Provides a link to a Google map with directions page Takes a latitude/longitude pair returned by GEO_LATLNG and returns a link for directions from Google. For example: 'SET "Portland Oregon" GEO_LATLNG DIRECTIONS_LINK "How to get to concrete5 home" '.
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" .'.
- Package:
- Magic Data Symbols1
- Symbol handle:
- 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_COOKIE_DATA
- Package:
- Blocks by AJAX
- Symbol handle:
- from_cookie_data
- Description:
- Extracts a item from COOKIE data. Tries to find the result of preceding symbols as a key in the COOKIE data, returning its value as a single item or list, or null. For example: 'SET "My Cookie Name" FROM_COOKIE_DATA'.
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_COOKIE_DATA_KEYS
- Package:
- Blocks by AJAX
- Symbol handle:
- list_cookie_data_keys
- Description:
- List the keys from COOKIE data. Lists all keys in the COOKIE data, returning its value as a single item or list, or null. For example: 'LIST_COOKIE_DATA_KEYS APPLY_EACH FROM_COOKIE_DATA END_APPLY_EACH IMPLODE'.
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_FEATURED_PAGES
- Package:
- Magic Data Symbols1
- Symbol handle:
- list_featured_pages
- Description:
- Returns a list of featured pages beneath a specified page. DANGER Be very cautious about using this for long lists of pages. If the is_featured attribute exists, the page IDs of all featured pages are returned as a list. If the attribute does not exist, this is the same as LIST_PAGES. An optional following numeric parameter limits the returned list. For example: 'SET 1 LIST_FEATURED_PAGES APPLY_EACH PAGE_NAME END_APPLY_EACH IMPLODE_NICELY'.
LIST_FEATURED_PAGES_OF_TYPE
- Package:
- Magic Data Symbols1
- Symbol handle:
- list_featured_pages_of_type
- Description:
- Returns a list of featured pages of a specified type beneath a specified page. DANGER Be very cautious about using this for long lists of pages. If the is_featured attribute exists, the page IDs of all featured pages are returned as a list. If the attribute does not exist, this is the same as LIST_PAGES. 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_FEATURED_PAGES_OF_TYPE "Blog Entry" 1 PAGE_NAME'.
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_BLOCKS
- Package:
- Magic Data Developer
- Symbol handle:
- list_installed_blocks
- Description:
- List of blocks in a package. Using the result of preceding symbols an installed package, returns a list of the blocks installed or null. The context will be 'Block' or null. For example: 'SET 'magic data' AS_INSTALLED_PACKAGE LIST_INSTALLED_BLOCKS 100 APPLY_EACH BLOCK_NAME END_APPLY_EACH HTML_OL'.
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_ICON_LINK
- Package:
- Magic Data Developer
- Symbol handle:
- marketplace_icon_link
- 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 with a link to the marketplace page or null. For example: 'SET 'jl_magic_data' AS_MARKETPLACE_ITEM MARKETPLACE_ICON'. For example: 'SET 'jl_magic_data' AS_INSTALLED_PACKAGE MARKETPLACE_ICON_LINK'.
MARKETPLACE_LINK
- Package:
- Magic Data Developer
- Symbol handle:
- marketplace_link
- Description:
- Returns a link to the marketplace page. Using the result of preceding symbols as a marketplace item or package, returns a link to the marketplace page. For example: 'SET 'jl_magic_data' AS_MARKETPLACE_ITEM MARKETPLACE_LINK'. For example: 'SET 'jl_magic_data' AS_INSTALLED_PACKAGE MARKETPLACE_LINK'.
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_LINK
- Package:
- Magic Data Developer
- Symbol handle:
- marketplace_reviews_link
- Description:
- Returns a link to the marketplace review page. Using the result of preceding symbols as a marketplace item or package, returns a link to the marketplace review page. For example: 'SET 'jl_magic_data' AS_MARKETPLACE_ITEM MARKETPLACE_REVIEWS_LINK'.
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.
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'.
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_LINK
- Package:
- Magic Data Symbols1
- Symbol handle:
- page_link
- Description:
- Given a page, returns a link to the page. Tries to find the result of preceding symbols as a path or Page ID, returning a link to the page with the name of the page or null. For example: 'SET /about CONTEXT Page PAGE_LINK'.
PAGE_LINK_FULL
- Package:
- Magic Data Symbols1
- Symbol handle:
- page_link_full
- Description:
- Given a page, returns a full url link to the page. Tries to find the result of preceding symbols as a path or Page ID, returning a full url link to the page with the name of the page or null. For example: 'SET /about CONTEXT Page PAGE_LINK_FULL'.
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_PAGE_LINK
- Package:
- Magic Data Commerce
- Symbol handle:
- product_page_link
- Description:
- Given a product, returns a link to the product page. Using the result of preceding symbols as a product or product ID, returns a link to the product page or null. For example: 'SET 'ruddy duck' AS_PRODUCT PRODUCT_PAGE_LINK'.
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_SEARCH_LINK
- Package:
- Magic Data Commerce
- Symbol handle:
- product_search_link
- Description:
- Given a product, returns a link into a product search page. Using the result of preceding symbols as a product or product ID and the following parameter as a page that contains a product search block, returns a link to the search page that will show the product or null. For example: 'SET 'ruddy duck' AS_PRODUCT PRODUCT_SEARCH_LINK "Catalog"'.
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.
SEARCH_LINK
- Package:
- Magic Data Symbols1
- Symbol handle:
- search_link
- Description:
- Given a some text, returns a link into a search page. Using the result of preceding symbols as the search text and the following parameter as a page that contains a search block, returns a link to the search page to show the search rersults. For example: 'SET 'magic data' SEARCH_LINK "Search"'.
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_ICON_LINK
- Package:
- Magic Data Developer
- Symbol handle:
- showcase_icon_link
- Description:
- An icon linking to a showcase page. Given a showcase site, returns icon for the showcase site with a link to the showcase page or null. For example: 'SET '51576 ' AS_C5_USER LIST_SHOWCASE_SITES 100 APPLY_EACH SHOWCASE_ICON_LINK 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"'.
SUBSTITUTE_LINKS_LOCAL
- Package:
- Magic Data Developer
- Symbol handle:
- substitute_links_local
- Description:
- Substitute local links for external links. Will look through preceding results for external links or URLs and, where a local page with equivalent path or handle exits, substitute a local URL.
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_BLOCKS_BY_AJAX_LINK
- Package:
- Blocks by AJAX
- Symbol handle:
- trigger_blocks_by_ajax_link
- Description:
- Shows a link 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 link. Then renders a button which, when clicked, will trigger the blocks_by_ajax event. For example: 'SET ".blocks_by_ajax" TRIGGER_BLOCKS_BY_AJAX_LINK "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!"'.
TRIGGER_DOM_EVENT_LINK
- Package:
- Blocks by AJAX
- Symbol handle:
- trigger_dom_event_link
- Description:
- Shows a link 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 link. Then renders a link which, when clicked, will trigger that event. For example: 'SET ".blocks_by_ajax" TRIGGER_DOM_EVENT_LINK "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.
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.
Integrate Magic Data with Avatar add-on, and Facebook social plugins
Last updated: over a year ago.... 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