{{ request }} object

currentmember

When a user is logged in to a secure zone, the request.currentmember property (part of the request object) will return the logged in member's data. An example is below:

{
    "is_logged": true,
    "currentmember": {
        "id": 162,
        "email": "asmith@example.com",
        "firstname": "Alex",
        "lastname": "Smith",
        "address": null,
        "city": null,
        "state": null,
        "zipcode": null,
        "country": "Australia",
        "site": null,
        "phone": null,
        "status": "",
        "notes": "",
        "type": 2,
        "stripecustomerportallink": "https://YOUR-SITE.treepl.co/public/api/stripe/create-customer-portal-session",
        "isDataUsingAllowed": true,
        "createddatetime": "9/11/2019 3:32:23 AM",
        "updateddatetime": "3/24/2021 2:44:32 AM",
        "securezones": [
            {
            "id": 2,
            "name": "Members Secure Zone",
            "landingpageid": 2541,
            "createddatetime": "2018-11-21T15:17:23.037",
            "updateddatetime": "2018-11-21T15:17:23.037",
            "expirydatetime": "9999-12-30T13:00:00"
            }
        ]
    }
}

To access data within the securezones array you can use a forloop to loop through each secure zone item.
So we might render a list of available secure zones and their expiry dates, like so:

<ul>
{% for zone in request.currentmember.securezones %}
    <li>{{zone.name}} (Expiry: {{zone.expirydatetime | date}})</li>
{% endfor %}
</ul>

Rendering the following details:

• Members Secure Zone (Expiry: 30-Dec-9999)

device_type

The possible values provided by the device_type property are:

• Desktop: when a desktop browser is rendering the page.
• Tablet: when a tablet browser is rendering the page.
• Mobile: when a mobile/smart phone browser is rendering the page.

A typical use case for this property is to display different content depending on the users device.

The following Liquid example will render different results on the three different device types:

{% case request.device_type %}
{% when 'Mobile' %}
    <p>I'm mobile</p>
{% when 'Tablet' %}
    <p>I'm an iPad or similar tablet.</p>
{% else %}
    <p>I must be a desktop.</p>
{% endcase %}

When using the output values in Liquid logic they are case sensitive. So, {% if request.device_type == "desktop" %}... will not work, whereas {% if request.device_type == "Desktop" %}... will work.

params

‘Params’ refers to any URL Parameters being passed in the current page URL. These are also sometimes called ‘Query Strings’.

URL Parameters can be used to pass addition or variable information to a page. This information might be specific to the user or carry some data from the previous page the user has come from.

A common use case is for analytical tracking and/or personalisation of the page based on a marketing campaign link, say, from an email campaign.

So the user might receive an email campaign with a link to your landing page and the link has been constructed to contain the user's name and campaign ID - so you can use their name to personalise your website landing page and use the ID in your analytics tracking script.

Using Liquid we can extract those URL parameters and render them into your page at time of page load.

Constructed link example:

<a href="https://www.yoursite.com/landing-page?fname=Joe&lname=Smith&campid=12345">Visit Landing Page</a>

Take particular notice of the URL Parameter structure added to the landing page path:

?fname=Joe&lname=Smith&campid=12345

The request object will contain each of the URL Parameter’s key/value pairs.

So using the following Liquid tag will give us access to all the URL Parameters:

{{request.request_url.params}}

{
    "fname": "Joe",
    "lname": "Smith",
    "campid": "12345"
}

Therefore, you could render the user’s first name into the page heading, for example:

<h1>Welcome {{request.request_url.params.fname}}</h1>

<h1>Welcome Joe</h1>

For more information on URL Parameters/Query Strings check the External Resources section below for relevant links.

JSON Output

You can output the full JSON for your component data by referencing the root Liquid object {{this}} in your module’s layouts, or directly on your page, if using the collectionVariable parameter in your component tag.

For example:

{% component type: ... collectionVariable: "myData" %}

You can then render the JSON like so:

{{myData}}

For more details on using this approach, see Part 2 of the free ‘Learning Liquid Course’.

Rendering Property Values

As an example of rendering a desired value to the page you could use the following Liquid:

{{ request.request_data.is_mobile }}

This would output the value 0 to the page based on the above example data.

By the way, the is_mobile property is a boolean indicating whether the device being used is a mobile device or not. Where 0 indicated it is not a mobile device and 1 indicated it is a mobile device.

Extending on this example, we can use this value in a conditional Liquid statement to display different content on a page for mobile devices like so:

{% if request.request_data.is_mobile == 1 %}
    <p>You're viewing mobile enabled content!</p>
{% else %}
    <p>You're viewing desktop content!</p>
{% endif %}

<script>
    console.log({{request}});
</script>

<script>
    console.log({{myCustomCollection | strip_html}});
</script>

Related Articles

• Liquid Objects & Usage
  Working with Liquid
  Treepl has implemented the full standard Shopify Liquid library. See the External Resources below for...
• Liquid Objects & Usage
  Liquid Filters
  Liquid Filters allow you to modify the output of a Liquid object, whether that's adding something to it, removing something from it, executing a calculation, creating an array, or a wide variety of other powerful functions.
• Liquid Objects & Usage
  {{ this }} object
  This Liquid object is globally accessible in every liquid template or layout and outputs specific...
• Liquid Objects & Usage
  {{ liquidContext }} object
  This Liquid object is globally accessible in every liquid template or layout and outputs a...
• Liquid Objects & Usage
  {{ siteglobals }}
  This liquid object will output any custom configure Site Information data (found in the Admin's main menu under 'Settings' > 'Site Information').
• Liquid Objects & Usage
  {{ member }} object
  This liquid object will output the Member's details of whom submitted a Form. You can...
• Liquid Objects & Usage
  {{ workflow }} object
  This liquid object will output the Workflow details of a submitted Form. You can use...
• Learning Liquid
  Part 1: Introduction to Liquid
  This free online course covers every aspect of using the Liquid templating language in Treepl CMS - from the very basics right through to advanced implementations.
  
  You’re welcome.
• Learning Liquid
  Part 2: Liquid in Treepl CMS
  In this part of the course we’ll explore how Liquid is implemented in treepl CMS and the overall concepts on using it to harness your website data.
• Learning Liquid
  Part 3: Using Liquid Filters
  In this part of the course we’ll explore using Liquid Filters to transform and manipulate the display of your Treepl CMS website data.
• Learning Liquid
  Part 4: Advanced Liquid Tags
  
• Liquid Components
  domain_settings
  This module component retrieves settings associated with the current domain, or optionally from another specified domain configured in the site instance.
• Liquid Components
  json
  This component parses JSON data for use in Liquid, either from a remote source, a local file, or string.
• Extras
  Migrating from Liquid 2.0 to 3.0
  This article describes differences and possible required actions for migrating from the Liquid rendering engine v2.0 to v3.0.

External Resources

• About URL Parameters/Query Strings

Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.

Questions?

We are always happy to help with any questions you may have.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@treepl.co and we will consult you as soon as possible.