How to use `if` judgment in AnQiCMS template to prevent rendering errors caused by undefined variables?

Drive Anqi CMS template: Use cleverlyifSentences, say goodbye to undefined variable rendering errors!

As an experienced website operations expert, I am well aware of the importance of a stable and efficient website template for user experience and operational efficiency.AnQiCMS (AnQiCMS) provides strong support for content management with its efficient architecture based on the Go language and a flexible Django-like template engine.However, even the most excellent system may cause rendering errors due to minor omissions in the template, the most common of which is accessing undefined variables.Today, let's delve into how to skillfully use AnQiCMS templatesifJudgment, thoroughly solve this annoying problem.

In website template development, data is dynamic and often, the data we get from the backend may not always exist, or some fields may occasionally be empty.If the template code attempts to render a non-existent or empty variable, it may result in page display errors, or even cause the entire page to crash, which is undoubtedly a huge killer of user experience. 幸运的是，AnQiCMS强大的ifLogical judgment labels, providing us with a solid defense.

Get to know the AnQiCMS template inifthe judgment.

AnQiCMS's template syntax is highly similar to the Django template engine, its conditional judgment tags are defined using single curly braces and percent signs, and need to be ended with a closing tag{% endif %}Pairwise. The most basic.ifThe structure of the judgment is as follows:

{% if 条件 %}
    <!-- 当条件为真时渲染的内容 -->
{% endif %}

The key here is the assessment of "condition". In AnQiCMS templates,ifThe conditional judgment of the statement is very flexible and intelligent:

  • The variable exists and is not empty: If the variable is defined and its value is notnil(an empty string,""), a number0, an empty array ([]) or an empty object ({}), then the condition is considered to be "true" (true)
  • The variable does not exist or is empty: Conversely, if the variable is not defined, or its value isnil, an empty string, a number0, an empty array or an empty object, then the condition is considered to be "false" (false)

This means that we do not need to explicitly check whether the variable isnilornulla simple{% if 变量名 %}and we are done!

Scenario one: Ensure the variable exists before rendering

Imagine that your website header needs to display a Logo, the URL of which is obtained from the system settings. But if the operation personnel forgets to upload the Logo, or does not need to display the Logo on a specific page, render directly<img>A label could potentially lead to an emptysrcProperty, or even worse, a page error.

At this point, we can use it like thisifJudgment:

{% system siteLogo with name="SiteLogo" %}
{% if siteLogo %}
    <a href="/">
        <img src="{{ siteLogo }}" alt="网站Logo">
    </a>
{% else %}
    <a href="/">
        <h1>{% system with name="SiteName" %}</h1> <!-- 如果没有Logo，则显示网站名称 -->
    </a>
{% endif %}

In this code, we first try to obtainSiteLogoAssign the value tositeLogoVariable. Then,{% if siteLogo %}Will checksiteLogoExists and is not empty. If the Logo image URL exists, then render<img>Label; otherwise, it will gracefully fallback to displaying the website name, ensuring the integrity and aesthetics of the page structure.

Scenario two: Handle list data to avoid looping over an empty set.

When displaying a list of articles, product lists, or friend links, we often use itforHowever, if no content is entered in the background or the query results are empty, directly iterating over an empty collection may cause the template to render blank or an error.

A typicalarchiveList(Document list) Label usage scenarios are as follows:

{% archiveList archives with type="list" categoryId="1" limit="10" %}
    {% if archives %}
        <ul>
        {% for item in archives %}
            <li><a href="{{ item.Link }}">{{ item.Title }}</a></li>
        {% endfor %}
        </ul>
    {% else %}
        <p>抱歉，当前分类下还没有任何内容。</p>
    {% endif %}
{% endarchiveList %}

here,{% if archives %}JudgedarchivesThis list is empty. If the list has data, it will be traversed normally; if the list is empty, a friendly prompt message will be displayed.

Tip:For loop, AnQiCMS also provides a more concise{% for ... empty %}structure, which can automatically handle the case of an empty list, the code is more elegant:

{% archiveList archives with type="list" categoryId="1" limit="10" %}
    <ul>
    {% for item in archives %}
        <li><a href="{{ item.Link }}">{{ item.Title }}</a></li>
    {% empty %}
        <li>抱歉，当前分类下还没有任何内容。</li>
    {% endfor %}
    </ul>
{% endarchiveList %}

Scenario three: Rendering content based on specific conditions (elifwithelse)

In some cases, you may need to render different content based on different variable values, or provide multi-level backup solutions. At this point,elif(else if) andelseit can be put to use.

For example, you may want to display different styles or hints based on the recommended attributes of the article(Flag) to display different styles or hints:

{% archiveDetail archiveDetailData with name="Flag" %}
{% if "h" in archiveDetailData %} {# 判断是否包含头条属性 #}
    <span class="badge badge-primary">头条</span>
{% elif "c" in archiveDetailData %} {# 判断是否包含推荐属性 #}
    <span class="badge badge-info">推荐</span>
{% else %}
    <span class="badge badge-secondary">普通</span>
{% endif %}

This code will be based on the attributes of theFlagThe attribute contains 'h' (Headline) or 'c' (Recommend) to display different labels.If neither of them includes, it will display as 'ordinary'. This multi-level judgment mechanism makes the logical expression of the template more refined.

**Practice and Thought

  1. active defense rather than passive repair: When developing templates, it should always be assumed that some data may be missing. Before referencing any variable that may be empty, firstifcheck, and develop good coding habits.
  2. Make good use ofdefaultFilterFor simple text or numbers, if it is just to provide a default value rather than render complex structures,defaultthe filter would be a simpler choice. For example:{{ archive.Author|default:"佚名" }}. It is withifJudgment is complementary rather than substitute.
  3. Keep the template logic clear.: AlthoughifJudging is very powerful, but too much nesting or complex conditions will reduce the readability of the template. Try to put complex data processing logic on the backend, and the template is only responsible for data display.
  4. Consult the documentation: AnQiCMS provides comprehensive documentation for tags and filters (such asdesign-tag.md/tag-if.mdetc.). When you are unsure of a variable's type or its usage inifWhen performing under certain conditions, referring to the official documentation is the most efficient way.

By proficiently using the AnQiCMS template inifJudgment, you will be able to build a more robust and fault-tolerant website template, effectively preventing rendering errors caused by undefined variables, thereby providing a more stable and superior user experience.

Frequently Asked Questions (FAQ)

1. Why does my page display an 'Undefined variable' or similar error, even though I am sure that the variable should have a value in some cases?

This usually happens when your template code tries to access something in the current contextIt actually does not existOrThe value ofnil/emptyWhen a variable is missing. Even if this variable has a value on other pages or in the scenario you expect, it may be missing in the current specific rendering request.For example, you may have called in an article detail page{{ category.Title }}But the current page is not a category page, or the article does not have associated categories,categoryVariables are naturally undefined. Use{% if category %}or{% if category.Title %}Judgment can avoid such errors.

2.{% if 变量 %}and{{ 变量|default:"默认值" }}What is the difference between these two ways of handling, and how should I choose?

  • {% if 变量 %}: is more suitable forRender control structures or content blocks. When a variable does not exist or is empty, you may want to render the entire HTML element (such as<div>/<img>/<ul>Content that is not rendered, or rendered a completely different fallback block. For example, ifLogois not present, you may not want<img>the tag to appear, but to display text instead.
  • {{ 变量|default:"默认值" }}: is more suitable forProvide inline, simple alternative text or values. When the variable is missing, you just want to fill in a simple default value without changing the entire page layout.For example, if the author field of the article is empty, use 'Anonymous' instead, without hiding the entire author information line.

You can choose the simplest and most efficient method according to your specific needs, and the two are often combined to achieve **effect.

3.ifCan you distinguish between a variable that is completely undefined and one that is just an empty string or 0?

in AnQiCMS'sifIn the judgment logic