* Some globals and requires needed
*/
+/**
+ * Total number of articles
+ * @global integer $wgNumberOfArticles
+ */
$wgNumberOfArticles = -1; # Unset
+/**
+ * Total number of views
+ * @global integer $wgTotalViews
+ */
$wgTotalViews = -1;
+/**
+ * Total number of edits
+ * @global integer $wgTotalEdits
+ */
$wgTotalEdits = -1;
require_once( 'DatabaseFunctions.php' );
/**
* html_entity_decode exists in PHP 4.3.0+ but is FATALLY BROKEN even then,
* with no UTF-8 support.
+ *
+ * @param string $string String having html entities
+ * @param $quote_style
+ * @param string $charset Encoding set to use (default 'ISO-8859-1')
*/
function do_html_entity_decode( $string, $quote_style=ENT_COMPAT, $charset='ISO-8859-1' ) {
static $trans;
return strtr( $string, $trans );
}
+
+/**
+ * Where as we got a random seed
+ * @var bool $wgTotalViews
+ */
$wgRandomSeeded = false;
/**
* Seed Mersenne Twister
* Only necessary in PHP < 4.2.0
+ *
+ * @return bool
*/
-function wfSeedRandom()
-{
+function wfSeedRandom() {
global $wgRandomSeeded;
if ( ! $wgRandomSeeded && version_compare( phpversion(), '4.2.0' ) < 0 ) {
/**
* Generates a URL from a URL-encoded title and a query string
* Title::getLocalURL() is preferred in most cases
+ *
+ * @param string $a URL encoded title
+ * @param string $q URL (default '')
*/
-function wfLocalUrl( $a, $q = '' )
-{
+function wfLocalUrl( $a, $q = '' ) {
global $wgServer, $wgScript, $wgArticlePath;
$a = str_replace( ' ', '_', $a );
/**
* @todo document
+ * @param string $a URL encoded title
+ * @param string $q URL (default '')
*/
function wfLocalUrlE( $a, $q = '' )
{
/**
* We want / and : to be included as literal characters in our title URLs.
* %2F in the page titles seems to fatally break for some reason.
+ *
+ * @param string $s
+ * @return string
*/
-function wfUrlencode ( $s )
-{
+function wfUrlencode ( $s ) {
$s = urlencode( $s );
$s = preg_replace( '/%3[Aa]/', ':', $s );
$s = preg_replace( '/%2[Ff]/', '/', $s );
/**
* Return the UTF-8 sequence for a given Unicode code point.
* Currently doesn't work for values outside the Basic Multilingual Plane.
-*/
+ *
+ * @param string $codepoint UTF-8 code point.
+ * @return string HTML UTF-8 Entitie such as 'Ӓ'.
+ */
function wfUtf8Sequence( $codepoint ) {
if($codepoint < 0x80) return chr($codepoint);
if($codepoint < 0x800) return chr($codepoint >> 6 & 0x3f | 0xc0) .
/**
* Converts numeric character entities to UTF-8
+ *
+ * @param string $string String to convert.
+ * @return string Converted string.
*/
function wfMungeToUtf8( $string ) {
global $wgInputEncoding; # This is debatable
/**
* Converts a single UTF-8 character into the corresponding HTML character
* entity (for use with preg_replace_callback)
+ *
+ * @param array $matches
+ *
*/
function wfUtf8Entity( $matches ) {
$char = $matches[0];
/**
* @todo document
*/
-function wfDebug( $text, $logonly = false )
-{
+function wfDebug( $text, $logonly = false ) {
global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage;
# Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
/**
* Log for database errors
+ * @param string $text Database error message.
*/
function wfLogDBError( $text ) {
global $wgDBerrorLog;
/**
* @todo document
*/
-function logProfilingData()
-{
+function logProfilingData() {
global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser;
$now = wfTime();
* Check if the wiki read-only lock file is present. This can be used to lock
* off editing functions, but doesn't guarantee that the database will not be
* modified.
+ * @return bool
*/
function wfReadOnly() {
global $wgReadOnlyFile;
return is_file( $wgReadOnlyFile );
}
+/**
+ * Keys strings for replacement
+ * @global array $wgReplacementKeys
+ */
$wgReplacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' );
/**
}
/**
+ * Die with a backtrace
* This is meant as a debugging aid to track down where bad data comes from.
* Shouldn't be used in production code except maybe in "shouldn't happen" areas.
+ *
+ * @param string $msg Message shown when dieing.
*/
function wfDebugDieBacktrace( $msg = '' ) {
global $wgCommandLineMode;
/* Some generic result counters, pulled out of SearchEngine */
-function wfShowingResults( $offset, $limit )
-{
+
+/**
+ * @todo document
+ */
+function wfShowingResults( $offset, $limit ) {
global $wgLang;
return wfMsg( 'showingresults', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ) );
}
-function wfShowingResultsNum( $offset, $limit, $num )
-{
+/**
+ * @todo document
+ */
+function wfShowingResultsNum( $offset, $limit, $num ) {
global $wgLang;
return wfMsg( 'showingresultsnum', $wgLang->formatNum( $limit ), $wgLang->formatNum( $offset+1 ), $wgLang->formatNum( $num ) );
}
-function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false )
-{
+/**
+ * @todo document
+ */
+function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
global $wgUser, $wgLang;
$fmtLimit = $wgLang->formatNum( $limit );
$prev = wfMsg( 'prevn', $fmtLimit );
return wfMsg( 'viewprevnext', $plink, $nlink, $nums );
}
-function wfNumLink( $offset, $limit, $link, $query = '' )
-{
+/**
+ * @todo document
+ */
+function wfNumLink( $offset, $limit, $link, $query = '' ) {
global $wgUser, $wgLang;
if ( '' == $query ) { $q = ''; }
else { $q = $query.'&'; }
return $s;
}
+/**
+ * @todo document
+ * @todo FIXME: we may want to blacklist some broken browsers
+ *
+ * @return bool Whereas client accept gzip compression
+ */
function wfClientAcceptsGzip() {
global $wgUseGzip;
if( $wgUseGzip ) {
* As required by the callers, <nowiki> is not used. It currently does
* not filter out characters which have special meaning only at the
* start of a line, such as "*".
+ *
+ * @param string $text Text to be escaped
*/
-function wfEscapeWikiText( $text )
-{
+function wfEscapeWikiText( $text ) {
$text = str_replace(
array( '[', '|', "'", 'ISBN ' , '://' , "\n=", '{{' ),
array( '[', '|', ''', 'ISBN ', '://' , "\n=", '{{' ),
return $text;
}
-function wfQuotedPrintable( $string, $charset = '' )
-{
+/**
+ * @todo document
+ */
+function wfQuotedPrintable( $string, $charset = '' ) {
# Probably incomplete; see RFC 2045
if( empty( $charset ) ) {
global $wgInputEncoding;
return $out;
}
-function wfTime(){
+/**
+ * @todo document
+ * @return float
+ */
+function wfTime() {
$st = explode( ' ', microtime() );
return (float)$st[0] + (float)$st[1];
}
* Sets dest to source and returns the original value of dest
* If source is NULL, it just returns the value, it doesn't set the variable
*/
-function wfSetVar( &$dest, $source )
-{
+function wfSetVar( &$dest, $source ) {
$temp = $dest;
if ( !is_null( $source ) ) {
$dest = $source;
* Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
* function puts single quotes in regardless of OS
*/
-function wfEscapeShellArg( )
-{
+function wfEscapeShellArg( ) {
$args = func_get_args();
$first = true;
$retVal = '';
/**
* @todo document
*/
-function wfVarDump( $var )
-{
+function wfVarDump( $var ) {
global $wgOut;
$s = str_replace("\n","<br>\n", var_export( $var, true ) . "\n");
if ( headers_sent() || !@is_object( $wgOut ) ) {
* Array lookup
* Returns an array where the values in the first array are replaced by the
* values in the second array with the corresponding keys
+ *
+ * @return array
*/
-function wfArrayLookup( $a, $b )
-{
+function wfArrayLookup( $a, $b ) {
return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
}
(int)substr( $ts, 0, 4 ) );
}
+/**
+ * @todo document
+ */
function wfUnix2Timestamp( $unixtime ) {
return gmdate( 'YmdHis', $unixtime );
}
+/**
+ * @todo document
+ */
function wfTimestampNow() {
# return NOW
return gmdate( 'YmdHis' );
}
# Autodetect, convert and provide timestamps of various types
-define('TS_UNIX',0); # Standard unix timestamp (number of seconds since 1 Jan 1970)
-define('TS_MW',1); # Mediawiki concatenated string timestamp (yyyymmddhhmmss)
-define('TS_DB',2); # Standard database timestamp (yyyy-mm-dd hh:mm:ss)
+
+/** Standard unix timestamp (number of seconds since 1 Jan 1970) */
+define('TS_UNIX',0);
+/** Mediawiki concatenated string timestamp (yyyymmddhhmmss) */
+define('TS_MW',1);
+/** Standard database timestamp (yyyy-mm-dd hh:mm:ss) */
+define('TS_DB',2);
/**
* @todo document
}
/**
+ * Check where as the operating system is Windows
+ *
* @todo document
+ * @return bool True if it's windows, False otherwise.
*/
function wfIsWindows() {
if (substr(php_uname(), 0, 7) == 'Windows') {
dépôts / lhc / web / wiklou.git / commitdiff