<?php
-
-if( !defined( 'MEDIAWIKI' ) )
- die;
-
+/**
+ * Functions related to change tags.
+ *
+ * @file
+ */
class ChangeTags {
+
+ /**
+ * Creates HTML for the given tags
+ *
+ * @param $tags String: Comma-separated list of tags
+ * @param $page String: A label for the type of action which is being displayed,
+ * for example: 'history', 'contributions' or 'newpages'
+ *
+ * @return Array with two items: (html, classes)
+ * - html: String: HTML for displaying the tags (empty string when param $tags is empty)
+ * - classes: Array of strings: CSS classes used in the generated html, one class for each tag
+ *
+ */
static function formatSummaryRow( $tags, $page ) {
if( !$tags )
return array( '', array() );
);
$classes[] = Sanitizer::escapeClass( "mw-tag-$tag" );
}
-
$markers = '(' . implode( ', ', $displayTags ) . ')';
$markers = Xml::tags( 'span', array( 'class' => 'mw-tag-markers' ), $markers );
+
return array( $markers, $classes );
}
+ /**
+ * Get a short description for a tag
+ *
+ * @param $tag String: tag
+ *
+ * @return String: Short description of the tag from "mediawiki:tag-$tag" if this message exists,
+ * html-escaped version of $tag otherwise
+ */
static function tagDescription( $tag ) {
- $msg = wfMsgExt( "tag-$tag", 'parseinline' );
- if ( wfEmptyMsg( "tag-$tag", $msg ) ) {
- return htmlspecialchars( $tag );
- }
- return $msg;
+ $msg = wfMessage( "tag-$tag" );
+ return $msg->exists() ? $msg->parse() : htmlspecialchars( $tag );
}
- ## Basic utility method to add tags to a particular change, given its rc_id, rev_id and/or log_id.
+ /**
+ * Add tags to a change given its rc_id, rev_id and/or log_id
+ *
+ * @param $tags String|Array: Tags to add to the change
+ * @param $rc_id int: rc_id of the change to add the tags to
+ * @param $rev_id int: rev_id of the change to add the tags to
+ * @param $log_id int: log_id of the change to add the tags to
+ * @param $params String: params to put in the ct_params field of tabel 'change_tag'
+ *
+ * @return bool: false if no changes are made, otherwise true
+ *
+ * @exception MWException when $rc_id, $rev_id and $log_id are all null
+ */
static function addTags( $tags, $rc_id = null, $rev_id = null, $log_id = null, $params = null ) {
if ( !is_array( $tags ) ) {
$tags = array( $tags );
* Applies all tags-related changes to a query.
* Handles selecting tags, and filtering.
* Needs $tables to be set up properly, so we can figure out which join conditions to use.
+ *
+ * @param $tables String|Array: Tabel names, see DatabaseBase::select
+ * @param $fields String|Array: Fields used in query, see DatabaseBase::select
+ * @param $conds String|Array: conditions used in query, see DatabaseBase::select
+ * @param $join_conds Array: join conditions, see DatabaseBase::select
+ * @param $options Array: options, see Database::select
+ * @param $filter_tag String: tag to select on
+ *
+ * @exception MWException when unable to determine appropriate JOIN condition for tagging
+ *
*/
static function modifyDisplayQuery( &$tables, &$fields, &$conds,
&$join_conds, &$options, $filter_tag = false ) {
}
// Figure out which conditions can be done.
- $join_field = '';
if ( in_array( 'recentchanges', $tables ) ) {
$join_cond = 'rc_id';
} elseif( in_array( 'logging', $tables ) ) {
}
/**
- * If $fullForm is set to false, then it returns an array of (label, form).
- * If $fullForm is true, it returns an entire form.
+ * Build a text box to select a change tag
+ *
+ * @param $selected String: tag to select by default
+ * @param $fullForm Boolean:
+ * - if false, then it returns an array of (label, form).
+ * - if true, it returns an entire form around the selector.
+ * @param $title Title object to send the form to.
+ * Used when, and only when $fullForm is true.
+ * @return String or array:
+ * - if $fullForm is false: Array with
+ * - if $fullForm is true: String, html fragment
*/
- static function buildTagFilterSelector( $selected='', $fullForm = false /* used to put a full form around the selector */ ) {
+ public static function buildTagFilterSelector( $selected='', $fullForm = false, Title $title = null ) {
global $wgUseTagFilter;
if ( !$wgUseTagFilter || !count( self::listDefinedTags() ) )
return $fullForm ? '' : array();
- global $wgTitle;
-
- $data = array( wfMsgExt( 'tag-filter', 'parseinline' ), Xml::input( 'tagfilter', 20, $selected ) );
+ $data = array( Html::rawElement( 'label', array( 'for' => 'tagfilter' ), wfMsgExt( 'tag-filter', 'parseinline' ) ),
+ Xml::input( 'tagfilter', 20, $selected ) );
if ( !$fullForm ) {
return $data;
$html = implode( ' ', $data );
$html .= "\n" . Xml::element( 'input', array( 'type' => 'submit', 'value' => wfMsg( 'tag-filter-submit' ) ) );
- $html .= "\n" . Xml::hidden( 'title', $wgTitle-> getPrefixedText() );
- $html = Xml::tags( 'form', array( 'action' => $wgTitle->getLocalURL(), 'method' => 'get' ), $html );
+ $html .= "\n" . Html::hidden( 'title', $title->getPrefixedText() );
+ $html = Xml::tags( 'form', array( 'action' => $title->getLocalURL(), 'method' => 'get' ), $html );
return $html;
}
- /** Basically lists defined tags which count even if they aren't applied to anything */
+ /**
+ * Basically lists defined tags which count even if they aren't applied to anything.
+ * Tags on items in table 'change_tag' which are not (or no longer) in table 'valid_tag'
+ * are not included.
+ *
+ * Tries memcached first.
+ *
+ * @return Array of strings: tags
+ */
static function listDefinedTags() {
// Caching...
global $wgMemc;
$key = wfMemcKey( 'valid-tags' );
-
- if ( $tags = $wgMemc->get( $key ) )
+ $tags = $wgMemc->get( $key );
+ if ( $tags ) {
return $tags;
+ }
$emptyTags = array();
// Some DB stuff
$dbr = wfGetDB( DB_SLAVE );
$res = $dbr->select( 'valid_tag', 'vt_tag', array(), __METHOD__ );
- while( $row = $res->fetchObject() ) {
+ foreach ( $res as $row ) {
$emptyTags[] = $row->vt_tag;
}
dépôts / lhc / web / wiklou.git / blobdiff