/**
* Standard output handler for use with ob_start
+ *
+ * @return string
*/
function wfOutputHandler( $s ) {
global $wgDisableOutputCompression, $wgValidateAllHtml;
* the currently-requested URL.
* This isn't on WebRequest because we need it when things aren't initialized
* @private
+ *
+ * @return string
*/
function wfRequestExtension() {
/// @todo FIXME: this sort of dupes some code in WebRequest::getRequestUrl()
/**
* Handler that compresses data with gzip if allowed by the Accept header.
* Unlike ob_gzhandler, it works for HEAD requests too.
+ *
+ * @param $s string
+ *
+ * @return string
*/
function wfGzipHandler( $s ) {
if( !function_exists( 'gzencode' ) || headers_sent() ) {
/**
* Mangle flash policy tags which open up the site to XSS attacks.
+ *
+ * @param $s string
+ *
+ * @return string
*/
function wfMangleFlashPolicy( $s ) {
# Avoid weird excessive memory usage in PCRE on big articles
/**
* Add a Content-Length header if possible. This makes it cooperate with squid better.
+ *
+ * @param $length int
*/
function wfDoContentLength( $length ) {
if ( !headers_sent() && $_SERVER['SERVER_PROTOCOL'] == 'HTTP/1.0' ) {
/**
* Replace the output with an error if the HTML is not valid
+ *
+ * @param $s string
+ *
+ * @return string
*/
function wfHtmlValidationHandler( $s ) {
* which are no longer registered (eg a page is cached before an extension is disabled)
* @param $modules Array
* @param $position String if not null, only return modules with this position
+ * @param $type string
* @return Array
*/
protected function filterModules( $modules, $position = null, $type = ResourceLoaderModule::TYPE_COMBINED ){
*
* @param $filter Bool whether to filter out insufficiently trustworthy modules
* @param $position String if not null, only return modules with this position
+ * @param $param string
* @return Array of module names
*/
public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
/**
* Get the list of module JS to include on this page
+ *
+ * @param $filter
+ * @param $position
+ *
* @return array of module names
*/
public function getModuleScripts( $filter = false, $position = null ) {
/**
* Get the list of module CSS to include on this page
*
+ * @param $filter
+ * @param $position
+ *
* @return Array of module names
*/
public function getModuleStyles( $filter = false, $position = null ) {
/**
* Get the list of module messages to include on this page
*
+ * @param $filter
+ * @param $position
+ *
* @return Array of module names
*/
public function getModuleMessages( $filter = false, $position = null ) {
*
* Side effect: sets mLastModified for Last-Modified header
*
+ * @param $timestamp string
+ *
* @return Boolean: true iff cache-ok headers was sent.
*/
public function checkLastModified( $timestamp ) {
/**
* "HTML title" means the contents of <title>.
* It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
+ *
+ * @param $name string
*/
public function setHTMLTitle( $name ) {
$this->mHTMLtitle = $name;
* This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>.
* This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed.
* Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
+ *
+ * @param $name string
*/
public function setPageTitle( $name ) {
# change "<script>foo&bar</script>" to "<script>foo&bar</script>"
/**
* Use enableClientCache(false) to force it to send nocache headers
*
- * @param $state ??
+ * @param $state bool
+ *
+ * @return bool
*/
public function enableClientCache( $state ) {
return wfSetVar( $this->mEnableClientCache, $state );
*
* This is the default for special pages. If you display a CSRF-protected
* form on an ordinary view page, then you need to call this function.
+ *
+ * @param $enable bool
*/
public function preventClickjacking( $enable = true ) {
$this->mPreventClickjacking = $enable;
* Get the X-Frame-Options header value (without the name part), or false
* if there isn't one. This is used by Skin to determine whether to enable
* JavaScript frame-breaking, for clients that don't support X-Frame-Options.
+ *
+ * @return string
*/
public function getFrameOptions() {
global $wgBreakFrames, $wgEditPageFrameOptions;
* Add a "return to" link pointing to a specified title
*
* @param $title Title to link
- * @param $query String: query string
+ * @param $query String query string
* @param $text String text of the link (input is not escaped)
*/
public function addReturnTo( $title, $query = array(), $text = null ) {
/**
* JS stuff to put at the bottom of the <body>: modules marked with position 'bottom',
* legacy scripts ($this->mScripts), user preferences, site JS and user JS
+ *
+ * @param $sk Skin
+ *
+ * @return string
*/
function getBottomScripts( Skin $sk ) {
global $wgUseSiteJs, $wgAllowUserJs;
}
/**
+ * @param $sk Skin
+ * @param $addContentType bool
+ *
* @return string HTML tag links to be put in the header.
*/
public function getHeadLinks( Skin $sk, $addContentType = false ) {
* Build a set of <link>s for the stylesheets specified in the $this->styles array.
* These will be applied to various media & IE conditionals.
* @param $sk Skin object
+ *
+ * @return string
*/
public function buildCssLinks( $sk ) {
$ret = '';
* instead of a variable argument list.
*
* $options is passed through to wfMsgExt(), see that function for details.
+ *
+ * @param $name string
+ * @param $args array
+ * @param $options array
*/
public function addWikiMsgArray( $name, $args, $options = array() ) {
$options[] = 'parse';
* $wgOut->addWikiText( "<div class='error'>\n" . wfMsgNoTrans( 'some-error' ) . "\n</div>" );
*
* The newline after opening div is needed in some wikitext. See bug 19226.
+ *
+ * @param $wrap string
*/
public function wrapWikiMsg( $wrap /*, ...*/ ) {
$msgSpecs = func_get_args();
dépôts / lhc / web / wiklou.git / commitdiff