Message: Document better what it means to "use the database"
Change-Id: Id8af4f727d1394bfae0f5736c4c69307c8f85246
This commit is contained in:
thiemowmde
parent
175563ded4
commit
863240c26d
1 changed files with 28 additions and 28 deletions
|
|
@ -196,7 +196,8 @@ class Message implements MessageSpecifier, Serializable {
|
|||
protected $parameters = [];
|
||||
|
||||
/**
|
||||
* @var bool Whether database can be used.
|
||||
* @var bool If messages in the local MediaWiki namespace should be loaded; false to use only
|
||||
* the compiled LocalisationCache
|
||||
*/
|
||||
protected $useDatabase = true;
|
||||
|
||||
|
|
@ -398,7 +399,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param string|string[]|MessageSpecifier $key
|
||||
* @param mixed ...$params Parameters as strings.
|
||||
*
|
||||
* @return Message
|
||||
* @return self
|
||||
*/
|
||||
public static function newFromKey( $key, ...$params ) {
|
||||
return new self( $key, $params );
|
||||
|
|
@ -419,7 +420,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
*
|
||||
* @param string|array|MessageSpecifier $value
|
||||
* @param-taint $value tainted
|
||||
* @return Message
|
||||
* @return self
|
||||
* @throws InvalidArgumentException
|
||||
* @since 1.27
|
||||
*/
|
||||
|
|
@ -455,7 +456,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* message keys.
|
||||
* @param-taint ...$keys tainted
|
||||
*
|
||||
* @return Message
|
||||
* @return self
|
||||
*/
|
||||
public static function newFallbackSequence( ...$keys ) {
|
||||
if ( func_num_args() == 1 ) {
|
||||
|
|
@ -506,7 +507,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param mixed ...$args Parameters as strings or arrays from
|
||||
* Message::numParam() and the like, or a single array of parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function params( ...$args ) {
|
||||
// If $args has only one entry and it's an array, then it's either a
|
||||
|
|
@ -541,7 +542,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param mixed ...$params Raw parameters as strings, or a single argument that is
|
||||
* an array of raw parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function rawParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -562,7 +563,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param mixed ...$params Numeric parameters, or a single argument that is
|
||||
* an array of numeric parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function numParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -583,7 +584,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param int|int[] ...$params Duration parameters, or a single argument that is
|
||||
* an array of duration parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function durationParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -604,7 +605,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param string|string[] ...$params Expiry parameters, or a single argument that is
|
||||
* an array of expiry parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function expiryParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -625,7 +626,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param string|string[] ...$params Date-time parameters, or a single argument that is
|
||||
* an array of date-time parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function dateTimeParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -646,7 +647,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param string|string[] ...$params Date parameters, or a single argument that is
|
||||
* an array of date parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function dateParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -666,7 +667,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param string|string[] ...$params User Group parameters, or a single argument that is
|
||||
* an array of user group parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function userGroupParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -686,7 +687,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param Stringable|Stringable[] ...$params stringable parameters,
|
||||
* or a single argument that is an array of stringable parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function objectParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -707,7 +708,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param string|string[] ...$params Time parameters, or a single argument that is
|
||||
* an array of time parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function timeParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -728,7 +729,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param int|int[] ...$params Time period parameters, or a single argument that is
|
||||
* an array of time period parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function timeperiodParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -749,7 +750,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param int|int[] ...$params Size parameters, or a single argument that is
|
||||
* an array of size parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function sizeParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -770,7 +771,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param int|int[] ...$params Bit rate parameters, or a single argument that is
|
||||
* an array of bit rate parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function bitrateParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -793,7 +794,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @param string|string[] ...$params plaintext parameters, or a single argument that is
|
||||
* an array of plaintext parameters.
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function plaintextParams( ...$params ) {
|
||||
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
|
||||
|
|
@ -812,7 +813,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
*
|
||||
* @param IContextSource $context
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function setContext( IContextSource $context ) {
|
||||
$this->inLanguage( $context->getLanguage() );
|
||||
|
|
@ -830,7 +831,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
*
|
||||
* @since 1.17
|
||||
* @param Language|StubUserLang|string $lang Language code or Language object.
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function inLanguage( $lang ) {
|
||||
$previousLanguage = $this->language;
|
||||
|
|
@ -864,7 +865,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
* @since 1.17
|
||||
* @see $wgForceUIMsgAsContentMsg
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function inContentLanguage(): self {
|
||||
$forceUIMsgAsContentMsg = MediaWikiServices::getInstance()->getMainConfig()->get(
|
||||
|
|
@ -885,7 +886,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
*
|
||||
* @param bool $interface
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function setInterfaceMessageFlag( $interface ) {
|
||||
$this->interface = (bool)$interface;
|
||||
|
|
@ -893,13 +894,12 @@ class Message implements MessageSpecifier, Serializable {
|
|||
}
|
||||
|
||||
/**
|
||||
* Enable or disable database use.
|
||||
*
|
||||
* @since 1.17
|
||||
*
|
||||
* @param bool $useDatabase
|
||||
* @param bool $useDatabase If messages in the local MediaWiki namespace should be loaded; false
|
||||
* to use only the compiled LocalisationCache
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function useDatabase( $useDatabase ) {
|
||||
$this->useDatabase = (bool)$useDatabase;
|
||||
|
|
@ -915,7 +915,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
*
|
||||
* @param Title $title
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function title( $title ) {
|
||||
return $this->page( $title );
|
||||
|
|
@ -928,7 +928,7 @@ class Message implements MessageSpecifier, Serializable {
|
|||
*
|
||||
* @param ?PageReference $page
|
||||
*
|
||||
* @return Message $this
|
||||
* @return self $this
|
||||
*/
|
||||
public function page( ?PageReference $page ) {
|
||||
$this->contextPage = $page;
|
||||
|
|
|
|||
Loading…
Reference in a new issue