wikimedia/mediawiki-extensions-PageImages
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/PageImages synced 2024-11-15 03:43:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document page property names

Browse source 
This should protect us when we consider renaming these variables
in future.

Bug: T152239
Change-Id: I227ffd0867f797d6a450b8b51759338cff7ee3a8
This commit is contained in:
jdlrobson 2017-01-23 13:53:05 -08:00 committed by Jdlrobson
parent 1a5bd00330
commit 21963c89ea
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
includes/PageImages.php
View file

@ -12,16 +12,24 @@ class PageImages {
* Page property used to store the best page image information.
* If the best image is the same as the best image with free license,
* then nothing is stored under this property.
* Note changing this value is not advised as it will invalidate all
* existing page property names on a production instance
* and cause them to be regenerated.
* @see PageImages::PROP_NAME_FREE
*/
const PROP_NAME = 'page_image';
/**
* Page property used to store the best free page image information
* Note changing this value is not advised as it will invalidate all
* existing page property names on a production instance
* and cause them to be regenerated.
*/
const PROP_NAME_FREE = 'page_image_free';
/**
* Get property name used in page_props table
* Get property name used in page_props table. When a page image
* is stored it will be stored under this property name on the corresponding
* article.
*
* @param bool $isFree Whether the image is a free-license image
* @return string