[ticket/10933] Dispose of locate function in template class.

It had no callers other than the test suite.

PHPBB3-10933

phpBB/includes/style/resource_locator.php

@@ -249,12 +249,59 @@ class phpbb_style_resource_locator implements phpbb_template_locator
 	}
 
 	/**
+	* Obtains filesystem path for a template file.
+	*
+	* The simplest use is specifying a single template file as a string
+	* in the first argument. This template file should be a basename
+	* of a template file in the selected style, or its parent styles
+	* if template inheritance is being utilized.
+	*
+	* Note: "selected style" is whatever style the style resource locator
+	* is configured for.
+	*
+	* The return value then will be a path, relative to the current
+	* directory or absolute, to the template file in the selected style
+	* or its closest parent.
+	*
+	* If the selected style does not have the template file being searched,
+	* (and if inheritance is involved, none of the parents have it either),
+	* false will be returned.
+	*
+	* Specifying true for $return_default will cause the function to
+	* return the first path which was checked for existence in the event
+	* that the template file was not found, instead of false.
+	* This is the path in the selected style itself, not any of its
+	* parents.
+	*
+	* $files can be given an array of templates instead of a single
+	* template. When given an array, the function will try to resolve
+	* each template in the array to a path, and will return the first
+	* path that exists, or false if none exist.
+	*
+	* 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.
 	*
 	* 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.
+	*
+	* @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
+	*				exist. If true, function will return location where template is
+	*				supposed to be. If false, function will return false.
+	* @param bool $return_full_path If true, function will return full path
+	*				to template. If false, function will return template file name.
+	*				This parameter can be used to check which one of set of template
+	*				files is available.
+	* @return string or boolean Source template path if template exists or $return_default is
+	*				true. False if template does not exist and $return_default is false
 	*/
 	public function get_first_template_location($templates, $return_default = false, $return_full_path = true)
 	{

phpBB/includes/template/template.php

@@ -451,60 +451,6 @@ class phpbb_template
 		include($file);
 	}
 
-	/**
-	* Obtains filesystem path for a template file.
-	*
-	* The simplest use is specifying a single template file as a string
-	* in the first argument. This template file should be a basename
-	* of a template file in the selected style, or its parent styles
-	* if template inheritance is being utilized.
-	*
-	* Note: "selected style" is whatever style the style resource locator
-	* is configured for.
-	*
-	* The return value then will be a path, relative to the current
-	* directory or absolute, to the template file in the selected style
-	* or its closest parent.
-	*
-	* If the selected style does not have the template file being searched,
-	* (and if inheritance is involved, none of the parents have it either),
-	* false will be returned.
-	*
-	* Specifying true for $return_default will cause the function to
-	* return the first path which was checked for existence in the event
-	* that the template file was not found, instead of false.
-	* This is the path in the selected style itself, not any of its
-	* parents.
-	*
-	* $files can be given an array of templates instead of a single
-	* template. When given an array, the function will try to resolve
-	* each template in the array to a path, and will return the first
-	* path that exists, or false if none exist.
-	*
-	* 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.
-	*
-	* @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
-	*				exist. If true, function will return location where template is
-	*				supposed to be. If false, function will return false.
-	* @param bool $return_full_path If true, function will return full path
-	*				to template. If false, function will return template file name.
-	*				This parameter can be used to check which one of set of template
-	*				files is available.
-	* @return string or boolean Source template path if template exists or $return_default is
-	*				true. False if template does not exist and $return_default is false
-	*/
-	public function locate($files, $return_default = false, $return_full_path = true)
-	{
-		// use resource locator to find files
-		return $this->locator->get_first_template_location($files, $return_default, $return_full_path);
-	}
-
 	/**
 	* Include JS file
 	*