Cookies

The cookies object is available on every page, and contains information regarding the cookies sent with the request. Note that this will typically only include cookies for the current or top-level domain on multi-domain sites.

Properties of {{ cookies }} objects
Name	Type	Description
is_valid	Boolean	Will always be true
keys	list	The list of cookie names on the current request, including cookies that may have been added or removed after the request started processing.
*	String	Individual cookies on this request may be accessed using {{ cookies.cookieName }} or {{ cookies['cookie-name'] }} syntax
output	String	JSON representation of the cookies object, similar to {{ cookies \| inspect: 3, false }}

The cookies object is copyable, and when copied using the {% copy_to_dictionary %} the keys will be the names of the cookies and the values will be the corresponding cookie objects. You may also treat this object as a list containing all of the cookie names which may be iterated using a {% for %} loop.

Every page on the site is created by processing templates using specific pre-defined inputs. These reserved variables are present on the root scope of every pageload.

The client object is available on every page, and contains information about the history of the browser used to access the site. Note that most of these properties are only meaningful if the user has allowed permission for sessions. Additionally, client properties require cookies in order to work. Requests made without cookies (such as by bots or browsers with cookies disabled) or without permission for session will always behave like an initial page-load without existing client information. The client object is one of a handful of simple mechanisms to enable personalization on your site. Used well, these can be powerful tools for developers and website owners.

The request object is available on every page, and contains information regarding the HTTP request that may be useful for serving and rendering the page.

Can be any text, from the empty string ("") to the full HTML output of the template. When used alone in a conditional, all strings evaluates as true - even if they are empty or a value such as "0" or "false".

An enumerable list containing zero or more objects. Lists may contain many different object types, although most lists only contain a single object type. There are a large number of other complex object types that are also lists (ag: an articlelist is a complex object but is also a list of article objects).

{% set_cookie %}

Sets a cookie in the HTTP response.

{% set_cookie cookie_name cookie_value attributes %}

{% set_cookie

variable_name

The name of the cookie to set. May be a reference variable

cookie_value

attributes

Key:value pairs with unique keys. May use the variable arguments syntax. Additional directives to use when setting the cookie

attributes

expires

Expiration date/time

path

Cookie path

domain

Cookie domain

secure

True to set the secure flag on the cookie

httponly

True to set the httponly flag on the cookie

There are a small number of reserved and forbidden cookie names, the most prominent being "_mp_permissions" - the name of the cookie used by Marketpath for handling permissions. You must use the {% set_client_permission %} and {% unset_client_permission %} methods to manage permissions instead of manipulating the permissions cookie directly.

Sets the page title.

Sets the meta description for the current page, which is output by default as part of an HTML page's {{ automatic_markup }}.

Saves custom properties on the session. Note that this doesn't mean much unless the user (or the developer) has granted permission for sessions.

Sets the default timezone to use when rendering dates and times on the page that do not already have a separate timezone configured.

Sets the Content-Type header for the HTTP response.

Sets the robots meta directive.

Saves custom properties on the client that will survive across multiple sessions until they are changed, unset, or the "session" permission expires. Note that this doesn't mean much unless the user (or the developer) has granted permission for sessions.

Sets the URL to the favicon for the current page, which is output by default as part of an HTML page's {{ automatic_markup }}.

Saves custom values to predefined profile settings that will be accessible whenever the current profile is logged in. Note that this is meaningless unless the user is logged in. Profile settings may include validation, in which case all settings will be validated before being set and any validation error will prevent the setting(s) from being set. Validation errors may optionally be output to a variable.

Replaces a value on the nearest scope where it has already been defined. If it has not been defined yet, it is stored on the root scope.

Sets one or more headers in the HTTP response.

Defines whether the client has granted or deined permission for a particular feature (eg: sessions). The only permission defined by default is the session permission (configurable in the site properties). However, the template developer may use this mechanism for their own purposes as well. The permissions defined by this method will be stored in the permissions cookie, which may be read and/or modified by client-side javascript.

Sets properties on an editable dictionary object. If the dictionary does not exist it will be created and stored on the current scope. If the dictionary exists but is not editable this will throw an error.

"Unsets" one or more cookies. Because of how cookies work, this will actually ADD the cookie to the response with an expiration date in the past.

Sets the canonical URL for the current page, which is output by default as part of an HTML page's {{ automatic_markup }}.

Sets the HTTP response status code.

Saves custom properties on the profile that will be accessible whenever the current profile is logged in. The properties will be saved to the profile's attribute dictionary. Note that this is meaningless unless the user is logged in.

{% unset_cookie %}

"Unsets" one or more cookies. Because of how cookies work, this will actually ADD the cookie to the response with an expiration date in the past.

{% unset_cookie names %}

{% unset_cookie

names

One or more values. May use the variable arguments syntax. The names of the cookies to unset

Removes properties from an editable dictionary object. If the dictionary does not exist an empty one will be created and stored on the current scope. If the dictionary exists but is not editable this will throw an error.

Removes custom properties from the session.

Removes custom properties from the client.

Removes the specified permissions from the permissions cookie. Note that this is not the same as denying permission since there will be no record that permission was either granted or denied after the permission has been unset.

Removes custom properties from the attribute dictionary of the currently logged-in profile. Note that this is meaningless unless the user is logged in.

Removes custom values from the profile settings for the currently logged-in profile. Note that this is meaningless unless the user is logged in. For settings with a default value this will reset them to the default, and for all other settings this will set them to empty/unselected/false. Profile settings may be required and include validation, in which case all settings will be validated before being removed and any validation error will prevent any settings from being set. Validation errors may optionally be output to a variable.

Sets a cookie in the HTTP response.

Examples

Demonstrates how to access custom cookie.

{%- if cookies.customCookieName -%}
{%- assign cookieValue = cookies.customCookieName -%}
{%- elsif cookies['alternate-cookie-name'] -%}
{%- assign cookieValue = cookies['alternate-cookie-name'] -%}
{%- endif -%}
{%- if cookieValue != empty -%}
<p>Do something with {{ cookieValue }}</p>
{%- endif -%}

{%- var expiresDate = "now" | add_minutes: 20 -%}
{%- set_cookie loginsection "lastsection=accounts" expires:expiresDate path:"/protected" domain:".parentdomain.com" -%}

This example demonstrates the use of the expires, path, and domain parameters of the set_cookie method.

{%- var sectioncookie = 'accountspage' -%}
{%- var sectioncount = cookies[sectioncookie] | to_int | plus: 1 -%}
{%- set_cookie &sectioncookie sectioncount -%}

This example demonstrates the use of a reference variable to set a cookie with a dynamic name.

{%- if session.allowed and permissions.allow_public_statistics -%}
{%- capture statisticsString -%}
SessionStart: {{session.start_date | date: 'MMMM dd, yyyy, H:mm:ss'-}}
SessionRequests: {{session.num_requests-}}
LastRequest: {{request.date | date: 'MMMM dd, yyyy, H:mm:ss'-}}
<<Add other custom statistics here>>
{%- endcapture -%}
{%- set_cookie site_statistics statisticsString -%}
{%- endif -%}

Checks if the "allow_public_statistics" custom permission has been set, and if it has gathers information about the current session statistics for storage in a "site_statistics" cookie - presumably for display using javascript on the site.

Demonstrates how to list all cookies in the current request.

<h4>Cookies:</h4>
<ul>
{%- for cookie in request.cookies -%}
<li><strong>{{cookie}}</strong> = {{cookies[cookie]}}</li>
{%- endfor -%}
</ul>

{%- if cookie.advertising_id -%}
{%- unless permissions.allow_advertising -%}
{%- unset_cookie advertising_id advertising_alt_id -%}
{%- endunless -%}
{%- endif -%}

If the "advertising_id" cookie has been set and the "allow_advertising" permission has NOT been granted, use the unset_cookie method to clear both the "advertising_id" and "advertising_alt_id" cookies.

{%- var unset_cookies = request.query_params.unsetcookies | split: ',' -%}
{%- for cookie in unset_cookies -%}
{%- var cookie_alt = cookie | append:'-alt' -%}
{%- unset_cookie &cookie &cookie_alt -%}
{%- endfor -%}

Checks if the "unsetcookies" query parameter was included in the request, and for each comma-delimited cookie name to unset, unset both the specified cookie and the "-alt" version of the cookie if it exists by using the unset_cookie method with two reference variables.

Cookies

Cookies

{{ cookies }}

Related

{% set_cookie %}

Related

{% unset_cookie %}

Related

Examples