wiki.techinc.nl/includes/content/CssContentHandler.php
Thiemo Mättig 6806400129 Added and updated Doxygen comments in content handler and diff namespaces
Reasons for touching this are:
* "@param type $var" were mixed in a lot of places. Both works but the
  MediaWiki coding conventions suggest that specific order.
* Things like String and Bool aren't objects and shouldn't be uppercase.
* Tried to fill missing types in "@param $var".
* Tried to fill missing descriptions in "@return type" when I could.
* Removed duplicate descriptions if a @see is sufficend.
* Removed useless descriptions ("isUsefull returns true if usefull").
* Removed useless @return void.
* Replaces mixed[] with array (does have the exact same meaning).
* Tried to find better replacements for "varargs", phpDocumentor
  suggest $var,...
* Order should be @since, @param, @throws, @return, @see. This is the
  order Doxygen renders this.

There is always more to do but I think this is already much better
than before. Please feel free to put more change sets on top of mine
or request more changes by adding comments.

Change-Id: I05262ce06caabf79f68772302524ac91bbead1c6
2014-03-06 11:17:41 +01:00

90 lines
2.3 KiB
PHP

<?php
/**
* Content handler for CSS pages.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Content
*/
/**
* Content handler for CSS pages.
*
* @since 1.21
* @ingroup Content
*/
class CssContentHandler extends TextContentHandler {
/**
* @param string $modelId
*/
public function __construct( $modelId = CONTENT_MODEL_CSS ) {
parent::__construct( $modelId, array( CONTENT_FORMAT_CSS ) );
}
/**
* @param string $text
* @param string $format
*
* @return CssContent
*
* @see ContentHandler::unserializeContent()
*/
public function unserializeContent( $text, $format = null ) {
$this->checkFormat( $format );
return new CssContent( $text );
}
/**
* @return CssContent A new CssContent object with empty text.
*
* @see ContentHandler::makeEmptyContent()
*/
public function makeEmptyContent() {
return new CssContent( '' );
}
/**
* Returns the english language, because CSS is english, and should be handled as such.
*
* @param Title $title
* @param Content $content
*
* @return Language wfGetLangObj( 'en' )
*
* @see ContentHandler::getPageLanguage()
*/
public function getPageLanguage( Title $title, Content $content = null ) {
return wfGetLangObj( 'en' );
}
/**
* Returns the english language, because CSS is english, and should be handled as such.
*
* @param Title $title
* @param Content $content
*
* @return Language wfGetLangObj( 'en' )
*
* @see ContentHandler::getPageViewLanguage()
*/
public function getPageViewLanguage( Title $title, Content $content = null ) {
return wfGetLangObj( 'en' );
}
}