diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2012-06-12 01:50:22 -0400 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2012-11-02 19:45:02 -0400 |
| commit | 7fdab9c5d7d212f206cfdd79f5ccef097070a7f5 (patch) | |
| tree | ce4788899a3d681e42d0adba505d2e0c4729cf66 /phpBB/includes/style | |
| parent | bf66c47650682331454487c9db3999265f06df78 (diff) | |
| download | forums-7fdab9c5d7d212f206cfdd79f5ccef097070a7f5.tar forums-7fdab9c5d7d212f206cfdd79f5ccef097070a7f5.tar.gz forums-7fdab9c5d7d212f206cfdd79f5ccef097070a7f5.tar.bz2 forums-7fdab9c5d7d212f206cfdd79f5ccef097070a7f5.tar.xz forums-7fdab9c5d7d212f206cfdd79f5ccef097070a7f5.zip | |
[ticket/10933] Prose for get_first_file_location.
Also rewrite get_first_template_location prose a little to be
less repetitive with get_first_file_location.
PHPBB3-10933
Diffstat (limited to 'phpBB/includes/style')
| -rw-r--r-- | phpBB/includes/style/resource_locator.php | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/phpBB/includes/style/resource_locator.php b/phpBB/includes/style/resource_locator.php index 6181653d4e..04beddb434 100644 --- a/phpBB/includes/style/resource_locator.php +++ b/phpBB/includes/style/resource_locator.php @@ -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. - * - * Just like get_first_file_location but works on a list of templates, - * not files. + * specified in $files exists. Naturally more than one template must + * be given in $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 |