mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-08-07 17:27:16 +02:00
Code Issues Releases Wiki Activity

[ticket/10933] Prose for get_first_file_location.

Browse Source 
Also rewrite get_first_template_location prose a little to be
less repetitive with get_first_file_location.

PHPBB3-10933
This commit is contained in:
Oleg Pudeyev
2012-06-12 01:50:22 -04:00
parent bf66c47650
commit 7fdab9c5d7
2 changed files with 60 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
phpBB/includes/style/resource_locator.php
View File

@@ -295,19 +295,26 @@ class phpbb_style_resource_locator implements phpbb_template_locator
* each template in the array to a path, and will return the first
* path that exists, or false if none exist.
*
* If $files is an array and template inheritance is involved, first
* each of the files will be checked in the selected style, then each
* of the files will be checked in the immediate parent, and so on.
*
* If $return_full_path is false, then instead of returning a usable
* path (when the template is found) only the template's basename
* will be returned. This can be used to check which of the templates
* specified in $files exists, provided different file names are
* used for different templates.
* specified in $files exists. Naturally more than one template must
* be given in $files.
*
* Just like get_first_file_location but works on a list of templates,
* not files.
*
* The templates given in the first argument first are prepended with
* This function works identically to get_first_file_location except
* it operates on a list of templates, not files. Practically speaking,
* the templates given in the first argument first are prepended with
* the template path (property in this class), then given to
* get_first_file_location for the rest of the processing.
*
* Templates given to this function can be relative paths for templates
* located in subdirectories of the template directories. The paths
* should be relative to the templates directory (template/ by default).
*
* @param string or array $files List of templates to locate. If there is only
* one template, $files can be a string to make code easier to read.
* @param bool $return_default Determines what to return if template does not