Dieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.
Chapter 7. Liquid Reference
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.
7.1. Drops Link kopierenLink in die Zwischenablage kopiert!
- 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
7.2. Tags Link kopierenLink in die Zwischenablage kopiert!
- 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'
7.3. Filters Link kopierenLink in die Zwischenablage kopiert!
7.4. Drops (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.1. Account drop (up) Link kopierenLink in die Zwischenablage kopiert!
A developer account. See User
drop if you are looking for the email addresses or similar information.
7.4.1.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.1.1.2. id Link kopierenLink in die Zwischenablage kopiert!
Returns the id of the account
7.4.1.1.3. name Link kopierenLink in die Zwischenablage kopiert!
Returns the organization name of the developer’s account
7.4.1.1.4. vat_zero_text Link kopierenLink in die Zwischenablage kopiert!
Return a text about a vat zero
7.4.1.1.5. vat_rate Link kopierenLink in die Zwischenablage kopiert!
Return the vat rate
7.4.1.1.6. unread_messages Link kopierenLink in die Zwischenablage kopiert!
Unread messages
7.4.1.1.7. latest_messages Link kopierenLink in die Zwischenablage kopiert!
Return the latest messages
7.4.1.1.8. bought_account_plan Link kopierenLink in die Zwischenablage kopiert!
Returns the plan the account has contracted
7.4.1.1.9. bought_account_contract Link kopierenLink in die Zwischenablage kopiert!
Returns the contract account
7.4.1.1.10. credit_card_display_number Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.11. credit_card_expiration_date Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.12. credit_card_required? Link kopierenLink in die Zwischenablage kopiert!
Returns whether the account is required to enter credit card details
7.4.1.1.13. credit_card_stored? Link kopierenLink in die Zwischenablage kopiert!
Returns whether the account has credit card details stored
7.4.1.1.14. credit_card_missing? Link kopierenLink in die Zwischenablage kopiert!
Returns whether the account has no credit card details stored
7.4.1.1.15. timezone Link kopierenLink in die Zwischenablage kopiert!
Returns timezone of this account
7.4.1.1.16. paid? Link kopierenLink in die Zwischenablage kopiert!
Returns whether the account has at least a paid contract
7.4.1.1.17. on_trial? Link kopierenLink in die Zwischenablage kopiert!
Returns whether the account is on trial period, i.e. all his paid contracts has to be in trial period
7.4.1.1.18. telephone_number Link kopierenLink in die Zwischenablage kopiert!
Returns the telephone number of the account
7.4.1.1.19. approval_required? Link kopierenLink in die Zwischenablage kopiert!
Returns whether the account requires approval?
7.4.1.1.20. created_at Link kopierenLink in die Zwischenablage kopiert!
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>
7.4.1.1.21. full_address Link kopierenLink in die Zwischenablage kopiert!
Can be composed by legal address, city and state
7.4.1.1.22. applications Link kopierenLink in die Zwischenablage kopiert!
Returns the applications of the account
7.4.1.1.23. subscribed_services Link kopierenLink in die Zwischenablage kopiert!
Returns a array with ServiceContract drops
7.4.1.1.24. admin Link kopierenLink in die Zwischenablage kopiert!
Returns the admin user of this account
7.4.1.1.25. extra_fields_plain_text Link kopierenLink in die Zwischenablage kopiert!
Returns the extra fields defined for the account as plain text
7.4.1.1.26. fields_plain_text Link kopierenLink in die Zwischenablage kopiert!
Returns the fields defined for the account as plain text
7.4.1.1.27. extra_fields Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.1.1.28. fields Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.1.1.29. builtin_fields Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.30. multiple_applications_allowed? Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.31. billing_address Link kopierenLink in die Zwischenablage kopiert!
Returns the billing address of this account
7.4.1.1.32. has_billing_address? Link kopierenLink in die Zwischenablage kopiert!
Returns whether this account has a billing address or not
7.4.1.1.33. can Link kopierenLink in die Zwischenablage kopiert!
Give access to permission methods
{% if account.can.be_deleted? %} <!-- do something --> {% endif %}
{% if account.can.be_deleted? %}
<!-- do something -->
{% endif %}
7.4.1.1.34. edit_url Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.35. edit_ogone_billing_address_url Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.36. edit_payment_express_billing_address_url Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.37. edit_braintree_blue_credit_card_details_url Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.38. domain Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.39. upgraded? Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.40. requires_credit_card? Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.41. support_email Link kopierenLink in die Zwischenablage kopiert!
7.4.1.1.42. finance_support_email Link kopierenLink in die Zwischenablage kopiert!
7.4.2. AccountPlan drop (up) Link kopierenLink in die Zwischenablage kopiert!
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>
7.4.2.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.2.1.1. selected? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.2.1.2. bought? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.2.1.3. features Link kopierenLink in die Zwischenablage kopiert!
Returns an array of available features
7.4.2.1.4. setup_fee Link kopierenLink in die Zwischenablage kopiert!
Returns the setup fee
7.4.2.1.5. name Link kopierenLink in die Zwischenablage kopiert!
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>
7.4.2.1.6. system_name Link kopierenLink in die Zwischenablage kopiert!
Returns the system name of the plan
7.4.2.1.7. id Link kopierenLink in die Zwischenablage kopiert!
Returns the plan id
7.4.2.1.8. free? Link kopierenLink in die Zwischenablage kopiert!
The plan is free if it is not 'paid' (see the 'paid?' method)
7.4.2.1.9. paid? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.2.1.10. approval_required? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.2.1.11. flat_cost Link kopierenLink in die Zwischenablage kopiert!
Returns the monthly fixed fee of the plan
7.4.3. Alert drop (up) Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.3.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.3.1.1. level Link kopierenLink in die Zwischenablage kopiert!
The alert level can be one of 50, 80, 90, 100, 120, 150, 200, 300.
7.4.3.1.2. message Link kopierenLink in die Zwischenablage kopiert!
Text message describing the alert, for example 'hits per minute: 5 of 5'
7.4.3.1.3. utilization Link kopierenLink in die Zwischenablage kopiert!
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.
7.4.4. Application drop (up) Link kopierenLink in die Zwischenablage kopiert!
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>
7.4.4.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.4.1.2. id Link kopierenLink in die Zwischenablage kopiert!
Returns the id of the application
7.4.4.1.3. can_change_plan? Link kopierenLink in die Zwischenablage kopiert!
Returns 'true' if changing of the application is allowed either directly or by request.
7.4.4.1.4. trial? Link kopierenLink in die Zwischenablage kopiert!
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.
7.4.4.1.5. live? Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.6. state Link kopierenLink in die Zwischenablage kopiert!
There are three possible states:
- pending - live - suspended
- pending
- live
- suspended
7.4.4.1.7. remaining_trial_period_days Link kopierenLink in die Zwischenablage kopiert!
Number of day still left in the trial period.
7.4.4.1.8. plan Link kopierenLink in die Zwischenablage kopiert!
Returns a plan drop with the plan of the application
7.4.4.1.9. plan_change_permission_name Link kopierenLink in die Zwischenablage kopiert!
Returns name of the allowed action
7.4.4.1.10. plan_change_permission_warning Link kopierenLink in die Zwischenablage kopiert!
Returns a warning messenger of the allowed action
7.4.4.1.11. contract Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.12. admin_url Link kopierenLink in die Zwischenablage kopiert!
Returns the admin_url of the application
7.4.4.1.13. name Link kopierenLink in die Zwischenablage kopiert!
Returns the name of the application
7.4.4.1.14. can Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.15. oauth Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.16. pending? Link kopierenLink in die Zwischenablage kopiert!
Returns 'true' if application state is pending
7.4.4.1.17. buyer_alerts_enabled? Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.18. description Link kopierenLink in die Zwischenablage kopiert!
Returns the description of the application
7.4.4.1.19. redirect_url Link kopierenLink in die Zwischenablage kopiert!
Returns the redirect url for the OAuth of the application
7.4.4.1.20. filters_limit Link kopierenLink in die Zwischenablage kopiert!
Returns the amount of referrer filters allowed for this application
7.4.4.1.21. keys_limit Link kopierenLink in die Zwischenablage kopiert!
Returns the amount of application keys allowed for this application
7.4.4.1.22. referrer_filters Link kopierenLink in die Zwischenablage kopiert!
Returns the referrer filters associated with this application
7.4.4.1.23. rejection_reason Link kopierenLink in die Zwischenablage kopiert!
Returns the reason for rejecting an application
7.4.4.1.24. user_key Link kopierenLink in die Zwischenablage kopiert!
Returns the user_key of application
7.4.4.1.25. application_id Link kopierenLink in die Zwischenablage kopiert!
Returns the application_id of an application
7.4.4.1.26. key Link kopierenLink in die Zwischenablage kopiert!
Returns the application id or the user key
7.4.4.1.27. url Link kopierenLink in die Zwischenablage kopiert!
Returns URL of the builtin detail view for this application.
7.4.4.1.28. edit_url Link kopierenLink in die Zwischenablage kopiert!
Returns URL of the builtin edit view for this application.
7.4.4.1.29. update_user_key_url Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.30. log_requests_url Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.31. alerts_url Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.32. application_keys_url Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.33. service Link kopierenLink in die Zwischenablage kopiert!
Service to which that application belongs to.
7.4.4.1.34. keys Link kopierenLink in die Zwischenablage kopiert!
Returns the keys of an application
7.4.4.1.35. oauth_mode? Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.36. user_key_mode? Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.37. app_id_mode? Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.38. change_plan_url Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.39. log_requests? Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.40. application_keys Link kopierenLink in die Zwischenablage kopiert!
7.4.4.1.41. extra_fields Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.4.1.42. fields Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.4.1.43. builtin_fields Link kopierenLink in die Zwischenablage kopiert!
Returns only builtin fields of the application
7.4.4.1.44. cinstance Link kopierenLink in die Zwischenablage kopiert!
7.4.5. ApplicationKey drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.5.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.5.1.1. id Link kopierenLink in die Zwischenablage kopiert!
7.4.5.1.2. value Link kopierenLink in die Zwischenablage kopiert!
7.4.5.1.3. url Link kopierenLink in die Zwischenablage kopiert!
7.4.5.1.4. application Link kopierenLink in die Zwischenablage kopiert!
7.4.6. ApplicationPlan drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.6.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.6.1.1. selected? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.6.1.2. bought? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.6.1.3. features Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.6.1.4. setup_fee Link kopierenLink in die Zwischenablage kopiert!
Returns the setup fee of the plan
7.4.6.1.5. name Link kopierenLink in die Zwischenablage kopiert!
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>
7.4.6.1.6. system_name Link kopierenLink in die Zwischenablage kopiert!
Returns the system name of the plan
7.4.6.1.7. id Link kopierenLink in die Zwischenablage kopiert!
Returns the plan id
7.4.6.1.8. free? Link kopierenLink in die Zwischenablage kopiert!
The plan is free if it is not 'paid' (see the 'paid?' method)
7.4.6.1.9. paid? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.6.1.10. approval_required? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.6.1.11. flat_cost Link kopierenLink in die Zwischenablage kopiert!
Returns the monthly fixed fee of the plan
7.4.6.1.12. metrics Link kopierenLink in die Zwischenablage kopiert!
Returns the metrics of the plan
7.4.6.1.13. usage_limits Link kopierenLink in die Zwischenablage kopiert!
Returns the usage limits of the plan
7.4.6.1.14. service Link kopierenLink in die Zwischenablage kopiert!
Returns the service of the plan
7.4.7. Base drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.7.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.7.1.1. login_url Link kopierenLink in die Zwischenablage kopiert!
7.4.7.1.2. user_identified? Link kopierenLink in die Zwischenablage kopiert!
7.4.8. Base drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.8.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.8.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.8.1.2. title Link kopierenLink in die Zwischenablage kopiert!
Returns the title result
7.4.8.1.3. kind Link kopierenLink in die Zwischenablage kopiert!
Returns the kind of result, can be 'topic' or 'page'
7.4.8.1.4. url Link kopierenLink in die Zwischenablage kopiert!
Returns the resource url of the result
7.4.8.1.5. description Link kopierenLink in die Zwischenablage kopiert!
Returns a descriptive string for the result
7.4.9. BillingAddressField drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1.1. input_name Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1.2. label Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1.3. choices Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1.4. errors Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1.5. html_id Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1.7. visible? Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1.8. read_only? Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1.9. name Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1.10. value Link kopierenLink in die Zwischenablage kopiert!
7.4.9.1.11. required Link kopierenLink in die Zwischenablage kopiert!
7.4.10. Can drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.10.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.10.1.1. be_updated? Link kopierenLink in die Zwischenablage kopiert!
7.4.10.1.2. add_referrer_filters? Link kopierenLink in die Zwischenablage kopiert!
7.4.10.1.3. add_application_keys? Link kopierenLink in die Zwischenablage kopiert!
7.4.10.1.4. regenerate_user_key? Link kopierenLink in die Zwischenablage kopiert!
7.4.10.1.5. regenerate_oauth_secret? Link kopierenLink in die Zwischenablage kopiert!
7.4.10.1.6. manage_keys? Link kopierenLink in die Zwischenablage kopiert!
7.4.10.1.7. delete_key? Link kopierenLink in die Zwischenablage kopiert!
7.4.11. Can drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.11.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.11.1.1. change_plan? Link kopierenLink in die Zwischenablage kopiert!
7.4.12. Cas drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.12.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.12.1.1. login_url Link kopierenLink in die Zwischenablage kopiert!
7.4.12.1.2. user_identified? Link kopierenLink in die Zwischenablage kopiert!
7.4.13. Contract drop (up) Link kopierenLink in die Zwischenablage kopiert!
Plan of the contract {{ contract.plan.name }}
Plan of the contract {{ contract.plan.name }}
7.4.13.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.13.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.13.1.2. id Link kopierenLink in die Zwischenablage kopiert!
Returns the id
7.4.13.1.3. can_change_plan? Link kopierenLink in die Zwischenablage kopiert!
Returns true if any form of change is possible
7.4.13.1.4. trial? Link kopierenLink in die Zwischenablage kopiert!
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.
7.4.13.1.5. live? Link kopierenLink in die Zwischenablage kopiert!
7.4.13.1.6. state Link kopierenLink in die Zwischenablage kopiert!
There are three possible states:
- pending - live - suspended
- pending
- live
- suspended
7.4.13.1.7. remaining_trial_period_days Link kopierenLink in die Zwischenablage kopiert!
Number of day still left in the trial period.
7.4.13.1.8. plan Link kopierenLink in die Zwischenablage kopiert!
Returns the plan of the contract
7.4.13.1.9. plan_change_permission_name Link kopierenLink in die Zwischenablage kopiert!
Returns name of the allowed action
7.4.13.1.10. plan_change_permission_warning Link kopierenLink in die Zwischenablage kopiert!
Returns a warning messenger of the allowed action
7.4.13.1.11. contract Link kopierenLink in die Zwischenablage kopiert!
7.4.14. Country drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.14.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.14.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.14.1.2. to_str Link kopierenLink in die Zwischenablage kopiert!
7.4.14.1.3. code Link kopierenLink in die Zwischenablage kopiert!
7.4.14.1.4. label Link kopierenLink in die Zwischenablage kopiert!
7.4.15. CountryField drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.15.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.15.1.1. value Link kopierenLink in die Zwischenablage kopiert!
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'
7.4.15.1.2. name Link kopierenLink in die Zwischenablage kopiert!
Returns system name of the field
7.4.15.1.3. required Link kopierenLink in die Zwischenablage kopiert!
7.4.15.1.6. visible? Link kopierenLink in die Zwischenablage kopiert!
7.4.15.1.7. visible Link kopierenLink in die Zwischenablage kopiert!
7.4.15.1.8. read_only Link kopierenLink in die Zwischenablage kopiert!
7.4.15.1.9. errors Link kopierenLink in die Zwischenablage kopiert!
7.4.15.1.10. input_name Link kopierenLink in die Zwischenablage kopiert!
7.4.15.1.11. html_id Link kopierenLink in die Zwischenablage kopiert!
7.4.15.1.12. label Link kopierenLink in die Zwischenablage kopiert!
Returns label of the field
{{ account.fields.country.label }} <!-- => 'Country' -->
{{ account.fields.country.label }}
<!-- => 'Country' -->
7.4.15.1.13. to_str Link kopierenLink in die Zwischenablage kopiert!
Returns name of the country
{{ account.fields.country }} => 'United States'
{{ account.fields.country }} => 'United States'
7.4.15.1.14. choices Link kopierenLink in die Zwischenablage kopiert!
7.4.16. CurrentUser drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.16.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.16.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.16.1.2. admin? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.16.1.3. username Link kopierenLink in die Zwischenablage kopiert!
Returns the username of the user, html escaped.
7.4.16.1.4. account Link kopierenLink in die Zwischenablage kopiert!
Returns the account of the user.
7.4.16.1.5. name Link kopierenLink in die Zwischenablage kopiert!
Returns the first and surname of the user.
7.4.16.1.6. email Link kopierenLink in die Zwischenablage kopiert!
Returns the email of the user.
7.4.16.1.7. password_required? Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.16.1.8. sections Link kopierenLink in die Zwischenablage kopiert!
Returns the list of sections the user has access to.
7.4.16.1.9. role Link kopierenLink in die Zwischenablage kopiert!
Returns the role of the user
7.4.16.1.10. roles_collection Link kopierenLink in die Zwischenablage kopiert!
Retuns a list of available roles for the user
7.4.16.1.11. url Link kopierenLink in die Zwischenablage kopiert!
Return the resource url of the user
{{ 'Delete' | delete_button: user.url }}
{{ 'Delete' | delete_button: user.url }}
7.4.16.1.12. edit_url Link kopierenLink in die Zwischenablage kopiert!
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' }}
7.4.16.1.13. can Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.16.1.14. extra_fields Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.16.1.15. fields Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.16.1.16. builtin_fields Link kopierenLink in die Zwischenablage kopiert!
Returns all builtin fields with values for this user
7.4.17. Error drop (up) Link kopierenLink in die Zwischenablage kopiert!
When a form fails to submit because of invalid data, the errors
array will be available on the related model.
7.4.17.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.17.1.1. attribute Link kopierenLink in die Zwischenablage kopiert!
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 -->
7.4.17.1.2. message Link kopierenLink in die Zwischenablage kopiert!
Returns description of the error
{{ account.errors.first.message }} <!-- can't be blank -->
{{ account.errors.first.message }}
<!-- can't be blank -->
7.4.17.1.3. value Link kopierenLink in die Zwischenablage kopiert!
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." -->
7.4.17.1.4. to_str Link kopierenLink in die Zwischenablage kopiert!
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" -->
7.4.18. Errors drop (up) Link kopierenLink in die Zwischenablage kopiert!
Example: get all errors
{% for error in form.errors %} attribute: {{ error.attribute }} ... {% endfor %}
{% for error in form.errors %}
attribute: {{ error.attribute }}
...
{% endfor %}
7.4.18.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.18.1.1. empty? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.18.1.2. present? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.19. Feature drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.19.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.19.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.19.1.2. name Link kopierenLink in die Zwischenablage kopiert!
Returns the name of the feature
<h2>Feature {{ feature.name }}</h2>
<h2>Feature {{ feature.name }}</h2>
7.4.19.1.3. description Link kopierenLink in die Zwischenablage kopiert!
Returns the description of the feature
7.4.19.1.4. has_description? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.20. Field drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.20.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.20.1.1. value Link kopierenLink in die Zwischenablage kopiert!
Returns value if the field
Name: {{ account.fields.first_name.value }}
Name: {{ account.fields.first_name.value }}
7.4.20.1.2. name Link kopierenLink in die Zwischenablage kopiert!
Returns system name of the field
7.4.20.1.3. required Link kopierenLink in die Zwischenablage kopiert!
7.4.20.1.6. visible? Link kopierenLink in die Zwischenablage kopiert!
7.4.20.1.7. visible Link kopierenLink in die Zwischenablage kopiert!
7.4.20.1.8. read_only Link kopierenLink in die Zwischenablage kopiert!
7.4.20.1.9. errors Link kopierenLink in die Zwischenablage kopiert!
7.4.20.1.10. input_name Link kopierenLink in die Zwischenablage kopiert!
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]' -->
7.4.20.1.11. html_id Link kopierenLink in die Zwischenablage kopiert!
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' -->
7.4.20.1.12. label Link kopierenLink in die Zwischenablage kopiert!
Returns label of the field
{{ account.fields.country.label }} <!-- => 'Country' -->
{{ account.fields.country.label }}
<!-- => 'Country' -->
7.4.20.1.13. to_str Link kopierenLink in die Zwischenablage kopiert!
Returns value of the field if used as variable
{{ account.fields.first_name }} => 'Tom'
{{ account.fields.first_name }} => 'Tom'
7.4.20.1.14. choices Link kopierenLink in die Zwischenablage kopiert!
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.
7.4.21. Flash drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.21.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.21.1.1. messages Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.22. Forum drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.22.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.22.1.1. enabled? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.22.1.2. latest_posts Link kopierenLink in die Zwischenablage kopiert!
7.4.23. I18n drop (up) Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.23.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.23.1.1. short_date Link kopierenLink in die Zwischenablage kopiert!
Alias for %b %d
Dec 11
Dec 11
7.4.23.1.2. long_date Link kopierenLink in die Zwischenablage kopiert!
Alias for %B %d, %Y
December 11, 2013
December 11, 2013
7.4.23.1.3. default_date Link kopierenLink in die Zwischenablage kopiert!
Alias for %Y-%m-%d
2013-12-11
2013-12-11
7.4.24. Invitation drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.24.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.24.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.24.1.2. email Link kopierenLink in die Zwischenablage kopiert!
Returns email address
7.4.24.1.3. accepted? Link kopierenLink in die Zwischenablage kopiert!
Returns true if the invitation was accepted
7.4.24.1.4. accepted_at Link kopierenLink in die Zwischenablage kopiert!
Returns a date if the invitations was accepted
{{ invitation.accepted_at | date: i18n.short_date }}
{{ invitation.accepted_at | date: i18n.short_date }}
7.4.24.1.5. sent_at Link kopierenLink in die Zwischenablage kopiert!
Returns the creation date
{{ invitation.sent_at | date: i18n.short_date }}
{{ invitation.sent_at | date: i18n.short_date }}
7.4.24.1.6. resend_url Link kopierenLink in die Zwischenablage kopiert!
Returns the url for resend the invitation
{{ "Resend" | update_button: invitation.resend_url}}
{{ "Resend" | update_button: invitation.resend_url}}
7.4.24.1.7. url Link kopierenLink in die Zwischenablage kopiert!
Returns the resource url
{{ "Delete" | delete_button: invitation.url }}
{{ "Delete" | delete_button: invitation.url }}
7.4.25. Invoice drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.25.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.25.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.25.1.2. friendly_id Link kopierenLink in die Zwischenablage kopiert!
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>
7.4.25.1.3. name Link kopierenLink in die Zwischenablage kopiert!
String composed by month and year
7.4.25.1.4. state Link kopierenLink in die Zwischenablage kopiert!
7.4.25.1.5. cost Link kopierenLink in die Zwischenablage kopiert!
Returns a number with two decimals
23.00
23.00
7.4.25.1.6. currency Link kopierenLink in die Zwischenablage kopiert!
7.4.25.1.7. cost_without_vat Link kopierenLink in die Zwischenablage kopiert!
Returns cost withot VAT
7.4.25.1.8. vat_amount Link kopierenLink in die Zwischenablage kopiert!
Returns vat ammount
7.4.25.1.9. exists_pdf? Link kopierenLink in die Zwischenablage kopiert!
Return true if the pdf was generated
7.4.25.1.10. period_begin Link kopierenLink in die Zwischenablage kopiert!
{{ invoice.period_begin | date: i18n.short_date }}
{{ invoice.period_begin | date: i18n.short_date }}
7.4.25.1.11. period_end Link kopierenLink in die Zwischenablage kopiert!
{{ invoice.period_end | date: i18n.long_date }}
{{ invoice.period_end | date: i18n.long_date }}
7.4.25.1.12. issued_on Link kopierenLink in die Zwischenablage kopiert!
{{ invoice.issued_on | date: i18n.long_date }}
{{ invoice.issued_on | date: i18n.long_date }}
7.4.25.1.13. due_on Link kopierenLink in die Zwischenablage kopiert!
{{ invoice.due_on | date: i18n.long_date }}
{{ invoice.due_on | date: i18n.long_date }}
7.4.25.1.14. paid_on Link kopierenLink in die Zwischenablage kopiert!
{{ invoice.paid_on | date: i18n.long_date }}
{{ invoice.paid_on | date: i18n.long_date }}
7.4.25.1.15. vat_code Link kopierenLink in die Zwischenablage kopiert!
7.4.25.1.16. fiscal_code Link kopierenLink in die Zwischenablage kopiert!
7.4.25.1.17. account Link kopierenLink in die Zwischenablage kopiert!
Return a AccountDrop
7.4.25.1.18. buyer_account Link kopierenLink in die Zwischenablage kopiert!
7.4.25.1.19. line_items Link kopierenLink in die Zwischenablage kopiert!
Returns a array of LineItemDrop
7.4.25.1.20. payment_transactions Link kopierenLink in die Zwischenablage kopiert!
Returns a array of PaymentTransactionDrop
7.4.25.1.21. url Link kopierenLink in die Zwischenablage kopiert!
Return the resource url of the invoice
{{ "Show" | link_to: invoice.url }}
{{ "Show" | link_to: invoice.url }}
7.4.25.1.22. pdf_url Link kopierenLink in die Zwischenablage kopiert!
Return the resource url of the invoice pdf
{{ "PDF" | link_to: invoice.pdf_url }}
{{ "PDF" | link_to: invoice.pdf_url }}
7.4.26. Janrain drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.26.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.26.1.1. login_url Link kopierenLink in die Zwischenablage kopiert!
7.4.26.1.2. user_identified? Link kopierenLink in die Zwischenablage kopiert!
7.4.26.1.3. session_url Link kopierenLink in die Zwischenablage kopiert!
7.4.26.1.4. relying_party Link kopierenLink in die Zwischenablage kopiert!
7.4.27. LineItem drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.27.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.27.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.27.1.2. name Link kopierenLink in die Zwischenablage kopiert!
7.4.27.1.3. description Link kopierenLink in die Zwischenablage kopiert!
7.4.27.1.4. quantity Link kopierenLink in die Zwischenablage kopiert!
7.4.27.1.5. cost Link kopierenLink in die Zwischenablage kopiert!
7.4.28. Message drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.28.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.28.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.28.1.2. id Link kopierenLink in die Zwischenablage kopiert!
Returns the id of the message
7.4.28.1.3. subject Link kopierenLink in die Zwischenablage kopiert!
If subject is not present then either a truncated body or (no subject)
string is returned.
7.4.28.1.4. body Link kopierenLink in die Zwischenablage kopiert!
Body of the message
7.4.28.1.5. created_at Link kopierenLink in die Zwischenablage kopiert!
Returns the creation date
{{ message.created_at | date: i18n.short_date }}
{{ message.created_at | date: i18n.short_date }}
7.4.28.1.6. url Link kopierenLink in die Zwischenablage kopiert!
URL of the message detail, points either to inbox or outbox.
7.4.28.1.7. state Link kopierenLink in die Zwischenablage kopiert!
Either 'read' or 'unread'
7.4.28.1.8. sender Link kopierenLink in die Zwischenablage kopiert!
Returns the name of the sender
7.4.28.1.9. to Link kopierenLink in die Zwischenablage kopiert!
Returns the name of the receiver
7.4.28.1.10. recipients Link kopierenLink in die Zwischenablage kopiert!
7.4.29. Message drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.29.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.29.1.1. type Link kopierenLink in die Zwischenablage kopiert!
The possible types of the messages are:
- success (not used by now)
- info
- warning
- danger
7.4.29.1.2. text Link kopierenLink in die Zwischenablage kopiert!
7.4.30. Metric drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.30.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.30.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.30.1.2. unit Link kopierenLink in die Zwischenablage kopiert!
Returns the unit of the metric
This metric is measured in {{ metric.unit | pluralize }}
This metric is measured in {{ metric.unit | pluralize }}
7.4.30.1.3. description Link kopierenLink in die Zwischenablage kopiert!
Returns the description of the metric
7.4.30.1.4. name Link kopierenLink in die Zwischenablage kopiert!
Returns the name of the metric
<h4>Metric {{ metric.name }}</h4> <p>{{ metric.description }}</p>
<h4>Metric {{ metric.name }}</h4>
<p>{{ metric.description }}</p>
7.4.30.1.5. system_name Link kopierenLink in die Zwischenablage kopiert!
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>
7.4.30.1.6. usage_limits Link kopierenLink in die Zwischenablage kopiert!
Returns the usage limits of the metric
7.4.30.1.7. pricing_rules Link kopierenLink in die Zwischenablage kopiert!
Returns the pricing rules of the metric
7.4.30.1.8. has_parent Link kopierenLink in die Zwischenablage kopiert!
7.4.31. Page drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.31.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.31.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.31.1.2. title Link kopierenLink in die Zwischenablage kopiert!
Returns the title of the page
<title>{{ page.title }}</title>
<title>{{ page.title }}</title>
7.4.31.1.3. system_name Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.32. Page drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.32.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.32.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.32.1.2. title Link kopierenLink in die Zwischenablage kopiert!
7.4.32.1.3. kind Link kopierenLink in die Zwischenablage kopiert!
7.4.32.1.4. url Link kopierenLink in die Zwischenablage kopiert!
7.4.32.1.5. description Link kopierenLink in die Zwischenablage kopiert!
7.4.33. Pagination drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.33.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.33.1.1. page_size Link kopierenLink in die Zwischenablage kopiert!
Number of items on one full page.
7.4.33.1.2. current_page Link kopierenLink in die Zwischenablage kopiert!
Number of the currently selected page.
7.4.33.1.3. current_offset Link kopierenLink in die Zwischenablage kopiert!
Items skipped so far.
7.4.33.1.4. pages Link kopierenLink in die Zwischenablage kopiert!
Total number of pages.
7.4.33.1.5. items Link kopierenLink in die Zwischenablage kopiert!
Total number of items in all pages together.
7.4.33.1.6. previous Link kopierenLink in die Zwischenablage kopiert!
Number of the previous page or empty.
7.4.33.1.7. next Link kopierenLink in die Zwischenablage kopiert!
Number of the next page or empty.
7.4.33.1.8. parts Link kopierenLink in die Zwischenablage kopiert!
Elements that help to render a user-friendly pagination. See the [[part-drop[part drop] for more information.
7.4.34. Part drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.34.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.34.1.1. url Link kopierenLink in die Zwischenablage kopiert!
7.4.34.1.2. rel Link kopierenLink in die Zwischenablage kopiert!
7.4.34.1.3. current? Link kopierenLink in die Zwischenablage kopiert!
7.4.34.1.4. is_link Link kopierenLink in die Zwischenablage kopiert!
7.4.34.1.5. title Link kopierenLink in die Zwischenablage kopiert!
7.4.34.1.6. to_s Link kopierenLink in die Zwischenablage kopiert!
7.4.35. PaymentGateway drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.35.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.35.1.1. braintree_blue? Link kopierenLink in die Zwischenablage kopiert!
Returns whether current payment gateway is authorize.Net
7.4.35.1.2. authorize_net? Link kopierenLink in die Zwischenablage kopiert!
Returns whether current payment gateway is authorize.Net
7.4.35.1.3. type Link kopierenLink in die Zwischenablage kopiert!
Returns the type of this payment gateway.
7.4.36. PaymentTransaction drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.36.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.36.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.36.1.2. currency Link kopierenLink in die Zwischenablage kopiert!
Returns the currency
7.4.36.1.3. amount Link kopierenLink in die Zwischenablage kopiert!
Returns the amount
7.4.36.1.4. created_at Link kopierenLink in die Zwischenablage kopiert!
Returns the creation date
7.4.36.1.5. success? Link kopierenLink in die Zwischenablage kopiert!
Returns true if was success
7.4.36.1.6. message Link kopierenLink in die Zwischenablage kopiert!
Returns the message of the transaction
7.4.36.1.7. reference Link kopierenLink in die Zwischenablage kopiert!
Returns the reference
7.4.37. PlanFeature drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.37.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.37.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.37.1.2. name Link kopierenLink in die Zwischenablage kopiert!
Returns the name of the feature
<h2>Feature {{ feature.name }}</h2>
<h2>Feature {{ feature.name }}</h2>
7.4.37.1.3. description Link kopierenLink in die Zwischenablage kopiert!
Returns the description of the feature
7.4.37.1.4. has_description? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.37.1.5. enabled? Link kopierenLink in die Zwischenablage kopiert!
7.4.38. Post drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.38.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.38.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.38.1.2. body Link kopierenLink in die Zwischenablage kopiert!
Text of the post.
7.4.38.1.3. topic Link kopierenLink in die Zwischenablage kopiert!
Every post belongs to a [[topic-drop[topic]
7.4.38.1.4. created_at Link kopierenLink in die Zwischenablage kopiert!
Date when this post created
{{ post.created_at | date: i18n.short_date }}
{{ post.created_at | date: i18n.short_date }}
7.4.38.1.5. url Link kopierenLink in die Zwischenablage kopiert!
The url of this post within its topic
7.4.39. Post drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.39.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.39.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.39.1.2. title Link kopierenLink in die Zwischenablage kopiert!
7.4.39.1.3. kind Link kopierenLink in die Zwischenablage kopiert!
7.4.39.1.4. url Link kopierenLink in die Zwischenablage kopiert!
7.4.39.1.5. description Link kopierenLink in die Zwischenablage kopiert!
7.4.40. PricingRule drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.40.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.40.1.1. cost_per_unit Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.40.1.2. min Link kopierenLink in die Zwischenablage kopiert!
Returns the minimum value of the pricing rule
7.4.40.1.3. max Link kopierenLink in die Zwischenablage kopiert!
Returns the maximum value of the pricing rule
7.4.40.1.4. plan Link kopierenLink in die Zwischenablage kopiert!
Returns plan of pricing rule
7.4.41. rovider drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.41.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.41.1.1. name Link kopierenLink in die Zwischenablage kopiert!
Returns the name of your organization.
7.4.41.1.2. payment_gateway Link kopierenLink in die Zwischenablage kopiert!
Returns the payment gateway associated with your organization
7.4.41.1.3. domain Link kopierenLink in die Zwischenablage kopiert!
Domain of your developer portal
7.4.41.1.4. timezone Link kopierenLink in die Zwischenablage kopiert!
Returns timezone that you use. Can be changed in your /p/admin/account/edit[administration dashboard].
7.4.41.1.5. support_email Link kopierenLink in die Zwischenablage kopiert!
Support email of the account
7.4.41.1.6. finance_support_email Link kopierenLink in die Zwischenablage kopiert!
Finance support email of the account
7.4.41.1.7. telephone_number Link kopierenLink in die Zwischenablage kopiert!
Returns the telephone number of the account
7.4.41.1.8. multiple_applications_allowed? Link kopierenLink in die Zwischenablage kopiert!
True if developers can have more separate applications with their own keys, stats, etc. Depends on your 3scale plan.
7.4.41.1.9. logo_url Link kopierenLink in die Zwischenablage kopiert!
Return the logo url
7.4.41.1.10. multiple_services_allowed? Link kopierenLink in die Zwischenablage kopiert!
True if your 3scale plan allows you to manage multiple APIs as separate [service[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 %}
7.4.41.1.11. finance_allowed? Link kopierenLink in die Zwischenablage kopiert!
7.4.41.1.12. multiple_users_allowed? Link kopierenLink in die Zwischenablage kopiert!
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].
7.4.41.1.13. account_plans Link kopierenLink in die Zwischenablage kopiert!
Returns all published account plans.
7.4.41.1.14. services Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.41.1.15. signups_enabled? Link kopierenLink in die Zwischenablage kopiert!
You can enable or disable signups in the Usage rules section of your Admin Portal.
7.4.41.1.16. account_management_enabled? Link kopierenLink in die Zwischenablage kopiert!
You can enable or disable account management in the Usage rules section.
7.4.42. ReferrerFilter drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.42.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.42.1.1. id Link kopierenLink in die Zwischenablage kopiert!
7.4.42.1.2. value Link kopierenLink in die Zwischenablage kopiert!
7.4.42.1.3. delete_url Link kopierenLink in die Zwischenablage kopiert!
7.4.42.1.4. application Link kopierenLink in die Zwischenablage kopiert!
7.4.43. Request drop (up) Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.43.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.43.1.1. request_uri Link kopierenLink in die Zwischenablage kopiert!
Returns the URI of the request
7.4.43.1.2. host_with_port Link kopierenLink in die Zwischenablage kopiert!
Returns the host with port of the request
7.4.43.1.3. host Link kopierenLink in die Zwischenablage kopiert!
Returns the host part of the request URL
7.4.43.1.4. path Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.44. Role drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.44.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.44.1.1. name Link kopierenLink in die Zwischenablage kopiert!
Return internal name of the role, important for the system
7.4.44.1.2. description Link kopierenLink in die Zwischenablage kopiert!
Return a descriptiptive text for the role
7.4.45. Search drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.45.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.45.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.45.1.2. query Link kopierenLink in die Zwischenablage kopiert!
Returns the searched string
7.4.45.1.3. total_found Link kopierenLink in die Zwischenablage kopiert!
Returns the number of matching elements
7.4.45.1.4. results Link kopierenLink in die Zwischenablage kopiert!
Returs an array of results for que search
7.4.46. Service drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.46.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.46.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.46.1.2. name Link kopierenLink in die Zwischenablage kopiert!
Returns the name of the service
7.4.46.1.3. system_name Link kopierenLink in die Zwischenablage kopiert!
Returns the system name of the service
7.4.46.1.4. description Link kopierenLink in die Zwischenablage kopiert!
Returns the description of the service
7.4.46.1.5. subscribed? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.46.1.6. subscription Link kopierenLink in die Zwischenablage kopiert!
Returns a subscription(ServiceContract
drop) if the currently logged in user is subscribed to this service, Nil otherwise.
7.4.46.1.7. subscribable? Link kopierenLink in die Zwischenablage kopiert!
7.4.46.1.8. subscribe_url Link kopierenLink in die Zwischenablage kopiert!
7.4.46.1.9. application_plans Link kopierenLink in die Zwischenablage kopiert!
Returns the published application plans of the service
7.4.46.1.10. service_plans Link kopierenLink in die Zwischenablage kopiert!
Returns the published service plans of the service
7.4.46.1.11. plans Link kopierenLink in die Zwischenablage kopiert!
Returns the application plans of the service
7.4.46.1.12. features Link kopierenLink in die Zwischenablage kopiert!
Returns the visible features of the service
7.4.46.1.13. apps_identifier Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.46.1.14. backend_version Link kopierenLink in die Zwischenablage kopiert!
7.4.46.1.15. referrer_filters_required? Link kopierenLink in die Zwischenablage kopiert!
7.4.46.1.16. metrics Link kopierenLink in die Zwischenablage kopiert!
Returns the metrics of the service
7.4.46.1.17. support_email Link kopierenLink in die Zwischenablage kopiert!
Support email of the service
7.4.47. ServiceContract drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.47.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.47.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.47.1.2. id Link kopierenLink in die Zwischenablage kopiert!
7.4.47.1.3. can_change_plan? Link kopierenLink in die Zwischenablage kopiert!
Returns true if any form of change is possible
7.4.47.1.4. trial? Link kopierenLink in die Zwischenablage kopiert!
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.
7.4.47.1.5. live? Link kopierenLink in die Zwischenablage kopiert!
7.4.47.1.6. state Link kopierenLink in die Zwischenablage kopiert!
There are three possible states:
- pending - live - suspended
- pending
- live
- suspended
7.4.47.1.7. remaining_trial_period_days Link kopierenLink in die Zwischenablage kopiert!
Number of day still left in the trial period.
7.4.47.1.8. plan Link kopierenLink in die Zwischenablage kopiert!
Returns the plan of the contract
7.4.47.1.9. plan_change_permission_name Link kopierenLink in die Zwischenablage kopiert!
Returns name of the allowed action
7.4.47.1.10. plan_change_permission_warning Link kopierenLink in die Zwischenablage kopiert!
Returns a warning messenger of the allowed action
7.4.47.1.11. contract Link kopierenLink in die Zwischenablage kopiert!
7.4.47.1.12. name Link kopierenLink in die Zwischenablage kopiert!
7.4.47.1.13. system_name Link kopierenLink in die Zwischenablage kopiert!
7.4.47.1.14. change_plan_url Link kopierenLink in die Zwischenablage kopiert!
7.4.47.1.15. service Link kopierenLink in die Zwischenablage kopiert!
7.4.47.1.16. applications Link kopierenLink in die Zwischenablage kopiert!
7.4.47.1.17. can Link kopierenLink in die Zwischenablage kopiert!
Exposes specific rights of the current user for that subscription.
{% if subscription.can.change_plan? %} ... {% endif %}
{% if subscription.can.change_plan? %}
...
{% endif %}
7.4.48. ServicePlan drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.48.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.48.1.1. selected? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.48.1.2. bought? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.48.1.3. features Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.48.1.4. setup_fee Link kopierenLink in die Zwischenablage kopiert!
Returns the setup fee of the plan
7.4.48.1.5. name Link kopierenLink in die Zwischenablage kopiert!
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>
7.4.48.1.6. system_name Link kopierenLink in die Zwischenablage kopiert!
Returns the system name of the plan
7.4.48.1.7. id Link kopierenLink in die Zwischenablage kopiert!
Returns the plan id
7.4.48.1.8. free? Link kopierenLink in die Zwischenablage kopiert!
The plan is free if it is not 'paid' (see the 'paid?' method)
7.4.48.1.9. paid? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.48.1.10. approval_required? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.48.1.11. flat_cost Link kopierenLink in die Zwischenablage kopiert!
Returns the monthly fixed fee of the plan
7.4.48.1.12. service Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.49. TimeZone drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.49.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.49.1.1. full_name Link kopierenLink in die Zwischenablage kopiert!
7.4.49.1.2. to_str Link kopierenLink in die Zwischenablage kopiert!
7.4.50. Today drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.50.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.50.1.1. month Link kopierenLink in die Zwischenablage kopiert!
Returns current month (1-12)
7.4.50.1.2. day Link kopierenLink in die Zwischenablage kopiert!
Returns current day of the month (1-31)
7.4.50.1.3. year Link kopierenLink in die Zwischenablage kopiert!
Returns current year Example: Create dynamic copyright
©{{ today.year }}
©{{ today.year }}
7.4.50.1.4. beginning_of_month Link kopierenLink in die Zwischenablage kopiert!
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' }}
7.4.51. Topic drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.51.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.51.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.51.1.2. title Link kopierenLink in die Zwischenablage kopiert!
7.4.51.1.3. kind Link kopierenLink in die Zwischenablage kopiert!
7.4.51.1.4. url Link kopierenLink in die Zwischenablage kopiert!
7.4.51.1.5. description Link kopierenLink in die Zwischenablage kopiert!
7.4.52. Topic drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.52.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.52.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.52.1.2. title Link kopierenLink in die Zwischenablage kopiert!
Name of the topic. Submitted when first post to the thread is posted.
7.4.52.1.3. url Link kopierenLink in die Zwischenablage kopiert!
7.4.53. Url drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.53.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.53.1.1. to_s Link kopierenLink in die Zwischenablage kopiert!
7.4.53.1.2. to_str Link kopierenLink in die Zwischenablage kopiert!
7.4.53.1.3. title Link kopierenLink in die Zwischenablage kopiert!
7.4.53.1.4. current_or_subpath? Link kopierenLink in die Zwischenablage kopiert!
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?'.
7.4.53.1.5. current? Link kopierenLink in die Zwischenablage kopiert!
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?'.
7.4.53.1.6. active? Link kopierenLink in die Zwischenablage kopiert!
True if the current page is in the same menu structure as this URL. See also '#current?'.
7.4.54. Urls drop (up) Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.1. provider Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.2. cas_login Link kopierenLink in die Zwischenablage kopiert!
<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>
7.4.54.1.3. new_application Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.4. signup Link kopierenLink in die Zwischenablage kopiert!
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>
7.4.54.1.5. search Link kopierenLink in die Zwischenablage kopiert!
URL to which all the search requests should be sent
<form action="{{ urls.search }}" method="get"> </form>
<form action="{{ urls.search }}" method="get">
</form>
7.4.54.1.6. login Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.7. logout Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.8. forgot_password Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.9. service_subscription Link kopierenLink in die Zwischenablage kopiert!
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>
7.4.54.1.10. compose_message Link kopierenLink in die Zwischenablage kopiert!
URL to a page that allows the developer contact provider via the internal messaging system.
7.4.54.1.11. messages_outbox Link kopierenLink in die Zwischenablage kopiert!
URL to the list of messages sent by a developer.
7.4.54.1.12. messages_trash Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.13. empty_messages_trash Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.14. credit_card_terms Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.15. credit_card_privacy Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.16. credit_card_refunds Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.17. users Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.18. personal_details Link kopierenLink in die Zwischenablage kopiert!
URL or Nil if user account management is disabled (check your Usage rules).
7.4.54.1.19. access_details Link kopierenLink in die Zwischenablage kopiert!
A page with API key(s) and other authentication info. Differs depending on the authentication strategy.
7.4.54.1.20. payment_details Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.21. new_invitation Link kopierenLink in die Zwischenablage kopiert!
Page to invite new users
7.4.54.1.22. invitations Link kopierenLink in die Zwischenablage kopiert!
List of all the sent invitations
7.4.54.1.23. dashboard Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.24. applications Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.25. api_access_details Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.26. services Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.27. messages_inbox Link kopierenLink in die Zwischenablage kopiert!
URL to the list of received messages.
7.4.54.1.28. stats Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.29. account_overview Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.30. account_plans Link kopierenLink in die Zwischenablage kopiert!
7.4.54.1.31. invoices Link kopierenLink in die Zwischenablage kopiert!
7.4.55. UsageLimit drop (up) Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.55.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.55.1.1. period Link kopierenLink in die Zwischenablage kopiert!
Returns the period of the usage limit
7.4.55.1.2. metric Link kopierenLink in die Zwischenablage kopiert!
Usually hits
but can be any custom method.
7.4.55.1.3. value Link kopierenLink in die Zwischenablage kopiert!
Returns the value of the usage limit
7.4.56. User drop (up) Link kopierenLink in die Zwischenablage kopiert!
<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 }}
7.4.56.1. Methods Link kopierenLink in die Zwischenablage kopiert!
7.4.56.1.1. errors Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.4.56.1.2. admin? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.56.1.3. username Link kopierenLink in die Zwischenablage kopiert!
Returns the username of the user, html escaped.
7.4.56.1.4. account Link kopierenLink in die Zwischenablage kopiert!
Returns the account of the user.
7.4.56.1.5. name Link kopierenLink in die Zwischenablage kopiert!
Returns the first and surname of the user.
7.4.56.1.6. email Link kopierenLink in die Zwischenablage kopiert!
Returns the email of the user.
7.4.56.1.7. password_required? Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.56.1.8. sections Link kopierenLink in die Zwischenablage kopiert!
Returns the list of sections the user has access to.
7.4.56.1.9. role Link kopierenLink in die Zwischenablage kopiert!
Returns the role of the user
7.4.56.1.10. roles_collection Link kopierenLink in die Zwischenablage kopiert!
Retuns a list of available roles for the user
7.4.56.1.11. url Link kopierenLink in die Zwischenablage kopiert!
Return the resource url of the user
{{ 'Delete' | delete_button: user.url }}
{{ 'Delete' | delete_button: user.url }}
7.4.56.1.12. edit_url Link kopierenLink in die Zwischenablage kopiert!
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' }}
7.4.56.1.13. can Link kopierenLink in die Zwischenablage kopiert!
Give access to permission methods
{% if user.can.be_managed? %} <!-- do something --> {% endif %}
{% if user.can.be_managed? %}
<!-- do something -->
{% endif %}
7.4.56.1.14. extra_fields Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.56.1.15. fields Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.4.56.1.16. builtin_fields Link kopierenLink in die Zwischenablage kopiert!
Returns all builtin fields with values for this user
7.5. Tags (up) Link kopierenLink in die Zwischenablage kopiert!
7.5.1. Tag 'braintree_customer_form' (up) Link kopierenLink in die Zwischenablage kopiert!
Renders a form to enter data required for Braintree Blue payment gateway
7.5.2. Tag 'csrf' (up) Link kopierenLink in die Zwischenablage kopiert!
Renders the cross site request forgery meta tags.
Example: Using csrf tag in liquid
<head> {% csrf %} </head>
<head>
{% csrf %}
</head>
7.5.3. Tag 'content' (up) Link kopierenLink in die Zwischenablage kopiert!
Renders body of a page. Use this only inside a layout.
7.5.4. Tag 'content_for' (up) Link kopierenLink in die Zwischenablage kopiert!
7.5.5. Tag 'debug' (up) Link kopierenLink in die Zwischenablage kopiert!
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 %}``
7.5.6. Tag 'email' (up) Link kopierenLink in die Zwischenablage kopiert!
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
7.5.7. Tag 'flash' (up) Link kopierenLink in die Zwischenablage kopiert!
Renders informational or error messages of the system.
DEPRECATED: This tag is deprecated, use FlashDrop instead.
Example: Using flash tag in liquid
{% flash %}
{% flash %}
7.5.9. Tag 'form' (up) Link kopierenLink in die Zwischenablage kopiert!
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 |
<ul> <li>application[name]</li> <li>application[description]</li> <li>application[<any-extra-field>]</li> </ul> | No | <ul> <li>application[name]</li> <li>application[description]</li> <li>application[<any-extra-field>]</li> </ul> | |
No | <ul> <li>account[org_name]</li> <li>account[org_legaladdress]</li> <li>account[org_legaladdress_cont]</li> <li>account[city]</li> <li>account[state]</li> <li>account[zip]</li> <li>account[telephone_number]</li> <li>account[country_id]</li> <li>account[<any-extra-field>]</li> <li>account[user][username]</li> <li>account[user][email]</li> <li>account[user][first_name]</li> <li>account[user][last_name]</li> <li>account[user][password]</li> <li>account[user][password_confirmation]</li> <li>account[user][title]</li> <li>account[user][<any-extra-field>]</li> </ul> | Yes |
Example: A form to create an application
7.5.10. Tag 'latest_forum_posts' (up) Link kopierenLink in die Zwischenablage kopiert!
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 %}
7.5.11. Tag 'latest_messages' (up) Link kopierenLink in die Zwischenablage kopiert!
Renders a html snippet with the latest messages for the user.
Example: Using latest_messages tag liquid
{% latest_messages %}
{% latest_messages %}
7.5.12. Tag 'logo' (up) Link kopierenLink in die Zwischenablage kopiert!
Renders the logo.
DEPRECATED: This tag is deprecated, use {{ provider.logo_url }} instead.
Example: Using menu tag in liquid
{% logo %}
{% logo %}
7.5.15. Tag 'plan_widget' (up) Link kopierenLink in die Zwischenablage kopiert!
Includes a widget to review or change application plan
7.5.16. Tag 'portlet' (up) Link kopierenLink in die Zwischenablage kopiert!
This tag includes portlet by system name.
7.5.18. Tag '3scale_essentials' (up) Link kopierenLink in die Zwischenablage kopiert!
7.5.19. Tag 'user_widget' (up) Link kopierenLink in die Zwischenablage kopiert!
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>
7.6. Filters (up) Link kopierenLink in die Zwischenablage kopiert!
7.6.1. FormHelpers filters (up) Link kopierenLink in die Zwischenablage kopiert!
7.6.1.1. error_class filter Link kopierenLink in die Zwischenablage kopiert!
Outputs error class if argument is not empty Example: Using error_class to show output an error class
7.6.1.2. inline_errors filter Link kopierenLink in die Zwischenablage kopiert!
Outputs error fields inline in paragraph Example: Using inline_errors to show errors inline
{{ form.errors.description | inline_errors }}
{{ form.errors.description | inline_errors }}
7.6.2. ParamFilter filters (up) Link kopierenLink in die Zwischenablage kopiert!
7.6.2.1. to_param filter Link kopierenLink in die Zwischenablage kopiert!
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>
7.6.3. Common filters (up) Link kopierenLink in die Zwischenablage kopiert!
7.6.3.1. group_by filter Link kopierenLink in die Zwischenablage kopiert!
Group collection by some key Example: Group applications by service
7.6.3.2. any filter Link kopierenLink in die Zwischenablage kopiert!
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' %}
7.6.3.3. stylesheet_link_tag filter Link kopierenLink in die Zwischenablage kopiert!
Stylesheet link
7.6.3.4. javascript_include_tag filter Link kopierenLink in die Zwischenablage kopiert!
Javascript include tag
7.6.3.5. image_tag filter Link kopierenLink in die Zwischenablage kopiert!
Outputs an tag using the parameters as its src
attribute.
{{ 'http://example.com/cool.gif' | image_tag }} ## =>
{{ 'http://example.com/cool.gif' | image_tag }}
## =>
7.6.3.6. mail_to filter Link kopierenLink in die Zwischenablage kopiert!
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>
7.6.3.7. html_safe filter Link kopierenLink in die Zwischenablage kopiert!
Marks content as HTML safe so that it is not escaped.
7.6.3.8. pluralize filter Link kopierenLink in die Zwischenablage kopiert!
Convert word to plural form
7.6.3.9. delete_button filter Link kopierenLink in die Zwischenablage kopiert!
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' }}
7.6.3.10. delete_button_ajax filter Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.6.3.11. update_button filter Link kopierenLink in die Zwischenablage kopiert!
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' }}
7.6.3.12. create_button filter Link kopierenLink in die Zwischenablage kopiert!
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 }}
7.6.3.13. create_button_ajax filter Link kopierenLink in die Zwischenablage kopiert!
7.6.3.14. regenerate_oauth_secret_button filter Link kopierenLink in die Zwischenablage kopiert!
7.6.3.15. link_to filter Link kopierenLink in die Zwischenablage kopiert!
Create link from given text
{{ "See your App keys" | link_to:'/my-app-keys' }}
{{ "See your App keys" | link_to:'/my-app-keys' }}