[cms] Random new template detection order in theme

By default each template file (*.tpl) discovered during theme scan has url matching it's location on disk:

If there is a need to change url, that would lead to that template, then special block comment needs to be added in the beginning of the template:

<!--##
<NAME>Template Name</NAME>
<DESC>Template Description</DESC>
<SECTION>1st Level Section||2nd Level Section||3rd Level Section</SECTION>
##--> 

This way template url and it's location in "Structure & Data" is completely controlled using comment block described above.

Index Page Approach

If "index.tpl" template is present in any directory in theme, then it's content will be displayed automatically. Here is example:

Template Scan Problem

File system can't guarantee, that new filenames found in theme during it's scanning are always sorted in same way. That's why it's near to impossible to ensure, that "template_a.tpl" corresponding section would already be present by the time it will be found by theme scanner.

I have several ideas about ways to fix a problem. Please tell me what you think:

• define order for each file/folder in theme that would be used to sort files/folders during scan process
• define priority only for files/folders, that are required to be scanned first comparing to other files/folders in same folder

Order/priority definition can be made in:

1. same block comment, that each template file has
2. separate file, created per-folder (like .smsignore)
3. single per-theme file in theme root folder
4. single per-theme file in theme /install/ sub-folder (we already have theme.xml file there)

Solution

1. change the "c:OnAfterRebuildThemes" event to unserialize values of "$files" array (all at once) before using them later - 0.3h
2. create the "CategoriesEventHandler::sortByDependencies(array $files)" method, that will: - 0.5h
   1. accept $files associative array, that is built in "c:OnAfterRebuildThemes" event, where:
      1. key is relative path to a template in theme
      2. value is array, that was parsed from template meta comment
   2. for each array entry (the template file) build a sorting key like this:
      1. take array from "section" key of template info (if missing use empty array)
      2. append value of "name" key to that array (if missing use '_Auto: ' . $template)
      3. combine using a separator (e.g. "||")
   3. sort array using sort key built above (will ensure, that parent templates will be listed prior to child templates)
   4. return sorted "$files" array
3. in the "c:OnAfterRebuildThemes" event call the "CategoriesEventHandler::sortByDependencies" method on the "$files" array prior to creating categories from it - 0.2h

Quote: 1h*1.4=1.5h

Related Tasks

INP-1645 - Getting issue details... STATUS