Ce contenu n'est pas disponible dans la langue sélectionnée.
Chapter 1. Liquid Reference
1.1. What are liquids? Copier lienLien copié sur presse-papiers!
Liquid is a simple programming language used for displaying and processing most of the data from the 3scale system available for API providers. Liquid was originally developed by Shopify and is used in many other CMS engines throughout the web. In the 3scale platform, it is used to expose server-side data to your API developers, greatly extending the usefulness of the CMS while maintaining a high level of security.
1.1.1. Pros and cons Copier lienLien copié sur presse-papiers!
Liquids are mainly used to fetch and display server-side data on your Developer Portal pages. However there is much more power in liquids than just this. They serve very well for:
- Altering the DOM and content of a page based on server-side data
- Adding logic to pages, layouts, and partials
- Manipulating the email templates sent to developers
There are some use cases where liquids don’t provide the best solution to the problem, mostly situations where you need to use dynamic data such as input from the user or the page URL.
Some general advice is to use them as the primary way to add logic to the page, but then if you find it impossible or overly complicated, switch to JavaScript (or add them to it, as liquids also work well with JS).
1.2. How to use liquids Copier lienLien copié sur presse-papiers!
Liquid markup is divided into two types: logic tags and output tags. The logic tags, marked as MISSING, are conditional liquid statements that include standard programming language elements such as the "if" clause, loops, etc.
{% if current_user %} <!-- if the user is logged in --> <a href="/logout">Logout</a> <!-- show the logout link --> {% else %} <!-- if the user is not logged in --> <a href="/login">Login</a> <!-- display the login link --> {% endif %}
{% if current_user %} <!-- if the user is logged in -->
<a href="/logout">Logout</a> <!-- show the logout link -->
{% else %} <!-- if the user is not logged in -->
<a href="/login">Login</a> <!-- display the login link -->
{% endif %}
Output tags, marked as '{{ }}', are used to display the value of the tag between the curly braces.
{{ current_user.username }} <!-- display the logged-in user's username value -->
{{ current_user.username }} <!-- display the logged-in user's username value -->
For documentation on logic tags, please refer to the Shopify tutorial. The full reference of the 3scale liquid output tags can be found both on this page as well as in your Admin Portal under Help > Liquid Reference.
1.2.1. Liquid drops, tags, and their meanings Copier lienLien copié sur presse-papiers!
In the 3scale CMS, you will have access to three types of liquid markup:
-
liquid drops (e.g.
{{ current_account.name }}
) -
liquid tags (e.g.
{% content %}
) -
filters (e.g.
{{ form.errors.description | error_class }}
)
You can find a complete list of liquid tags, drops, and filters available here
As you can see, they’re almost the same as the logic and output tags, and they work very similarly. Liquid drops are the most basic structure, and you will be using them most of the time. They give access to certain values stored in the system such as the name of the user and the ID of the application. They’re handled by the interpreter in the same way as any other output tags.
On the other hand, liquid tags are a type of logic tag that renders or accesses certain parts of the system for further customization – for example, to render content in the layout or customize email templates.
Filters, as the name suggests, enable the option of filtering results from the drops, converting values, grouping by some key, etc. There is a group of standard liquids filters, which you can find on the Shopify website) and a group of special 3scale internal filters, which are listed on the reference page.
1.2.2. The context Copier lienLien copié sur presse-papiers!
The context describes which variables (drops) are available to use on the current page. The basic set includes the following variables:
- provider
- urls
- current_user
- current_account
- today
These variables are available on every page throughout the CMS (except for email templates). However, most of the built-in pages will have some additional variables available. For example, the edit user form will have a user variable exposed (instead of current user – on edit user page, the identity of the user is already known). To check which variables are available on the current page, there is a special tag: {% debug:help %}
. It adds the list of all the top-level variables available to use as a comment in the source of the page.
1.2.3. Hierarchy Copier lienLien copié sur presse-papiers!
The direct consequence of the context is that the liquid drops are organized in a hierarchical structure. The available set of variables only gives you the list of the top level drops that are available. Using them, you can get access to elements much deeper inside the hierarchy. For example, if you would like to show the username of the logged-in user, you would write {{ current_user.username }}
.
Displaying lower level drops is a little bit more complicated. Assume that you would like to display the name of the only application for a user. Looking at the reference guide, you can see that the method "applications" is a part of the account drop. This means that applications is an array of single-application tags. If your users are allowed to have more than one application, then you would have to iterate through them using the logic tags. Otherwise, you can refer to the first (and only) application on the account. The code to display this would look like this: {{ current_account.applications.first.name }}
.
1.3. Liquid templates Copier lienLien copié sur presse-papiers!
The following variables are available in every Liquid template:
- provider - all your services, plans and settings under one hood
- urls - routes to built-in pages of the developers portal (login, signup etc.)
- current_user - username, address and rights of the currently logged-in user
- current_account - messages, applications and plans of the currently logged-in user
- today - current date
Builtin pages can also have other variables available (they are mentioned in the CMS editor). For example, an edit user form edit will have a user
variable assigned or while displaying an application detail, you can expect to have a variable application
accessible.
The type of a variable (an important thing to know to use this reference) can be determined by putting a {% debug:help %}
tag into the page which will list all the available variables and it’s types in an HTML comment for you. However, usually they can be guessed quite easily from the method or variable name.
1.4. Drops Copier lienLien copié sur presse-papiers!
- Account drop
- AccountPlan drop
- Alert drop
- Application drop
- ApplicationKey drop
- ApplicationPlan drop
- Base drop
- Base drop
- BillingAddressField drop
- Can drop
- Can drop
- Cas drop
- Contract drop
- Country drop
- CountryField drop
- CurrentUser drop
- Error drop
- Errors drop
- Feature drop
- Field drop
- Flash drop
- Forum drop
- I18n drop
- Invitation drop
- Invoice drop
- LineItem drop
- Message drop
- Message drop
- Metric drop
- Page drop
- Page drop
- Pagination drop
- Part drop
- PaymentGateway drop
- PaymentTransaction drop
- PlanFeature drop
- Post drop
- Post drop
- PricingRule drop
- Provider drop
- ReferrerFilter drop
- Request drop
- Role drop
- Search drop
- Service drop
- ServiceContract drop
- ServicePlan drop
- TimeZone drop
- Today drop
- Topic drop
- Topic drop
- URL drop
- URLs drop
- UsageLimit drop
- User drop
1.5. Tags Copier lienLien copié sur presse-papiers!
- Tag 'braintree_customer_form'
- Tag 'csrf'
- Tag 'content'
- Tag 'content_for'
- Tag 'debug'
- Tag 'email'
- Tag 'flash'
- Tag 'footer'
- Tag 'form'
- Tag 'latest_forum_posts'
- Tag 'latest_messages'
- Tag 'logo'
- Tag 'menu'
- Tag 'oldfooter'
- Tag 'plan_widget'
- Tag 'portlet'
- Tag 'submenu'
- Tag '3scale_essentials'
- Tag 'user_widget'
1.6. Filters Copier lienLien copié sur presse-papiers!
1.7. Drops (up) Copier lienLien copié sur presse-papiers!
1.7.1. Account drop (up) Copier lienLien copié sur presse-papiers!
A developer account. See User
drop if you are looking for the email addresses or similar information.
1.7.1.1. Methods Copier lienLien copié sur presse-papiers!
1.7.1.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ account.errors.name | inline_errors }}
{{ account.errors.name | inline_errors }}
1.7.1.1.2. id Copier lienLien copié sur presse-papiers!
Returns the id of the account
1.7.1.1.3. name Copier lienLien copié sur presse-papiers!
Returns the organization name of the developer’s account
1.7.1.1.4. vat_zero_text Copier lienLien copié sur presse-papiers!
Return a text about a vat zero
1.7.1.1.5. vat_rate Copier lienLien copié sur presse-papiers!
Return the vat rate
1.7.1.1.6. unread_messages Copier lienLien copié sur presse-papiers!
Unread messages
1.7.1.1.7. latest_messages Copier lienLien copié sur presse-papiers!
Return the latest messages
1.7.1.1.8. bought_account_plan Copier lienLien copié sur presse-papiers!
Returns the plan the account has contracted
1.7.1.1.9. bought_account_contract Copier lienLien copié sur presse-papiers!
Returns the contract account
1.7.1.1.10. credit_card_display_number Copier lienLien copié sur presse-papiers!
1.7.1.1.11. credit_card_expiration_date Copier lienLien copié sur presse-papiers!
1.7.1.1.12. credit_card_required? Copier lienLien copié sur presse-papiers!
Returns whether the account is required to enter credit card details
1.7.1.1.13. credit_card_stored? Copier lienLien copié sur presse-papiers!
Returns whether the account has credit card details stored
1.7.1.1.14. credit_card_missing? Copier lienLien copié sur presse-papiers!
Returns whether the account has no credit card details stored
1.7.1.1.15. timezone Copier lienLien copié sur presse-papiers!
Returns timezone of this account
1.7.1.1.16. paid? Copier lienLien copié sur presse-papiers!
Returns whether the account has at least a paid contract
1.7.1.1.17. on_trial? Copier lienLien copié sur presse-papiers!
Returns whether the account is on trial period, i.e. all his paid contracts has to be in trial period
1.7.1.1.18. telephone_number Copier lienLien copié sur presse-papiers!
Returns the telephone number of the account
1.7.1.1.19. approval_required? Copier lienLien copié sur presse-papiers!
Returns whether the account requires approval?
1.7.1.1.20. created_at Copier lienLien copié sur presse-papiers!
Returns UNIX timestamp of account creation (signup) Example: Converting timestamp to JavaScript Date
<script> var data = new Date({{ account.created_at }} * 1000); </script>
<script>
var data = new Date({{ account.created_at }} * 1000);
</script>
1.7.1.1.21. full_address Copier lienLien copié sur presse-papiers!
Can be composed by legal address, city and state
1.7.1.1.22. applications Copier lienLien copié sur presse-papiers!
Returns the applications of the account
1.7.1.1.23. subscribed_services Copier lienLien copié sur presse-papiers!
Returns a array with ServiceContract drops
1.7.1.1.24. admin Copier lienLien copié sur presse-papiers!
Returns the admin user of this account
1.7.1.1.25. extra_fields_plain_text Copier lienLien copié sur presse-papiers!
Returns the extra fields defined for the account as plain text
1.7.1.1.26. fields_plain_text Copier lienLien copié sur presse-papiers!
Returns the fields defined for the account as plain text
1.7.1.1.27. extra_fields Copier lienLien copié sur presse-papiers!
Returns only extra fields with values of this account Example: Print all extra fields
{% for field in account.extra_fields %} {{ field.label }}: {{ field.value }} {% endfor %}
{% for field in account.extra_fields %}
{{ field.label }}: {{ field.value }}
{% endfor %}
1.7.1.1.28. fields Copier lienLien copié sur presse-papiers!
Returns all fields with values of this account Example: Print all fields
{% for field in account.fields %} {{ field.label }}: {{ field.value }} {% endfor %}
{% for field in account.fields %}
{{ field.label }}: {{ field.value }}
{% endfor %}
1.7.1.1.29. builtin_fields Copier lienLien copié sur presse-papiers!
1.7.1.1.30. multiple_applications_allowed? Copier lienLien copié sur presse-papiers!
1.7.1.1.31. billing_address Copier lienLien copié sur presse-papiers!
Returns the billing address of this account
1.7.1.1.32. has_billing_address? Copier lienLien copié sur presse-papiers!
Returns whether this account has a billing address or not
1.7.1.1.33. can Copier lienLien copié sur presse-papiers!
Give access to permission methods
{% if account.can.be_deleted? %} <!-- do something --> {% endif %}
{% if account.can.be_deleted? %}
<!-- do something -->
{% endif %}
1.7.1.1.34. edit_url Copier lienLien copié sur presse-papiers!
1.7.1.1.35. edit_ogone_billing_address_url Copier lienLien copié sur presse-papiers!
1.7.1.1.36. edit_payment_express_billing_address_url Copier lienLien copié sur presse-papiers!
1.7.1.1.37. edit_braintree_blue_credit_card_details_url Copier lienLien copié sur presse-papiers!
1.7.1.1.38. domain Copier lienLien copié sur presse-papiers!
1.7.1.1.39. upgraded? Copier lienLien copié sur presse-papiers!
1.7.1.1.40. requires_credit_card? Copier lienLien copié sur presse-papiers!
1.7.1.1.41. support_email Copier lienLien copié sur presse-papiers!
1.7.1.1.42. finance_support_email Copier lienLien copié sur presse-papiers!
1.7.2. AccountPlan drop (up) Copier lienLien copié sur presse-papiers!
Example: Using account plan drop in liquid
<p class="notice">The examples for plan drop apply here</p>
<p class="notice">The examples for plan drop apply here</p>
1.7.2.1. Methods Copier lienLien copié sur presse-papiers!
1.7.2.1.1. selected? Copier lienLien copié sur presse-papiers!
Returns whether the plan is selected
{% if plan.selected? %} <p>You will signup to {{ plan.name }}</p> {% endif %}
{% if plan.selected? %}
<p>You will signup to {{ plan.name }}</p>
{% endif %}
1.7.2.1.2. bought? Copier lienLien copié sur presse-papiers!
Returns whether the plan is bought
{% if plan.bought? %} <p>You are on this plan already!</p> {% endif %}
{% if plan.bought? %}
<p>You are on this plan already!</p>
{% endif %}
1.7.2.1.3. features Copier lienLien copié sur presse-papiers!
Returns an array of available features
1.7.2.1.4. setup_fee Copier lienLien copié sur presse-papiers!
Returns the setup fee
1.7.2.1.5. name Copier lienLien copié sur presse-papiers!
Returns the name of the plan
<h2>We offer you a new {{ plan.name }} plan!</h2>
<h2>We offer you a new {{ plan.name }} plan!</h2>
1.7.2.1.6. system_name Copier lienLien copié sur presse-papiers!
Returns the system name of the plan
1.7.2.1.7. id Copier lienLien copié sur presse-papiers!
Returns the plan id
1.7.2.1.8. free? Copier lienLien copié sur presse-papiers!
The plan is free if it is not 'paid' (see the 'paid?' method)
1.7.2.1.9. paid? Copier lienLien copié sur presse-papiers!
The plan is 'paid' when it has non-zero fixed or setup fee or there are some pricing rules present
{% if plan.paid? %} <p>this plan is a paid one.</p> {% else %} <p>this plan is a free one.</p> {% endif %}
{% if plan.paid? %}
<p>this plan is a paid one.</p>
{% else %}
<p>this plan is a free one.</p>
{% endif %}
1.7.2.1.10. approval_required? Copier lienLien copié sur presse-papiers!
Returns whether the plan requires approval?
{% if plan.approval_required? %} <p>This plan requires approval.</p> {% endif %}
{% if plan.approval_required? %}
<p>This plan requires approval.</p>
{% endif %}
1.7.2.1.11. flat_cost Copier lienLien copié sur presse-papiers!
Returns the monthly fixed fee of the plan
1.7.3. Alert drop (up) Copier lienLien copié sur presse-papiers!
Example: Using alert drop in liquid
<h2>Alert details</h2> Level {{ alert.level }} Message {{ alert.message }} Utilization {{ alert.utilization }}
<h2>Alert details</h2>
Level {{ alert.level }}
Message {{ alert.message }}
Utilization {{ alert.utilization }}
1.7.3.1. Methods Copier lienLien copié sur presse-papiers!
1.7.3.1.1. level Copier lienLien copié sur presse-papiers!
The alert level can be one of 50, 80, 90, 100, 120, 150, 200, 300.
1.7.3.1.2. message Copier lienLien copié sur presse-papiers!
Text message describing the alert, for example 'hits per minute: 5 of 5'
1.7.3.1.3. utilization Copier lienLien copié sur presse-papiers!
Decimal number marking the actual utilization that triggered the alert (1.0 is equal to 100%).
Used by {{ alert.utilization | times: 100 }} percent.
Used by {{ alert.utilization | times: 100 }} percent.
1.7.4. Application drop (up) Copier lienLien copié sur presse-papiers!
Example: Using application drop in liquid
<h2>Application {{ application.name }} ({{ application.application_id }})</h2> <p>{{ application.description }}</p>
<h2>Application {{ application.name }} ({{ application.application_id }})</h2>
<p>{{ application.description }}</p>
1.7.4.1. Methods Copier lienLien copié sur presse-papiers!
1.7.4.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ application.errors.name | inline_errors }}
{{ application.errors.name | inline_errors }}
1.7.4.1.2. id Copier lienLien copié sur presse-papiers!
Returns the id of the application
1.7.4.1.3. can_change_plan? Copier lienLien copié sur presse-papiers!
Returns 'true' if changing of the application is allowed either directly or by request.
1.7.4.1.4. trial? Copier lienLien copié sur presse-papiers!
Returns true if the contract is still in the trial period.
Note: If you change the trial period length of a plan, it does not affect the existing contracts.
1.7.4.1.5. live? Copier lienLien copié sur presse-papiers!
1.7.4.1.6. state Copier lienLien copié sur presse-papiers!
There are three possible states:
- pending - live - suspended
- pending
- live
- suspended
1.7.4.1.7. remaining_trial_period_days Copier lienLien copié sur presse-papiers!
Number of day still left in the trial period.
1.7.4.1.8. plan Copier lienLien copié sur presse-papiers!
Returns a plan drop with the plan of the application
1.7.4.1.9. plan_change_permission_name Copier lienLien copié sur presse-papiers!
Returns name of the allowed action
1.7.4.1.10. plan_change_permission_warning Copier lienLien copié sur presse-papiers!
Returns a warning messenger of the allowed action
1.7.4.1.11. contract Copier lienLien copié sur presse-papiers!
1.7.4.1.12. admin_url Copier lienLien copié sur presse-papiers!
Returns the admin_url of the application
1.7.4.1.13. name Copier lienLien copié sur presse-papiers!
Returns the name of the application
1.7.4.1.14. can Copier lienLien copié sur presse-papiers!
1.7.4.1.15. oauth Copier lienLien copié sur presse-papiers!
1.7.4.1.16. pending? Copier lienLien copié sur presse-papiers!
Returns 'true' if application state is pending
1.7.4.1.17. buyer_alerts_enabled? Copier lienLien copié sur presse-papiers!
1.7.4.1.18. description Copier lienLien copié sur presse-papiers!
Returns the description of the application
1.7.4.1.19. redirect_url Copier lienLien copié sur presse-papiers!
Returns the redirect url for the OAuth of the application
1.7.4.1.20. filters_limit Copier lienLien copié sur presse-papiers!
Returns the amount of referrer filters allowed for this application
1.7.4.1.21. keys_limit Copier lienLien copié sur presse-papiers!
Returns the amount of application keys allowed for this application
1.7.4.1.22. referrer_filters Copier lienLien copié sur presse-papiers!
Returns the referrer filters associated with this application
1.7.4.1.23. rejection_reason Copier lienLien copié sur presse-papiers!
Returns the reason for rejecting an application
1.7.4.1.24. user_key Copier lienLien copié sur presse-papiers!
Returns the user_key of application
1.7.4.1.25. application_id Copier lienLien copié sur presse-papiers!
Returns the application_id of an application
1.7.4.1.26. key Copier lienLien copié sur presse-papiers!
Returns the application id or the user key
1.7.4.1.27. url Copier lienLien copié sur presse-papiers!
Returns URL of the builtin detail view for this application.
1.7.4.1.28. edit_url Copier lienLien copié sur presse-papiers!
Returns URL of the builtin edit view for this application.
1.7.4.1.29. update_user_key_url Copier lienLien copié sur presse-papiers!
1.7.4.1.30. log_requests_url Copier lienLien copié sur presse-papiers!
1.7.4.1.31. alerts_url Copier lienLien copié sur presse-papiers!
1.7.4.1.32. application_keys_url Copier lienLien copié sur presse-papiers!
1.7.4.1.33. service Copier lienLien copié sur presse-papiers!
Service to which that application belongs to.
1.7.4.1.34. keys Copier lienLien copié sur presse-papiers!
Returns the keys of an application
1.7.4.1.35. user_key_mode? Copier lienLien copié sur presse-papiers!
1.7.4.1.36. app_id_mode? Copier lienLien copié sur presse-papiers!
1.7.4.1.37. change_plan_url Copier lienLien copié sur presse-papiers!
1.7.4.1.38. log_requests? Copier lienLien copié sur presse-papiers!
1.7.4.1.39. application_keys Copier lienLien copié sur presse-papiers!
1.7.4.1.40. extra_fields Copier lienLien copié sur presse-papiers!
Returns non-hidden extra fields with values for this application Example: Print all extra fields
{% for field in application.extra_fields %} {{ field.label }}: {{ field.value }} {% endfor %}
{% for field in application.extra_fields %}
{{ field.label }}: {{ field.value }}
{% endfor %}
1.7.4.1.41. fields Copier lienLien copié sur presse-papiers!
Returns all builtin and extra fields with values for this application Example: Print all fields
{% for field in application.fields %} {{ field.label }}: {{ field.value }} {% endfor %}
{% for field in application.fields %}
{{ field.label }}: {{ field.value }}
{% endfor %}
1.7.4.1.42. builtin_fields Copier lienLien copié sur presse-papiers!
Returns only builtin fields of the application
1.7.4.1.43. cinstance Copier lienLien copié sur presse-papiers!
1.7.5. ApplicationKey drop (up) Copier lienLien copié sur presse-papiers!
1.7.5.1. Methods Copier lienLien copié sur presse-papiers!
1.7.5.1.1. id Copier lienLien copié sur presse-papiers!
1.7.5.1.2. value Copier lienLien copié sur presse-papiers!
1.7.5.1.3. url Copier lienLien copié sur presse-papiers!
1.7.5.1.4. application Copier lienLien copié sur presse-papiers!
1.7.6. ApplicationPlan drop (up) Copier lienLien copié sur presse-papiers!
1.7.6.1. Methods Copier lienLien copié sur presse-papiers!
1.7.6.1.1. selected? Copier lienLien copié sur presse-papiers!
Returns whether the plan is selected
{% if plan.selected? %} <p>You will signup to {{ plan.name }}</p> {% endif %}
{% if plan.selected? %}
<p>You will signup to {{ plan.name }}</p>
{% endif %}
1.7.6.1.2. bought? Copier lienLien copié sur presse-papiers!
Returns whether the plan is bought
{% if plan.bought? %} <p>You are on this plan already!</p> {% endif %}
{% if plan.bought? %}
<p>You are on this plan already!</p>
{% endif %}
1.7.6.1.3. features Copier lienLien copié sur presse-papiers!
Returns the visible features of the plan
{% if plan == my_free_plan %} <p>These plans are the same.</p> {% else %} <p>These plans are not the same.</p> {% endif %}
{% if plan == my_free_plan %}
<p>These plans are the same.</p>
{% else %}
<p>These plans are not the same.</p>
{% endif %}
1.7.6.1.4. setup_fee Copier lienLien copié sur presse-papiers!
Returns the setup fee of the plan
1.7.6.1.5. name Copier lienLien copié sur presse-papiers!
Returns the name of the plan
<h2>We offer you a new {{ plan.name }} plan!</h2>
<h2>We offer you a new {{ plan.name }} plan!</h2>
1.7.6.1.6. system_name Copier lienLien copié sur presse-papiers!
Returns the system name of the plan
1.7.6.1.7. id Copier lienLien copié sur presse-papiers!
Returns the plan id
1.7.6.1.8. free? Copier lienLien copié sur presse-papiers!
The plan is free if it is not 'paid' (see the 'paid?' method)
1.7.6.1.9. paid? Copier lienLien copié sur presse-papiers!
The plan is 'paid' when it has non-zero fixed or setup fee or there are some pricing rules present
{% if plan.paid? %} <p>this plan is a paid one.</p> {% else %} <p>this plan is a free one.</p> {% endif %}
{% if plan.paid? %}
<p>this plan is a paid one.</p>
{% else %}
<p>this plan is a free one.</p>
{% endif %}
1.7.6.1.10. approval_required? Copier lienLien copié sur presse-papiers!
Returns whether the plan requires approval?
{% if plan.approval_required? %} <p>This plan requires approval.</p> {% endif %}
{% if plan.approval_required? %}
<p>This plan requires approval.</p>
{% endif %}
1.7.6.1.11. flat_cost Copier lienLien copié sur presse-papiers!
Returns the monthly fixed fee of the plan
1.7.6.1.12. metrics Copier lienLien copié sur presse-papiers!
Returns the metrics of the plan
1.7.6.1.13. usage_limits Copier lienLien copié sur presse-papiers!
Returns the usage limits of the plan
1.7.6.1.14. service Copier lienLien copié sur presse-papiers!
Returns the service of the plan
1.7.7. Base drop (up) Copier lienLien copié sur presse-papiers!
1.7.7.1. Methods Copier lienLien copié sur presse-papiers!
1.7.7.1.1. login_url Copier lienLien copié sur presse-papiers!
1.7.7.1.2. user_identified? Copier lienLien copié sur presse-papiers!
1.7.8. Base drop (up) Copier lienLien copié sur presse-papiers!
1.7.8.1. Methods Copier lienLien copié sur presse-papiers!
1.7.8.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ base.errors.name | inline_errors }}
{{ base.errors.name | inline_errors }}
1.7.8.1.2. title Copier lienLien copié sur presse-papiers!
Returns the title result
1.7.8.1.3. kind Copier lienLien copié sur presse-papiers!
Returns the kind of result, can be 'topic' or 'page'
1.7.8.1.4. url Copier lienLien copié sur presse-papiers!
Returns the resource url of the result
1.7.8.1.5. description Copier lienLien copié sur presse-papiers!
Returns a descriptive string for the result
1.7.9. BillingAddressField drop (up) Copier lienLien copié sur presse-papiers!
1.7.9.1. Methods Copier lienLien copié sur presse-papiers!
1.7.9.1.1. input_name Copier lienLien copié sur presse-papiers!
1.7.9.1.2. label Copier lienLien copié sur presse-papiers!
1.7.9.1.3. choices Copier lienLien copié sur presse-papiers!
1.7.9.1.4. errors Copier lienLien copié sur presse-papiers!
1.7.9.1.5. html_id Copier lienLien copié sur presse-papiers!
1.7.9.1.7. visible? Copier lienLien copié sur presse-papiers!
1.7.9.1.8. read_only? Copier lienLien copié sur presse-papiers!
1.7.9.1.9. name Copier lienLien copié sur presse-papiers!
1.7.9.1.10. value Copier lienLien copié sur presse-papiers!
1.7.9.1.11. required Copier lienLien copié sur presse-papiers!
1.7.10. Can drop (up) Copier lienLien copié sur presse-papiers!
1.7.10.1. Methods Copier lienLien copié sur presse-papiers!
1.7.10.1.1. be_updated? Copier lienLien copié sur presse-papiers!
1.7.10.1.2. add_referrer_filters? Copier lienLien copié sur presse-papiers!
1.7.10.1.3. add_application_keys? Copier lienLien copié sur presse-papiers!
1.7.10.1.4. regenerate_user_key? Copier lienLien copié sur presse-papiers!
1.7.10.1.5. regenerate_oauth_secret? Copier lienLien copié sur presse-papiers!
1.7.10.1.6. manage_keys? Copier lienLien copié sur presse-papiers!
1.7.10.1.7. delete_key? Copier lienLien copié sur presse-papiers!
1.7.11. Can drop (up) Copier lienLien copié sur presse-papiers!
1.7.11.1. Methods Copier lienLien copié sur presse-papiers!
1.7.11.1.1. change_plan? Copier lienLien copié sur presse-papiers!
1.7.12. Cas drop (up) Copier lienLien copié sur presse-papiers!
1.7.12.1. Methods Copier lienLien copié sur presse-papiers!
1.7.12.1.1. login_url Copier lienLien copié sur presse-papiers!
1.7.12.1.2. user_identified? Copier lienLien copié sur presse-papiers!
1.7.13. Contract drop (up) Copier lienLien copié sur presse-papiers!
Plan of the contract {{ contract.plan.name }}
Plan of the contract {{ contract.plan.name }}
1.7.13.1. Methods Copier lienLien copié sur presse-papiers!
1.7.13.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ contract.errors.name | inline_errors }}
{{ contract.errors.name | inline_errors }}
1.7.13.1.2. id Copier lienLien copié sur presse-papiers!
Returns the id
1.7.13.1.3. can_change_plan? Copier lienLien copié sur presse-papiers!
Returns true if any form of change is possible
1.7.13.1.4. trial? Copier lienLien copié sur presse-papiers!
Returns true if the contract is still in the trial period.
Note: If you change the trial period length of a plan, it does not affect the existing contracts.
1.7.13.1.5. live? Copier lienLien copié sur presse-papiers!
1.7.13.1.6. state Copier lienLien copié sur presse-papiers!
There are three possible states:
- pending - live - suspended
- pending
- live
- suspended
1.7.13.1.7. remaining_trial_period_days Copier lienLien copié sur presse-papiers!
Number of day still left in the trial period.
1.7.13.1.8. plan Copier lienLien copié sur presse-papiers!
Returns the plan of the contract
1.7.13.1.9. plan_change_permission_name Copier lienLien copié sur presse-papiers!
Returns name of the allowed action
1.7.13.1.10. plan_change_permission_warning Copier lienLien copié sur presse-papiers!
Returns a warning messenger of the allowed action
1.7.13.1.11. contract Copier lienLien copié sur presse-papiers!
1.7.14. Country drop (up) Copier lienLien copié sur presse-papiers!
1.7.14.1. Methods Copier lienLien copié sur presse-papiers!
1.7.14.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ country.errors.name | inline_errors }}
{{ country.errors.name | inline_errors }}
1.7.14.1.2. to_str Copier lienLien copié sur presse-papiers!
1.7.14.1.3. code Copier lienLien copié sur presse-papiers!
1.7.14.1.4. label Copier lienLien copié sur presse-papiers!
1.7.15. CountryField drop (up) Copier lienLien copié sur presse-papiers!
1.7.15.1. Methods Copier lienLien copié sur presse-papiers!
1.7.15.1.1. value Copier lienLien copié sur presse-papiers!
Returns ID of the country
{{ account.fields.country.value }} => 42 compare with: {{ account.fields.country }} => 'United States'
{{ account.fields.country.value }} => 42
compare with:
{{ account.fields.country }} => 'United States'
1.7.15.1.2. name Copier lienLien copié sur presse-papiers!
Returns system name of the field
1.7.15.1.3. required Copier lienLien copié sur presse-papiers!
1.7.15.1.6. visible? Copier lienLien copié sur presse-papiers!
1.7.15.1.7. visible Copier lienLien copié sur presse-papiers!
1.7.15.1.8. read_only Copier lienLien copié sur presse-papiers!
1.7.15.1.9. errors Copier lienLien copié sur presse-papiers!
1.7.15.1.10. input_name Copier lienLien copié sur presse-papiers!
1.7.15.1.11. html_id Copier lienLien copié sur presse-papiers!
1.7.15.1.12. label Copier lienLien copié sur presse-papiers!
Returns label of the field
{{ account.fields.country.label }} <!-- => 'Country' -->
{{ account.fields.country.label }}
<!-- => 'Country' -->
1.7.15.1.13. to_str Copier lienLien copié sur presse-papiers!
Returns name of the country
{{ account.fields.country }} => 'United States'
{{ account.fields.country }} => 'United States'
1.7.15.1.14. choices Copier lienLien copié sur presse-papiers!
1.7.16. CurrentUser drop (up) Copier lienLien copié sur presse-papiers!
1.7.16.1. Methods Copier lienLien copié sur presse-papiers!
1.7.16.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ current_user.errors.name | inline_errors }}
{{ current_user.errors.name | inline_errors }}
1.7.16.1.2. admin? Copier lienLien copié sur presse-papiers!
Returns whether the user is an admin.
{% if user.admin? %} <p>You are an admin of your account.</p> {% endif %}
{% if user.admin? %}
<p>You are an admin of your account.</p>
{% endif %}
1.7.16.1.3. username Copier lienLien copié sur presse-papiers!
Returns the username of the user, html escaped.
1.7.16.1.4. account Copier lienLien copié sur presse-papiers!
Returns the account of the user.
1.7.16.1.5. name Copier lienLien copié sur presse-papiers!
Returns the first and surname of the user.
1.7.16.1.6. email Copier lienLien copié sur presse-papiers!
Returns the email of the user.
1.7.16.1.7. password_required? Copier lienLien copié sur presse-papiers!
This method will return true
for users using the builtin Developer Portal authentication mechanisms and false
for those that are authenticated via Janrain, CAS or other single-sign-on method.
{{ if user.password_required? }} {{ endif }}
{{ if user.password_required? }}
{{ endif }}
1.7.16.1.8. sections Copier lienLien copié sur presse-papiers!
Returns the list of sections the user has access to.
1.7.16.1.9. role Copier lienLien copié sur presse-papiers!
Returns the role of the user
1.7.16.1.10. roles_collection Copier lienLien copié sur presse-papiers!
Retuns a list of available roles for the user
1.7.16.1.11. url Copier lienLien copié sur presse-papiers!
Return the resource url of the user
{{ 'Delete' | delete_button: user.url }}
{{ 'Delete' | delete_button: user.url }}
1.7.16.1.12. edit_url Copier lienLien copié sur presse-papiers!
Return the url to edit the user
{{ 'Edit' | link_to: user.edit_url, title: 'Edit', class: 'action edit' }}
{{ 'Edit' | link_to: user.edit_url, title: 'Edit', class: 'action edit' }}
1.7.16.1.13. can Copier lienLien copié sur presse-papiers!
Exposes rights of current user which are dependent on your settings and user’s role. You can call these methods on the returned object:
- invite_user?
- create_application?
- see_log_requests?
{% if current_user.can.see_log_requests? and application.log_requests? %} (<a href="{{ application.log_requests_url }}" class="action edit">App Request Log</a>) {% endif %}
{% if current_user.can.see_log_requests? and application.log_requests? %}
(<a href="{{ application.log_requests_url }}" class="action edit">App Request Log</a>)
{% endif %}
1.7.16.1.14. extra_fields Copier lienLien copié sur presse-papiers!
Returns non-hidden extra fields with values for this user Example: Print all extra fields
{% for field in user.extra_fields %} {{ field.label }}: {{ field.value }} {% endfor %}
{% for field in user.extra_fields %}
{{ field.label }}: {{ field.value }}
{% endfor %}
1.7.16.1.15. fields Copier lienLien copié sur presse-papiers!
Returns all fields with values for this user Example: Print all fields
{% for field in user.fields %} {{ field.label }}: {{ field.value }} {% endfor %}
{% for field in user.fields %}
{{ field.label }}: {{ field.value }}
{% endfor %}
1.7.16.1.16. builtin_fields Copier lienLien copié sur presse-papiers!
Returns all builtin fields with values for this user
1.7.17. Error drop (up) Copier lienLien copié sur presse-papiers!
When a form fails to submit because of invalid data, the errors
array will be available on the related model.
1.7.17.1. Methods Copier lienLien copié sur presse-papiers!
1.7.17.1.1. attribute Copier lienLien copié sur presse-papiers!
Returns attribute of the model to this error is related
{{ account.errors.org_name.first.attribute }} <!-- org_name -->
{{ account.errors.org_name.first.attribute }}
<!-- org_name -->
1.7.17.1.2. message Copier lienLien copié sur presse-papiers!
Returns description of the error
{{ account.errors.first.message }} <!-- can't be blank -->
{{ account.errors.first.message }}
<!-- can't be blank -->
1.7.17.1.3. value Copier lienLien copié sur presse-papiers!
Returns value of the attribute to which the error
is related
{{ account.errors.org_name.first.value }} <!-- => "ACME Co." -->
{{ account.errors.org_name.first.value }}
<!-- => "ACME Co." -->
1.7.17.1.4. to_str Copier lienLien copié sur presse-papiers!
Returns full description of the error (includes the attribute name)
{{ model.errors.first }} <!-- => "Attribute can't be blank" -->
{{ model.errors.first }}
<!-- => "Attribute can't be blank" -->
1.7.18. Errors drop (up) Copier lienLien copié sur presse-papiers!
Example: get all errors
{% for error in form.errors %} attribute: {{ error.attribute }} ... {% endfor %}
{% for error in form.errors %}
attribute: {{ error.attribute }}
...
{% endfor %}
1.7.18.1. Methods Copier lienLien copié sur presse-papiers!
1.7.18.1.1. empty? Copier lienLien copié sur presse-papiers!
Returns true if there are no errors
{% if form.errors == empty %} Congratulations! You have no errors! {% endif %}
{% if form.errors == empty %}
Congratulations! You have no errors!
{% endif %}
1.7.18.1.2. present? Copier lienLien copié sur presse-papiers!
Returns true if there are some errors
{% if form.errors == present %} Sorry, there were some errors. {% endif %}
{% if form.errors == present %}
Sorry, there were some errors.
{% endif %}
1.7.19. Feature drop (up) Copier lienLien copié sur presse-papiers!
1.7.19.1. Methods Copier lienLien copié sur presse-papiers!
1.7.19.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ feature.errors.name | inline_errors }}
{{ feature.errors.name | inline_errors }}
1.7.19.1.2. name Copier lienLien copié sur presse-papiers!
Returns the name of the feature
<h2>Feature {{ feature.name }}</h2>
<h2>Feature {{ feature.name }}</h2>
1.7.19.1.3. description Copier lienLien copié sur presse-papiers!
Returns the description of the feature
1.7.19.1.4. has_description? Copier lienLien copié sur presse-papiers!
Returns whether the feature has description
{% if feature.has_description? %} {{ feature.description }} {% else %} This feature has no description. {% endif %}
{% if feature.has_description? %}
{{ feature.description }}
{% else %}
This feature has no description.
{% endif %}
1.7.20. Field drop (up) Copier lienLien copié sur presse-papiers!
1.7.20.1. Methods Copier lienLien copié sur presse-papiers!
1.7.20.1.1. value Copier lienLien copié sur presse-papiers!
Returns value if the field
Name: {{ account.fields.first_name.value }}
Name: {{ account.fields.first_name.value }}
1.7.20.1.2. name Copier lienLien copié sur presse-papiers!
Returns system name of the field
1.7.20.1.3. required Copier lienLien copié sur presse-papiers!
1.7.20.1.6. visible? Copier lienLien copié sur presse-papiers!
1.7.20.1.7. visible Copier lienLien copié sur presse-papiers!
1.7.20.1.8. read_only Copier lienLien copié sur presse-papiers!
1.7.20.1.9. errors Copier lienLien copié sur presse-papiers!
1.7.20.1.10. input_name Copier lienLien copié sur presse-papiers!
Returns name for the HTML input that is expected when the form is submitted.
<!-- the 'name' attribute will be 'account[country]' -->
<!-- the 'name' attribute will be 'account[country]' -->
1.7.20.1.11. html_id Copier lienLien copié sur presse-papiers!
Returns a unique field identifier that is commonly used as HTML ID attribute.
{{ account.fields.country.html_id }} <!-- => 'account_country' -->
{{ account.fields.country.html_id }}
<!-- => 'account_country' -->
1.7.20.1.12. label Copier lienLien copié sur presse-papiers!
Returns label of the field
{{ account.fields.country.label }} <!-- => 'Country' -->
{{ account.fields.country.label }}
<!-- => 'Country' -->
1.7.20.1.13. to_str Copier lienLien copié sur presse-papiers!
Returns value of the field if used as variable
{{ account.fields.first_name }} => 'Tom'
{{ account.fields.first_name }} => 'Tom'
1.7.20.1.14. choices Copier lienLien copié sur presse-papiers!
Returns array of choices available for that field, if any. For example for a field called fruit
it may respond with ['apple', 'bannana', 'orange']
.
You can define the choices in your /admin/fields_definitions[admin dashboard]. Each of the array elements responds to id
and label
which are usually just the same unless the field is a special builtin one (like country
) It is recommended to use those methods rather that output the choice
'as is' for future compatibility.
1.7.21. Flash drop (up) Copier lienLien copié sur presse-papiers!
1.7.21.1. Methods Copier lienLien copié sur presse-papiers!
1.7.21.1.1. messages Copier lienLien copié sur presse-papiers!
Return an array of messages
{% for message in flash.messages %} <p id="flash-{{ message.type }}"> {{ message.text }} </p> {% endfor %}
{% for message in flash.messages %}
<p id="flash-{{ message.type }}">
{{ message.text }}
</p>
{% endfor %}
1.7.22. Forum drop (up) Copier lienLien copié sur presse-papiers!
1.7.22.1. Methods Copier lienLien copié sur presse-papiers!
1.7.22.1.1. enabled? Copier lienLien copié sur presse-papiers!
Returns true if you have forum functionality enabled.
{% if forum.enabled? %} <a href="/forum">Check out our forum!</a> {% endif %}
{% if forum.enabled? %}
<a href="/forum">Check out our forum!</a>
{% endif %}
1.7.22.1.2. latest_posts Copier lienLien copié sur presse-papiers!
1.7.23. I18n drop (up) Copier lienLien copié sur presse-papiers!
Provide useful strings for i18n support. {{ object.some_date | date: i18n.long_date }}
Provide useful strings for i18n support.
{{ object.some_date | date: i18n.long_date }}
1.7.23.1. Methods Copier lienLien copié sur presse-papiers!
1.7.23.1.1. short_date Copier lienLien copié sur presse-papiers!
Alias for %b %d
Dec 11
Dec 11
1.7.23.1.2. long_date Copier lienLien copié sur presse-papiers!
Alias for %B %d, %Y
December 11, 2013
December 11, 2013
1.7.23.1.3. default_date Copier lienLien copié sur presse-papiers!
Alias for %Y-%m-%d
2013-12-11
2013-12-11
1.7.24. Invitation drop (up) Copier lienLien copié sur presse-papiers!
1.7.24.1. Methods Copier lienLien copié sur presse-papiers!
1.7.24.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ invitation.errors.name | inline_errors }}
{{ invitation.errors.name | inline_errors }}
1.7.24.1.2. email Copier lienLien copié sur presse-papiers!
Returns email address
1.7.24.1.3. accepted? Copier lienLien copié sur presse-papiers!
Returns true if the invitation was accepted
1.7.24.1.4. accepted_at Copier lienLien copié sur presse-papiers!
Returns a date if the invitations was accepted
{{ invitation.accepted_at | date: i18n.short_date }}
{{ invitation.accepted_at | date: i18n.short_date }}
1.7.24.1.5. sent_at Copier lienLien copié sur presse-papiers!
Returns the creation date
{{ invitation.sent_at | date: i18n.short_date }}
{{ invitation.sent_at | date: i18n.short_date }}
1.7.24.1.6. resend_url Copier lienLien copié sur presse-papiers!
Returns the url for resend the invitation
{{ "Resend" | update_button: invitation.resend_url}}
{{ "Resend" | update_button: invitation.resend_url}}
1.7.24.1.7. url Copier lienLien copié sur presse-papiers!
Returns the resource url
{{ "Delete" | delete_button: invitation.url }}
{{ "Delete" | delete_button: invitation.url }}
1.7.25. Invoice drop (up) Copier lienLien copié sur presse-papiers!
1.7.25.1. Methods Copier lienLien copié sur presse-papiers!
1.7.25.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ invoice.errors.name | inline_errors }}
{{ invoice.errors.name | inline_errors }}
1.7.25.1.2. friendly_id Copier lienLien copié sur presse-papiers!
Returns a friendly id
<td> {{ invoice.id }} </td> <td> {{ invoice.name }} </td> <td> {{ invoice.state }} </td> <td> {{ invoice.cost }} {{ invoice.currency }} </td>
<td> {{ invoice.id }} </td>
<td> {{ invoice.name }} </td>
<td> {{ invoice.state }} </td>
<td> {{ invoice.cost }} {{ invoice.currency }} </td>
1.7.25.1.3. name Copier lienLien copié sur presse-papiers!
String composed by month and year
1.7.25.1.4. state Copier lienLien copié sur presse-papiers!
1.7.25.1.5. cost Copier lienLien copié sur presse-papiers!
Returns a number with two decimals
23.00
23.00
1.7.25.1.6. currency Copier lienLien copié sur presse-papiers!
1.7.25.1.7. cost_without_vat Copier lienLien copié sur presse-papiers!
Returns cost withot VAT
1.7.25.1.8. vat_amount Copier lienLien copié sur presse-papiers!
Returns vat ammount
1.7.25.1.9. exists_pdf? Copier lienLien copié sur presse-papiers!
Return true if the pdf was generated
1.7.25.1.10. period_begin Copier lienLien copié sur presse-papiers!
{{ invoice.period_begin | date: i18n.short_date }}
{{ invoice.period_begin | date: i18n.short_date }}
1.7.25.1.11. period_end Copier lienLien copié sur presse-papiers!
{{ invoice.period_end | date: i18n.long_date }}
{{ invoice.period_end | date: i18n.long_date }}
1.7.25.1.12. issued_on Copier lienLien copié sur presse-papiers!
{{ invoice.issued_on | date: i18n.long_date }}
{{ invoice.issued_on | date: i18n.long_date }}
1.7.25.1.13. due_on Copier lienLien copié sur presse-papiers!
{{ invoice.due_on | date: i18n.long_date }}
{{ invoice.due_on | date: i18n.long_date }}
1.7.25.1.14. paid_on Copier lienLien copié sur presse-papiers!
{{ invoice.paid_on | date: i18n.long_date }}
{{ invoice.paid_on | date: i18n.long_date }}
1.7.25.1.15. vat_code Copier lienLien copié sur presse-papiers!
1.7.25.1.16. fiscal_code Copier lienLien copié sur presse-papiers!
1.7.25.1.17. account Copier lienLien copié sur presse-papiers!
Return a AccountDrop
1.7.25.1.18. buyer_account Copier lienLien copié sur presse-papiers!
1.7.25.1.19. line_items Copier lienLien copié sur presse-papiers!
Returns a array of LineItemDrop
1.7.25.1.20. payment_transactions Copier lienLien copié sur presse-papiers!
Returns a array of PaymentTransactionDrop
1.7.25.1.21. url Copier lienLien copié sur presse-papiers!
Return the resource url of the invoice
{{ "Show" | link_to: invoice.url }}
{{ "Show" | link_to: invoice.url }}
1.7.25.1.22. pdf_url Copier lienLien copié sur presse-papiers!
Return the resource url of the invoice pdf
{{ "PDF" | link_to: invoice.pdf_url }}
{{ "PDF" | link_to: invoice.pdf_url }}
1.7.26. Janrain drop (up) Copier lienLien copié sur presse-papiers!
1.7.26.1. Methods Copier lienLien copié sur presse-papiers!
1.7.26.1.1. login_url Copier lienLien copié sur presse-papiers!
1.7.26.1.2. user_identified? Copier lienLien copié sur presse-papiers!
1.7.26.1.3. session_url Copier lienLien copié sur presse-papiers!
1.7.26.1.4. relying_party Copier lienLien copié sur presse-papiers!
1.7.27. LineItem drop (up) Copier lienLien copié sur presse-papiers!
1.7.27.1. Methods Copier lienLien copié sur presse-papiers!
1.7.27.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ line_item.errors.name | inline_errors }}
{{ line_item.errors.name | inline_errors }}
1.7.27.1.2. name Copier lienLien copié sur presse-papiers!
1.7.27.1.3. description Copier lienLien copié sur presse-papiers!
1.7.27.1.4. quantity Copier lienLien copié sur presse-papiers!
1.7.27.1.5. cost Copier lienLien copié sur presse-papiers!
1.7.28. Message drop (up) Copier lienLien copié sur presse-papiers!
1.7.28.1. Methods Copier lienLien copié sur presse-papiers!
1.7.28.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ message.errors.name | inline_errors }}
{{ message.errors.name | inline_errors }}
1.7.28.1.2. id Copier lienLien copié sur presse-papiers!
Returns the id of the message
1.7.28.1.3. subject Copier lienLien copié sur presse-papiers!
If subject is not present then either a truncated body or (no subject)
string is returned.
1.7.28.1.4. body Copier lienLien copié sur presse-papiers!
Body of the message
1.7.28.1.5. created_at Copier lienLien copié sur presse-papiers!
Returns the creation date
{{ message.created_at | date: i18n.short_date }}
{{ message.created_at | date: i18n.short_date }}
1.7.28.1.6. url Copier lienLien copié sur presse-papiers!
URL of the message detail, points either to inbox or outbox.
1.7.28.1.7. state Copier lienLien copié sur presse-papiers!
Either 'read' or 'unread'
1.7.28.1.8. sender Copier lienLien copié sur presse-papiers!
Returns the name of the sender
1.7.28.1.9. to Copier lienLien copié sur presse-papiers!
Returns the name of the receiver
1.7.28.1.10. recipients Copier lienLien copié sur presse-papiers!
1.7.29. Message drop (up) Copier lienLien copié sur presse-papiers!
1.7.29.1. Methods Copier lienLien copié sur presse-papiers!
1.7.29.1.1. type Copier lienLien copié sur presse-papiers!
The possible types of the messages are:
- success (not used by now)
- info
- warning
- danger
1.7.29.1.2. text Copier lienLien copié sur presse-papiers!
1.7.30. Metric drop (up) Copier lienLien copié sur presse-papiers!
1.7.30.1. Methods Copier lienLien copié sur presse-papiers!
1.7.30.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ metric.errors.name | inline_errors }}
{{ metric.errors.name | inline_errors }}
1.7.30.1.2. unit Copier lienLien copié sur presse-papiers!
Returns the unit of the metric
This metric is measured in {{ metric.unit | pluralize }}
This metric is measured in {{ metric.unit | pluralize }}
1.7.30.1.3. description Copier lienLien copié sur presse-papiers!
Returns the description of the metric
1.7.30.1.4. name Copier lienLien copié sur presse-papiers!
Returns the name of the metric
<h4>Metric {{ metric.name }}</h4> <p>{{ metric.description }}</p>
<h4>Metric {{ metric.name }}</h4>
<p>{{ metric.description }}</p>
1.7.30.1.5. system_name Copier lienLien copié sur presse-papiers!
Returns the system name of this metric
<h4>Metric {{ metric.name }}</h4> <p>{{ metric.system_name }}</p>
<h4>Metric {{ metric.name }}</h4>
<p>{{ metric.system_name }}</p>
1.7.30.1.6. usage_limits Copier lienLien copié sur presse-papiers!
Returns the usage limits of the metric
1.7.30.1.7. pricing_rules Copier lienLien copié sur presse-papiers!
Returns the pricing rules of the metric
1.7.30.1.8. has_parent Copier lienLien copié sur presse-papiers!
1.7.31. Page drop (up) Copier lienLien copié sur presse-papiers!
1.7.31.1. Methods Copier lienLien copié sur presse-papiers!
1.7.31.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ page.errors.name | inline_errors }}
{{ page.errors.name | inline_errors }}
1.7.31.1.2. title Copier lienLien copié sur presse-papiers!
Returns the title of the page
<title>{{ page.title }}</title>
<title>{{ page.title }}</title>
1.7.31.1.3. system_name Copier lienLien copié sur presse-papiers!
Returns system name of the page
{% if page.system_name == 'my_page' %} {% include 'custom_header' %} {% endif %}
{% if page.system_name == 'my_page' %}
{% include 'custom_header' %}
{% endif %}
1.7.32. Page drop (up) Copier lienLien copié sur presse-papiers!
1.7.32.1. Methods Copier lienLien copié sur presse-papiers!
1.7.32.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ page.errors.name | inline_errors }}
{{ page.errors.name | inline_errors }}
1.7.32.1.2. title Copier lienLien copié sur presse-papiers!
1.7.32.1.3. kind Copier lienLien copié sur presse-papiers!
1.7.32.1.4. url Copier lienLien copié sur presse-papiers!
1.7.32.1.5. description Copier lienLien copié sur presse-papiers!
1.7.33. Pagination drop (up) Copier lienLien copié sur presse-papiers!
1.7.33.1. Methods Copier lienLien copié sur presse-papiers!
1.7.33.1.1. page_size Copier lienLien copié sur presse-papiers!
Number of items on one full page.
1.7.33.1.2. current_page Copier lienLien copié sur presse-papiers!
Number of the currently selected page.
1.7.33.1.3. current_offset Copier lienLien copié sur presse-papiers!
Items skipped so far.
1.7.33.1.4. pages Copier lienLien copié sur presse-papiers!
Total number of pages.
1.7.33.1.5. items Copier lienLien copié sur presse-papiers!
Total number of items in all pages together.
1.7.33.1.6. previous Copier lienLien copié sur presse-papiers!
Number of the previous page or empty.
1.7.33.1.7. next Copier lienLien copié sur presse-papiers!
Number of the next page or empty.
1.7.33.1.8. parts Copier lienLien copié sur presse-papiers!
Elements that help to render a user-friendly pagination. See the [[part-drop[part drop] for more information.
1.7.34. Part drop (up) Copier lienLien copié sur presse-papiers!
1.7.34.1. Methods Copier lienLien copié sur presse-papiers!
1.7.34.1.1. url Copier lienLien copié sur presse-papiers!
1.7.34.1.2. rel Copier lienLien copié sur presse-papiers!
1.7.34.1.3. current? Copier lienLien copié sur presse-papiers!
1.7.34.1.4. is_link Copier lienLien copié sur presse-papiers!
1.7.34.1.5. title Copier lienLien copié sur presse-papiers!
1.7.34.1.6. to_s Copier lienLien copié sur presse-papiers!
1.7.35. PaymentGateway drop (up) Copier lienLien copié sur presse-papiers!
1.7.35.1. Methods Copier lienLien copié sur presse-papiers!
1.7.35.1.1. braintree_blue? Copier lienLien copié sur presse-papiers!
Returns whether current payment gateway is authorize.Net
1.7.35.1.2. authorize_net? Copier lienLien copié sur presse-papiers!
Returns whether current payment gateway is authorize.Net
1.7.35.1.3. type Copier lienLien copié sur presse-papiers!
Returns the type of this payment gateway.
1.7.36. PaymentTransaction drop (up) Copier lienLien copié sur presse-papiers!
1.7.36.1. Methods Copier lienLien copié sur presse-papiers!
1.7.36.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ payment_transaction.errors.name | inline_errors }}
{{ payment_transaction.errors.name | inline_errors }}
1.7.36.1.2. currency Copier lienLien copié sur presse-papiers!
Returns the currency
1.7.36.1.3. amount Copier lienLien copié sur presse-papiers!
Returns the amount
1.7.36.1.4. created_at Copier lienLien copié sur presse-papiers!
Returns the creation date
1.7.36.1.5. success? Copier lienLien copié sur presse-papiers!
Returns true if was success
1.7.36.1.6. message Copier lienLien copié sur presse-papiers!
Returns the message of the transaction
1.7.36.1.7. reference Copier lienLien copié sur presse-papiers!
Returns the reference
1.7.37. PlanFeature drop (up) Copier lienLien copié sur presse-papiers!
1.7.37.1. Methods Copier lienLien copié sur presse-papiers!
1.7.37.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ plan_feature.errors.name | inline_errors }}
{{ plan_feature.errors.name | inline_errors }}
1.7.37.1.2. name Copier lienLien copié sur presse-papiers!
Returns the name of the feature
<h2>Feature {{ feature.name }}</h2>
<h2>Feature {{ feature.name }}</h2>
1.7.37.1.3. description Copier lienLien copié sur presse-papiers!
Returns the description of the feature
1.7.37.1.4. has_description? Copier lienLien copié sur presse-papiers!
Returns whether the feature has description
{% if feature.has_description? %} {{ feature.description }} {% else %} This feature has no description. {% endif %}
{% if feature.has_description? %}
{{ feature.description }}
{% else %}
This feature has no description.
{% endif %}
1.7.37.1.5. enabled? Copier lienLien copié sur presse-papiers!
1.7.38. Post drop (up) Copier lienLien copié sur presse-papiers!
1.7.38.1. Methods Copier lienLien copié sur presse-papiers!
1.7.38.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ post.errors.name | inline_errors }}
{{ post.errors.name | inline_errors }}
1.7.38.1.2. body Copier lienLien copié sur presse-papiers!
Text of the post.
1.7.38.1.3. topic Copier lienLien copié sur presse-papiers!
Every post belongs to a [[topic-drop[topic]
1.7.38.1.4. created_at Copier lienLien copié sur presse-papiers!
Date when this post created
{{ post.created_at | date: i18n.short_date }}
{{ post.created_at | date: i18n.short_date }}
1.7.38.1.5. url Copier lienLien copié sur presse-papiers!
The url of this post within its topic
1.7.39. Post drop (up) Copier lienLien copié sur presse-papiers!
1.7.39.1. Methods Copier lienLien copié sur presse-papiers!
1.7.39.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ post.errors.name | inline_errors }}
{{ post.errors.name | inline_errors }}
1.7.39.1.2. title Copier lienLien copié sur presse-papiers!
1.7.39.1.3. kind Copier lienLien copié sur presse-papiers!
1.7.39.1.4. url Copier lienLien copié sur presse-papiers!
1.7.39.1.5. description Copier lienLien copié sur presse-papiers!
1.7.40. PricingRule drop (up) Copier lienLien copié sur presse-papiers!
1.7.40.1. Methods Copier lienLien copié sur presse-papiers!
1.7.40.1.1. cost_per_unit Copier lienLien copié sur presse-papiers!
Returns the cost per unit of the pricing rule Example: Using pricing rule drop in liquid
<h2>Pricing rule</h2> Min value {{ pricing_rule.min }} Max value {{ pricing_rule.max }} Cost per unit {{ pricing_rule.cost_per_unit }}
<h2>Pricing rule</h2>
Min value {{ pricing_rule.min }}
Max value {{ pricing_rule.max }}
Cost per unit {{ pricing_rule.cost_per_unit }}
1.7.40.1.2. min Copier lienLien copié sur presse-papiers!
Returns the minimum value of the pricing rule
1.7.40.1.3. max Copier lienLien copié sur presse-papiers!
Returns the maximum value of the pricing rule
1.7.40.1.4. plan Copier lienLien copié sur presse-papiers!
Returns plan of pricing rule
1.7.41. Provider drop (up) Copier lienLien copié sur presse-papiers!
1.7.41.1. Methods Copier lienLien copié sur presse-papiers!
1.7.41.1.1. name Copier lienLien copié sur presse-papiers!
Returns the name of your organization.
1.7.41.1.2. payment_gateway Copier lienLien copié sur presse-papiers!
Returns the payment gateway associated with your organization
1.7.41.1.3. domain Copier lienLien copié sur presse-papiers!
Domain of your developer portal
1.7.41.1.4. timezone Copier lienLien copié sur presse-papiers!
Returns timezone that you use. Can be changed in your /p/admin/account/edit[administration dashboard].
1.7.41.1.5. support_email Copier lienLien copié sur presse-papiers!
Support email of the account
1.7.41.1.6. finance_support_email Copier lienLien copié sur presse-papiers!
Finance support email of the account
1.7.41.1.7. telephone_number Copier lienLien copié sur presse-papiers!
Returns the telephone number of the account
1.7.41.1.8. multiple_applications_allowed? Copier lienLien copié sur presse-papiers!
True if developers can have more separate applications with their own keys, stats, etc. Depends on your 3scale plan.
1.7.41.1.9. logo_url Copier lienLien copié sur presse-papiers!
Return the logo url
1.7.41.1.10. multiple_services_allowed? Copier lienLien copié sur presse-papiers!
True if your 3scale plan allows you to manage multiple APIs as separate services.
{% if provider.multiple_services_allowed? %} {% for service in provider.services %} Service {{ service.name }} is available. {% endfor %} {% endif %}
{% if provider.multiple_services_allowed? %}
{% for service in provider.services %}
Service {{ service.name }} is available.
{% endfor %}
{% endif %}
1.7.41.1.11. finance_allowed? Copier lienLien copié sur presse-papiers!
1.7.41.1.12. multiple_users_allowed? Copier lienLien copié sur presse-papiers!
True if the developer accounts can have multiple logins associated with them (depends on your 3scale plan) and its visibility has been turned on for your develoeper portal in the /p/admin/cms/switches[settings].
1.7.41.1.13. account_plans Copier lienLien copié sur presse-papiers!
Returns all published account plans.
1.7.41.1.14. services Copier lienLien copié sur presse-papiers!
Returns all defined services.
<p>You can signup to any of our services!</p> <ul> {% for service in provider.services %} <li>{{ service.name }} <a href="/signup/service/{{ service.system_name }}">Signup!</a></li> {% endfor %}
<p>You can signup to any of our services!</p>
<ul>
{% for service in provider.services %}
<li>{{ service.name }} <a href="/signup/service/{{ service.system_name }}">Signup!</a></li>
{% endfor %}
1.7.41.1.15. signups_enabled? Copier lienLien copié sur presse-papiers!
You can enable or disable signups in the Usage rules section of your Admin Portal.
1.7.41.1.16. account_management_enabled? Copier lienLien copié sur presse-papiers!
You can enable or disable account management in the Usage rules section.
1.7.42. ReferrerFilter drop (up) Copier lienLien copié sur presse-papiers!
1.7.42.1. Methods Copier lienLien copié sur presse-papiers!
1.7.42.1.1. id Copier lienLien copié sur presse-papiers!
1.7.42.1.2. value Copier lienLien copié sur presse-papiers!
1.7.42.1.3. delete_url Copier lienLien copié sur presse-papiers!
1.7.42.1.4. application Copier lienLien copié sur presse-papiers!
1.7.43. Request drop (up) Copier lienLien copié sur presse-papiers!
Example: Using request drop in liquid
<h2>Request details</h2> URI {{ request.request_uri }} Host {{ request.host }} Host and port {{ request.host_with_port }}
<h2>Request details</h2>
URI {{ request.request_uri }}
Host {{ request.host }}
Host and port {{ request.host_with_port }}
1.7.43.1. Methods Copier lienLien copié sur presse-papiers!
1.7.43.1.1. request_uri Copier lienLien copié sur presse-papiers!
Returns the URI of the request
1.7.43.1.2. host_with_port Copier lienLien copié sur presse-papiers!
Returns the host with port of the request
1.7.43.1.3. host Copier lienLien copié sur presse-papiers!
Returns the host part of the request URL
1.7.43.1.4. path Copier lienLien copié sur presse-papiers!
Returns the path part of the request URL
{% if request.path == '/' %} Welcome on a landing page! {% else %} This just an ordinary page. {% endif %}
{% if request.path == '/' %}
Welcome on a landing page!
{% else %}
This just an ordinary page.
{% endif %}
1.7.44. Role drop (up) Copier lienLien copié sur presse-papiers!
1.7.44.1. Methods Copier lienLien copié sur presse-papiers!
1.7.44.1.1. name Copier lienLien copié sur presse-papiers!
Return internal name of the role, important for the system
1.7.44.1.2. description Copier lienLien copié sur presse-papiers!
Return a descriptiptive text for the role
1.7.45. Search drop (up) Copier lienLien copié sur presse-papiers!
1.7.45.1. Methods Copier lienLien copié sur presse-papiers!
1.7.45.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ search.errors.name | inline_errors }}
{{ search.errors.name | inline_errors }}
1.7.45.1.2. query Copier lienLien copié sur presse-papiers!
Returns the searched string
1.7.45.1.3. total_found Copier lienLien copié sur presse-papiers!
Returns the number of matching elements
1.7.45.1.4. results Copier lienLien copié sur presse-papiers!
Returs an array of results for que search
1.7.46. Service drop (up) Copier lienLien copié sur presse-papiers!
1.7.46.1. Methods Copier lienLien copié sur presse-papiers!
1.7.46.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ service.errors.name | inline_errors }}
{{ service.errors.name | inline_errors }}
1.7.46.1.2. name Copier lienLien copié sur presse-papiers!
Returns the name of the service
1.7.46.1.3. system_name Copier lienLien copié sur presse-papiers!
Returns the system name of the service
1.7.46.1.4. description Copier lienLien copié sur presse-papiers!
Returns the description of the service
1.7.46.1.5. subscribed? Copier lienLien copié sur presse-papiers!
Returns whether the service is subscribed
{% if service.subscribed? %} <p>You already subscribed this service.</p> {% endif %}
{% if service.subscribed? %}
<p>You already subscribed this service.</p>
{% endif %}
1.7.46.1.6. subscription Copier lienLien copié sur presse-papiers!
Returns a subscription(ServiceContract
drop) if the currently logged in user is subscribed to this service, Nil otherwise.
1.7.46.1.7. subscribable? Copier lienLien copié sur presse-papiers!
1.7.46.1.8. subscribe_url Copier lienLien copié sur presse-papiers!
1.7.46.1.9. application_plans Copier lienLien copié sur presse-papiers!
Returns the published application plans of the service
1.7.46.1.10. service_plans Copier lienLien copié sur presse-papiers!
Returns the published service plans of the service
1.7.46.1.11. plans Copier lienLien copié sur presse-papiers!
Returns the application plans of the service
1.7.46.1.12. features Copier lienLien copié sur presse-papiers!
Returns the visible features of the service
1.7.46.1.13. apps_identifier Copier lienLien copié sur presse-papiers!
Depending on the authentication mode set, returns either 'ID', 'API key' or 'Client ID' for OAuth authentication.
{{ service.application_key_name }}
{{ service.application_key_name }}
1.7.46.1.14. backend_version Copier lienLien copié sur presse-papiers!
1.7.46.1.15. referrer_filters_required? Copier lienLien copié sur presse-papiers!
1.7.46.1.16. metrics Copier lienLien copié sur presse-papiers!
Returns the metrics of the service
1.7.46.1.17. support_email Copier lienLien copié sur presse-papiers!
Support email of the service
1.7.47. ServiceContract drop (up) Copier lienLien copié sur presse-papiers!
1.7.47.1. Methods Copier lienLien copié sur presse-papiers!
1.7.47.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ service_contract.errors.name | inline_errors }}
{{ service_contract.errors.name | inline_errors }}
1.7.47.1.2. id Copier lienLien copié sur presse-papiers!
1.7.47.1.3. can_change_plan? Copier lienLien copié sur presse-papiers!
Returns true if any form of change is possible
1.7.47.1.4. trial? Copier lienLien copié sur presse-papiers!
Returns true if the contract is still in the trial period.
Note: If you change the trial period length of a plan, it does not affect the existing contracts.
1.7.47.1.5. live? Copier lienLien copié sur presse-papiers!
1.7.47.1.6. state Copier lienLien copié sur presse-papiers!
There are three possible states:
- pending - live - suspended
- pending
- live
- suspended
1.7.47.1.7. remaining_trial_period_days Copier lienLien copié sur presse-papiers!
Number of day still left in the trial period.
1.7.47.1.8. plan Copier lienLien copié sur presse-papiers!
Returns the plan of the contract
1.7.47.1.9. plan_change_permission_name Copier lienLien copié sur presse-papiers!
Returns name of the allowed action
1.7.47.1.10. plan_change_permission_warning Copier lienLien copié sur presse-papiers!
Returns a warning messenger of the allowed action
1.7.47.1.11. contract Copier lienLien copié sur presse-papiers!
1.7.47.1.12. name Copier lienLien copié sur presse-papiers!
1.7.47.1.13. system_name Copier lienLien copié sur presse-papiers!
1.7.47.1.14. change_plan_url Copier lienLien copié sur presse-papiers!
1.7.47.1.15. service Copier lienLien copié sur presse-papiers!
1.7.47.1.16. applications Copier lienLien copié sur presse-papiers!
1.7.47.1.17. can Copier lienLien copié sur presse-papiers!
Exposes specific rights of the current user for that subscription.
{% if subscription.can.change_plan? %} ... {% endif %}
{% if subscription.can.change_plan? %}
...
{% endif %}
1.7.48. ServicePlan drop (up) Copier lienLien copié sur presse-papiers!
1.7.48.1. Methods Copier lienLien copié sur presse-papiers!
1.7.48.1.1. selected? Copier lienLien copié sur presse-papiers!
Returns whether the plan is selected
{% if plan.selected? %} <p>You will signup to {{ plan.name }}</p> {% endif %}
{% if plan.selected? %}
<p>You will signup to {{ plan.name }}</p>
{% endif %}
1.7.48.1.2. bought? Copier lienLien copié sur presse-papiers!
Returns whether the plan is bought
{% if plan.bought? %} <p>You are on this plan already!</p> {% endif %}
{% if plan.bought? %}
<p>You are on this plan already!</p>
{% endif %}
1.7.48.1.3. features Copier lienLien copié sur presse-papiers!
Returns the visible features of the plan
{% if plan == my_free_plan %} <p>These plans are the same.</p> {% else %} <p>These plans are not the same.</p> {% endif %}
{% if plan == my_free_plan %}
<p>These plans are the same.</p>
{% else %}
<p>These plans are not the same.</p>
{% endif %}
1.7.48.1.4. setup_fee Copier lienLien copié sur presse-papiers!
Returns the setup fee of the plan
1.7.48.1.5. name Copier lienLien copié sur presse-papiers!
Returns the name of the plan
<h2>We offer you a new {{ plan.name }} plan!</h2>
<h2>We offer you a new {{ plan.name }} plan!</h2>
1.7.48.1.6. system_name Copier lienLien copié sur presse-papiers!
Returns the system name of the plan
1.7.48.1.7. id Copier lienLien copié sur presse-papiers!
Returns the plan id
1.7.48.1.8. free? Copier lienLien copié sur presse-papiers!
The plan is free if it is not 'paid' (see the 'paid?' method)
1.7.48.1.9. paid? Copier lienLien copié sur presse-papiers!
The plan is 'paid' when it has non-zero fixed or setup fee or there are some pricing rules present
{% if plan.paid? %} <p>this plan is a paid one.</p> {% else %} <p>this plan is a free one.</p> {% endif %}
{% if plan.paid? %}
<p>this plan is a paid one.</p>
{% else %}
<p>this plan is a free one.</p>
{% endif %}
1.7.48.1.10. approval_required? Copier lienLien copié sur presse-papiers!
Returns whether the plan requires approval?
{% if plan.approval_required? %} <p>This plan requires approval.</p> {% endif %}
{% if plan.approval_required? %}
<p>This plan requires approval.</p>
{% endif %}
1.7.48.1.11. flat_cost Copier lienLien copié sur presse-papiers!
Returns the monthly fixed fee of the plan
1.7.48.1.12. service Copier lienLien copié sur presse-papiers!
Example: Using service plan drop in liquid
<p class="notice">The examples for plan drop apply here</p> Service of this plan {{ plan.service.name }}
<p class="notice">The examples for plan drop apply here</p>
Service of this plan {{ plan.service.name }}
1.7.49. TimeZone drop (up) Copier lienLien copié sur presse-papiers!
1.7.49.1. Methods Copier lienLien copié sur presse-papiers!
1.7.49.1.1. full_name Copier lienLien copié sur presse-papiers!
1.7.49.1.2. to_str Copier lienLien copié sur presse-papiers!
1.7.50. Today drop (up) Copier lienLien copié sur presse-papiers!
1.7.50.1. Methods Copier lienLien copié sur presse-papiers!
1.7.50.1.1. month Copier lienLien copié sur presse-papiers!
Returns current month (1-12)
1.7.50.1.2. day Copier lienLien copié sur presse-papiers!
Returns current day of the month (1-31)
1.7.50.1.3. year Copier lienLien copié sur presse-papiers!
Returns current year Example: Create dynamic copyright
©{{ today.year }}
©{{ today.year }}
1.7.50.1.4. beginning_of_month Copier lienLien copié sur presse-papiers!
Returns date of beginning of current month
This month began on {{ today.beginning_of_month | date: '%A' }}
This month began on {{ today.beginning_of_month | date: '%A' }}
1.7.51. Topic drop (up) Copier lienLien copié sur presse-papiers!
1.7.51.1. Methods Copier lienLien copié sur presse-papiers!
1.7.51.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ topic.errors.name | inline_errors }}
{{ topic.errors.name | inline_errors }}
1.7.51.1.2. title Copier lienLien copié sur presse-papiers!
1.7.51.1.3. kind Copier lienLien copié sur presse-papiers!
1.7.51.1.4. url Copier lienLien copié sur presse-papiers!
1.7.51.1.5. description Copier lienLien copié sur presse-papiers!
1.7.52. Topic drop (up) Copier lienLien copié sur presse-papiers!
1.7.52.1. Methods Copier lienLien copié sur presse-papiers!
1.7.52.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ topic.errors.name | inline_errors }}
{{ topic.errors.name | inline_errors }}
1.7.52.1.2. title Copier lienLien copié sur presse-papiers!
Name of the topic. Submitted when first post to the thread is posted.
1.7.52.1.3. url Copier lienLien copié sur presse-papiers!
1.7.53. Url drop (up) Copier lienLien copié sur presse-papiers!
1.7.53.1. Methods Copier lienLien copié sur presse-papiers!
1.7.53.1.1. to_s Copier lienLien copié sur presse-papiers!
1.7.53.1.2. to_str Copier lienLien copié sur presse-papiers!
1.7.53.1.3. title Copier lienLien copié sur presse-papiers!
1.7.53.1.4. current_or_subpath? Copier lienLien copié sur presse-papiers!
True if the path of the current page is the same as this one or it’s a 'direct subpath' of it (i.e. extended by ID). For example with {{ urls.outbox }}
these will return true:
- /admin/sent/messages/received
- /admin/sent/messages/received/42
But not these:
- /admin/sent/messsages/new
- /admin/sent/messsages/longer/subpath
See also '#active?', '#current?'.
1.7.53.1.5. current? Copier lienLien copié sur presse-papiers!
True if the URL’s path is the the same as of the current. Parameters and other components are not taken into account. See also '#active?'.
1.7.53.1.6. active? Copier lienLien copié sur presse-papiers!
True if the current page is in the same menu structure as this URL. See also '#current?'.
1.7.54. Urls drop (up) Copier lienLien copié sur presse-papiers!
1.7.54.1. Methods Copier lienLien copié sur presse-papiers!
1.7.54.1.1. provider Copier lienLien copié sur presse-papiers!
1.7.54.1.2. cas_login Copier lienLien copié sur presse-papiers!
<a href="{{ urls.signup }}">signup here</a> <a href="{{ urls.service_subscription }}">subscribe to a service here</a>
<a href="{{ urls.signup }}">signup here</a>
<a href="{{ urls.service_subscription }}">subscribe to a service here</a>
1.7.54.1.3. new_application Copier lienLien copié sur presse-papiers!
1.7.54.1.4. signup Copier lienLien copié sur presse-papiers!
URL of a signup page. Accessible for all.
<a href="{{ urls.signup }}?{{ service_plan | param_filter }}&{{ app_plan | param_filter }}" >Signup Now!</a>
<a href="{{ urls.signup }}?{{ service_plan | param_filter }}&{{ app_plan | param_filter }}" >Signup Now!</a>
1.7.54.1.5. search Copier lienLien copié sur presse-papiers!
URL to which all the search requests should be sent
<form action="{{ urls.search }}" method="get"> </form>
<form action="{{ urls.search }}" method="get">
</form>
1.7.54.1.6. login Copier lienLien copié sur presse-papiers!
1.7.54.1.7. logout Copier lienLien copié sur presse-papiers!
1.7.54.1.8. forgot_password Copier lienLien copié sur presse-papiers!
1.7.54.1.9. service_subscription Copier lienLien copié sur presse-papiers!
URL to a service subscription page. Only for logged in users.
<a href="{{ urls.service_subscription }}?{{ service_plan | param_filter }}" > Subscribe to service {{ service.name }} </a>
<a href="{{ urls.service_subscription }}?{{ service_plan | param_filter }}" >
Subscribe to service {{ service.name }}
</a>
1.7.54.1.10. compose_message Copier lienLien copié sur presse-papiers!
URL to a page that allows the developer contact provider via the internal messaging system.
1.7.54.1.11. messages_outbox Copier lienLien copié sur presse-papiers!
URL to the list of messages sent by a developer.
1.7.54.1.12. messages_trash Copier lienLien copié sur presse-papiers!
1.7.54.1.13. empty_messages_trash Copier lienLien copié sur presse-papiers!
1.7.54.1.14. credit_card_terms Copier lienLien copié sur presse-papiers!
1.7.54.1.15. credit_card_privacy Copier lienLien copié sur presse-papiers!
1.7.54.1.16. credit_card_refunds Copier lienLien copié sur presse-papiers!
1.7.54.1.17. users Copier lienLien copié sur presse-papiers!
1.7.54.1.18. personal_details Copier lienLien copié sur presse-papiers!
URL or Nil if user account management is disabled (check your Usage rules).
1.7.54.1.19. access_details Copier lienLien copié sur presse-papiers!
A page with API key(s) and other authentication info. Differs depending on the authentication strategy.
1.7.54.1.20. payment_details Copier lienLien copié sur presse-papiers!
1.7.54.1.21. new_invitation Copier lienLien copié sur presse-papiers!
Page to invite new users
1.7.54.1.22. invitations Copier lienLien copié sur presse-papiers!
List of all the sent invitations
1.7.54.1.23. dashboard Copier lienLien copié sur presse-papiers!
1.7.54.1.24. applications Copier lienLien copié sur presse-papiers!
1.7.54.1.25. api_access_details Copier lienLien copié sur presse-papiers!
1.7.54.1.26. services Copier lienLien copié sur presse-papiers!
1.7.54.1.27. messages_inbox Copier lienLien copié sur presse-papiers!
URL to the list of received messages.
1.7.54.1.28. stats Copier lienLien copié sur presse-papiers!
1.7.54.1.29. account_overview Copier lienLien copié sur presse-papiers!
1.7.54.1.30. account_plans Copier lienLien copié sur presse-papiers!
1.7.54.1.31. invoices Copier lienLien copié sur presse-papiers!
1.7.55. UsageLimit drop (up) Copier lienLien copié sur presse-papiers!
Example: Using usage limit drop in liquid
You cannot do more than {{ limit.value }} {{ limit.metric.unit }}s per {{ limit.period }}
You cannot do more than {{ limit.value }} {{ limit.metric.unit }}s per {{ limit.period }}
1.7.55.1. Methods Copier lienLien copié sur presse-papiers!
1.7.55.1.1. period Copier lienLien copié sur presse-papiers!
Returns the period of the usage limit
1.7.55.1.2. metric Copier lienLien copié sur presse-papiers!
Usually hits
but can be any custom method.
1.7.55.1.3. value Copier lienLien copié sur presse-papiers!
Returns the value of the usage limit
1.7.56. User drop (up) Copier lienLien copié sur presse-papiers!
<h2>User {{ user.display_name }}</h2> Account {{ user.account.name }} Username {{ user.username }} Email {{ user.email }} Website {{ user.website }}
<h2>User {{ user.display_name }}</h2>
Account {{ user.account.name }}
Username {{ user.username }}
Email {{ user.email }}
Website {{ user.website }}
1.7.56.1. Methods Copier lienLien copié sur presse-papiers!
1.7.56.1.1. errors Copier lienLien copié sur presse-papiers!
If a form of this model is rendered after unsuccesfull submit, this returns" errors that occured.
{{ user.errors.name | inline_errors }}
{{ user.errors.name | inline_errors }}
1.7.56.1.2. admin? Copier lienLien copié sur presse-papiers!
Returns whether the user is an admin.
{% if user.admin? %} <p>You are an admin of your account.</p> {% endif %}
{% if user.admin? %}
<p>You are an admin of your account.</p>
{% endif %}
1.7.56.1.3. username Copier lienLien copié sur presse-papiers!
Returns the username of the user, html escaped.
1.7.56.1.4. account Copier lienLien copié sur presse-papiers!
Returns the account of the user.
1.7.56.1.5. name Copier lienLien copié sur presse-papiers!
Returns the first and surname of the user.
1.7.56.1.6. email Copier lienLien copié sur presse-papiers!
Returns the email of the user.
1.7.56.1.7. password_required? Copier lienLien copié sur presse-papiers!
This method will return true
for users using the builtin Developer Portal authentication mechanisms and false
for those that are authenticated via Janrain, CAS or other single-sign-on method.
{% if user.password_required? %} {% endif %}
{% if user.password_required? %}
{% endif %}
1.7.56.1.8. sections Copier lienLien copié sur presse-papiers!
Returns the list of sections the user has access to.
1.7.56.1.9. role Copier lienLien copié sur presse-papiers!
Returns the role of the user
1.7.56.1.10. roles_collection Copier lienLien copié sur presse-papiers!
Retuns a list of available roles for the user
1.7.56.1.11. url Copier lienLien copié sur presse-papiers!
Return the resource url of the user
{{ 'Delete' | delete_button: user.url }}
{{ 'Delete' | delete_button: user.url }}
1.7.56.1.12. edit_url Copier lienLien copié sur presse-papiers!
Return the url to edit the user
{{ 'Edit' | link_to: user.edit_url, title: 'Edit', class: 'action edit' }}
{{ 'Edit' | link_to: user.edit_url, title: 'Edit', class: 'action edit' }}
1.7.56.1.13. can Copier lienLien copié sur presse-papiers!
Give access to permission methods
{% if user.can.be_managed? %} <!-- do something --> {% endif %}
{% if user.can.be_managed? %}
<!-- do something -->
{% endif %}
1.7.56.1.14. extra_fields Copier lienLien copié sur presse-papiers!
Returns non-hidden extra fields with values for this user Example: Print all extra fields
{% for field in user.extra_fields %} {{ field.label }}: {{ field.value }} {% endfor %}
{% for field in user.extra_fields %}
{{ field.label }}: {{ field.value }}
{% endfor %}
1.7.56.1.15. fields Copier lienLien copié sur presse-papiers!
Returns all fields with values for this user Example: Print all fields
{% for field in user.fields %} {{ field.label }}: {{ field.value }} {% endfor %}
{% for field in user.fields %}
{{ field.label }}: {{ field.value }}
{% endfor %}
1.7.56.1.16. builtin_fields Copier lienLien copié sur presse-papiers!
Returns all builtin fields with values for this user
1.8. Tags (up) Copier lienLien copié sur presse-papiers!
1.8.1. Tag 'braintree_customer_form' (up) Copier lienLien copié sur presse-papiers!
Renders a form to enter data required for Braintree Blue payment gateway
1.8.2. Tag 'csrf' (up) Copier lienLien copié sur presse-papiers!
Renders the cross site request forgery meta tags.
Example: Using csrf tag in liquid
<head> {% csrf %} </head>
<head>
{% csrf %}
</head>
1.8.3. Tag 'content' (up) Copier lienLien copié sur presse-papiers!
Renders body of a page. Use this only inside a layout.
1.8.4. Tag 'content_for' (up) Copier lienLien copié sur presse-papiers!
1.8.5. Tag 'debug' (up) Copier lienLien copié sur presse-papiers!
Prints all liquid variables available in a template into an HTML comment.' We recommend to remove this tag from public templates.
``{% debug:help %}``
``{% debug:help %}``
1.8.6. Tag 'email' (up) Copier lienLien copié sur presse-papiers!
The email
tag allows you to customize headers of your outgoing emails and is available only inside the email templates.
There are several convenience subtags such as cc
or subject
(see the table below) that simplify the job but you can also use a header
subtag to set an arbitrary SMTP header for the message.
Subtag | Description | Example |
subject | dynamic subject | {% subject = 'Greetings from Example company!' %} |
cc | carbon copy | {% cc = 'boss@example.com' %} |
bcc | blind carbon copy | {% bcc = 'all@example.com' %} |
from | the actual sender | {% from = 'system@example.com' %} |
reply-to | {% reply-to = 'support@example.com' %} | |
header | custom SMTP header | {% header 'X-SMTP-Group' = 'Important' %} |
do_not_send | discard the email | {% do_not_send %} |
Example: Conditional blind carbon copy
{% email %} {% if plan.system_name == 'enterprise' %} {% bcc 'marketing@world-domination.org' %} {% endif%} {% endemail %}
{% email %}
{% if plan.system_name == 'enterprise' %}
{% bcc 'marketing@world-domination.org' %}
{% endif%}
{% endemail %}
Example: Disabling emails at all
{% email %} {% do_not_send %} {% endemail %}
{% email %}
{% do_not_send %}
{% endemail %}
Example: Signup email filter
1.8.7. Tag 'flash' (up) Copier lienLien copié sur presse-papiers!
Renders informational or error messages of the system.
DEPRECATED: This tag is deprecated, use FlashDrop instead.
Example: Using flash tag in liquid
{% flash %}
{% flash %}
1.8.9. Tag 'form' (up) Copier lienLien copié sur presse-papiers!
Renders a form tag with an action and class attribute specified, depending on the name of the form. The supported forms are:
Form | Allowed Field Names | Spam Protection | Notes |
application.create |
| No | |
application.update |
| No | |
signup |
| Yes |
Sign Up directly to plans of your choice by adding one one or more hidden fields with a name |
Example: A form to create an application
1.8.10. Tag 'latest_forum_posts' (up) Copier lienLien copié sur presse-papiers!
An HTML table with latest forum posts.
DEPRECATED: Use forum
drop instead.
Example: Using latest_forum_posts tag liquid
{% latest_forum_posts %}
{% latest_forum_posts %}
1.8.11. Tag 'latest_messages' (up) Copier lienLien copié sur presse-papiers!
Renders a html snippet with the latest messages for the user.
Example: Using latest_messages tag liquid
{% latest_messages %}
{% latest_messages %}
1.8.12. Tag 'logo' (up) Copier lienLien copié sur presse-papiers!
Renders the logo.
DEPRECATED: This tag is deprecated, use {{ provider.logo_url }} instead.
Example: Using menu tag in liquid
{% logo %}
{% logo %}
1.8.15. Tag 'plan_widget' (up) Copier lienLien copié sur presse-papiers!
Includes a widget to review or change application plan
1.8.16. Tag 'portlet' (up) Copier lienLien copié sur presse-papiers!
This tag includes portlet by system name.
1.8.18. Tag '3scale_essentials' (up) Copier lienLien copié sur presse-papiers!
1.8.19. Tag 'user_widget' (up) Copier lienLien copié sur presse-papiers!
Renders a user widget html snippet.
DEPRECATED: This tag is deprecated, use a CMS partial instead
Example: Using user_widget tag in liquid
{% user_widget %} <p class="notice">If you are logged in you see profile related links above.</p> <p class="notice">If you are not login you are invited to login or signup.</p>
{% user_widget %}
<p class="notice">If you are logged in you see profile related links above.</p>
<p class="notice">If you are not login you are invited to login or signup.</p>
1.9. Filters (up) Copier lienLien copié sur presse-papiers!
1.9.1. FormHelpers filters (up) Copier lienLien copié sur presse-papiers!
1.9.1.1. error_class filter Copier lienLien copié sur presse-papiers!
Outputs error class if argument is not empty Example: Using error_class to show output an error class
1.9.1.2. inline_errors filter Copier lienLien copié sur presse-papiers!
Outputs error fields inline in paragraph Example: Using inline_errors to show errors inline
{{ form.errors.description | inline_errors }}
{{ form.errors.description | inline_errors }}
1.9.2. ParamFilter filters (up) Copier lienLien copié sur presse-papiers!
1.9.2.1. to_param filter Copier lienLien copié sur presse-papiers!
Converts a supplied drop to URL parameter if possible. Example: Using to_param filter in liquid
<h2>Signup to a service</h2> <a href="{{ urls.signup }}?{{ service | to_param }}">Signup to {{ service.name }}</a>
<h2>Signup to a service</h2>
<a href="{{ urls.signup }}?{{ service | to_param }}">Signup to {{ service.name }}</a>
1.9.3. Common filters (up) Copier lienLien copié sur presse-papiers!
1.9.3.1. group_by filter Copier lienLien copié sur presse-papiers!
Group collection by some key Example: Group applications by service
1.9.3.2. any filter Copier lienLien copié sur presse-papiers!
True if any string in the collection equals to the parameter Example: Are there any pending apps of the current account?
{% assign has_pending_apps = current_account.applications | map: 'state' | any: 'live' %}
{% assign has_pending_apps = current_account.applications | map: 'state' | any: 'live' %}
1.9.3.3. stylesheet_link_tag filter Copier lienLien copié sur presse-papiers!
Stylesheet link
1.9.3.4. javascript_include_tag filter Copier lienLien copié sur presse-papiers!
Javascript include tag
1.9.3.5. image_tag filter Copier lienLien copié sur presse-papiers!
Outputs an tag using the parameters as its src
attribute.
{{ 'http://example.com/cool.gif' | image_tag }} ## =>
{{ 'http://example.com/cool.gif' | image_tag }}
## =>
1.9.3.6. mail_to filter Copier lienLien copié sur presse-papiers!
Converts email address to a 'mailto' link.
{{ 'me@there.is' | mail_to }} ## => <a href="mailto:me@there.is">me@there.is</a>
{{ 'me@there.is' | mail_to }}
## => <a href="mailto:me@there.is">me@there.is</a>
1.9.3.7. html_safe filter Copier lienLien copié sur presse-papiers!
Marks content as HTML safe so that it is not escaped.
1.9.3.8. pluralize filter Copier lienLien copié sur presse-papiers!
Convert word to plural form
1.9.3.9. delete_button filter Copier lienLien copié sur presse-papiers!
Generates a button to delete a resource present on the URL. First parameter is a URL, second is a title. You can also add more HTML tag attributes as a third parameter.
{{ 'Delete Message' | delete_button: message.url, class: 'my-button' }}
{{ 'Delete Message' | delete_button: message.url, class: 'my-button' }}
1.9.3.10. delete_button_ajax filter Copier lienLien copié sur presse-papiers!
Generates a button to delete a resource present on the URL using AJAX. First parameter is a URL, second is a title.
{{ 'Delete Message' | delete_button_ajax: message.url }}
{{ 'Delete Message' | delete_button_ajax: message.url }}
1.9.3.11. update_button filter Copier lienLien copié sur presse-papiers!
Generates a button to 'update' (HTTP PUT request) a resource present on the URL. First parameter is a URL, second is a title. You can also add more HTML tag attributes as a third parameter.
{{ 'Resend' | update_button: message.url, class: 'my-button' }}
{{ 'Resend' | update_button: message.url, class: 'my-button' }}
1.9.3.12. create_button filter Copier lienLien copié sur presse-papiers!
Generates a button to create a resource present on the URL. First parameter is a URL, second is a title.
{{ 'Create Message' | create_button: message.url }}
{{ 'Create Message' | create_button: message.url }}
1.9.3.13. create_button_ajax filter Copier lienLien copié sur presse-papiers!
1.9.3.14. regenerate_oauth_secret_button filter Copier lienLien copié sur presse-papiers!
1.9.3.15. link_to filter Copier lienLien copié sur presse-papiers!
Create link from given text
{{ "See your App keys" | link_to:'/my-app-keys' }}
{{ "See your App keys" | link_to:'/my-app-keys' }}