mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-22 08:55:15 +02:00
Code Issues Projects Releases Wiki Activity

MDL-58538 core: Set proper PHP Documentation for pix_url()

Browse Source 
Add @deprecated tag for theme_config::pix_url(). Add PHPDoc block for
renderer_base::pix_url().
This commit is contained in:
Jun Pataleta 2017-04-07 17:22:06 +08:00
parent 6d14355ce8
commit 088598ba28
2 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/outputlib.php
View File

@ -1646,12 +1646,13 @@ class theme_config {
*
* Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
*
* @deprecated since Moodle 3.3
* @param string $imagename the name of the icon.
* @param string $component specification of one plugin like in get_string()
* @return moodle_url
*/
public function pix_url($imagename, $component) {
debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.');
debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.', DEBUG_DEVELOPER);
return $this->image_url($imagename, $component);
}

12
lib/outputrenderers.php
View File

@ -253,8 +253,18 @@ class renderer_base {
return $classes;
}
/**
* Return the direct URL for an image from the pix folder.
*
* Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
*
* @deprecated since Moodle 3.3
* @param string $imagename the name of the icon.
* @param string $component specification of one plugin like in get_string()
* @return moodle_url
*/
public function pix_url($imagename, $component = 'moodle') {
debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.');
debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.', DEBUG_DEVELOPER);
return $this->page->theme->image_url($imagename, $component);
}