What is the role of the `index` filter in processing string searches?

In the world of AnQiCMS templates, efficiently processing and displaying content is the core.No matter whether it is to dynamically adjust the page display based on user input or to quickly locate key information in complex text, mastering the template function can greatly improve the operation of website content.Today, let's delve deeper into a very practical tool for string searching-indexfilter.

indexFilter: String containing "Location Expert"

Imagine that you have a long article or a list with multiple tags, and you need to quickly know if a specific word or tag exists, as well as its first occurrence position. At this point,indexThe filter comes into play.

indexThe main function of the filter is toFind the first occurrence of the specified "keyword" in a string or an array (slice) lineIt acts like a precise navigation instrument, able to tell you where the target string or element starts.

When you useindexThe filter returns an integer. This integer represents the keyword in the original string.It starts from 0.The starting position. If unfortunately, it does not find the keyword you are looking for, it will return a special number: -1.This-1 is like telling you: 'Sorry, I couldn't find it.'

It is worth noting that when processing strings containing Chinese characters,indexThe filter has a unique rule when calculating positions:A Chinese character is counted as 3 position lengthsThis means that if you are searching for a substring in a Chinese string and want to use the returned position for subsequent operations, you need to consider this feature.For example, find 'CMS' in a string that contains '欢迎使用安企CMS', if '欢迎使用安企' is exactly 6 Chinese characters (6 * 3 = 18), then the starting position of 'CMS' will be 18.

Actual application scenario: Make content smarter

indexThe filter is simple, but its application can bring smarter interaction and more flexible content display to your website.

1. Conditional display or style adjustment: Assuming you want to add a prominent tag or change the color of the title when a specific keyword is included in the article title. You can useindexFilter to determine if a keyword exists:

   {% set articleTitle = "安企CMS：打造高效企业级网站" %}
   {% if articleTitle|index:"高效" != -1 %}
       <h1 style="color: blue;">{{ articleTitle }} <span class="highlight-tag">热门</span></h1>
   {% else %}
       <h1>{{ articleTitle }}</h1>
   {% endif %}
   

   This code will check if the title contains the word "efficient". If found, it will add a blue style and a "hot" tag to the title.

2. Dynamic content extraction and processingAlthoughindexThe content itself does not change, but its result can guide other filters in operation.For example, do you want to find a specific phrase in a long text and cut it off before the phrase, or add specific information after the phrase?By obtaining the position, you can combinesliceA filter can be used to achieve more accurate text processing.

3. Existence check of array elementsExcept for strings,indexThe filter can also be used for arrays. If you have a product tag array, you want to quickly determine if a tag has been added:

   {% set productTags = ["新品上市", "限时优惠", "推荐"]|list %}
   {% if productTags|index:"限时优惠" != -1 %}
       <p>此产品正在限时优惠中！</p>
   {% else %}
       <p>此产品暂无特殊优惠。</p>
   {% endif %}
   

   here,productTags|listEnsuredproductTagsThen it is parsed correctly as an array, nextindexThe filter determines if the 'Time-limited discount' exists.

Summary

indexThe filter is a powerful and flexible tool in the AnQiCMS template engine, which can help you accurately locate keywords in strings or arrays, providing the foundation for dynamic and intelligent content display.Master its usage, especially the calculation rules for Chinese characters, will make your template development more proficient, thereby improving the overall operation efficiency and user experience of the website.

Frequently Asked Questions (FAQ)

Q1:indexDoes the filter distinguish between uppercase and lowercase when searching for strings?A: Yes,indexThe filter is case-sensitive when searching for strings. For example, searching for “CMS” and searching for “cms” will be considered two different keywords.

Q2: BesidesindexAre there other methods in AnQiCMS to check if a string contains a certain keyword? What are the differences between them?A: AnQiCMS providescontainA filter that can also be used to check if a string or array contains a certain keyword. The main difference lies in the return value:

• indexThe keyword returned by the filterThe first occurrence positionAn integer, if not found then -1.
• containThe filter returns one directly.Boolean(True or False), indicates whether the keyword exists. If you only need to know 'whether there is',containit will be more concise; if you also need to know 'where', thenindexIs a better choice.

Q3: If I need to find the positions of all matching items in a string,indexCan the filter do that?A:indexThe filter can only return keywordsThe first occurrence position. If you need to find the positions of all matching items, just rely onindexThe filter cannot be implemented directly. This scenario usually requires combining more complex template logic (such as searching step by step through loops and string slicing), or processing it on the backend (AnQiCMS's Go language logic layer) and then passing the result to the template.