http://www.mediawiki.org/wiki/Special:Code/MediaWiki/88540
Revision: 88540
Author: reedy
Date: 2011-05-21 19:54:24 +0000 (Sat, 21 May 2011)
Log Message:
-----------
More documentation tweaks and updates
Modified Paths:
--------------
trunk/phase3/includes/LogPage.php
trunk/phase3/includes/MacBinary.php
trunk/phase3/includes/RawPage.php
trunk/phase3/includes/SquidPurgeClient.php
trunk/phase3/includes/StringUtils.php
Modified: trunk/phase3/includes/LogPage.php
===================================================================
--- trunk/phase3/includes/LogPage.php 2011-05-21 19:53:07 UTC (rev 88539)
+++ trunk/phase3/includes/LogPage.php 2011-05-21 19:54:24 UTC (rev 88540)
@@ -56,6 +56,9 @@
$this->sendToUDP = ( $udp == 'UDP' );
}
+ /**
+ * @return bool|int|null
+ */
protected function saveContent() {
global $wgLogRestrictions;
Modified: trunk/phase3/includes/MacBinary.php
===================================================================
--- trunk/phase3/includes/MacBinary.php 2011-05-21 19:53:07 UTC (rev 88539)
+++ trunk/phase3/includes/MacBinary.php 2011-05-21 19:54:24 UTC (rev 88540)
@@ -31,6 +31,8 @@
$this->loadHeader();
}
+ private $valid, $version, $filename, $dataLength, $resourceLength,
$handle;
+
/**
* The file must be seekable, such as local filesystem.
* Remote URLs probably won't work.
Modified: trunk/phase3/includes/RawPage.php
===================================================================
--- trunk/phase3/includes/RawPage.php 2011-05-21 19:53:07 UTC (rev 88539)
+++ trunk/phase3/includes/RawPage.php 2011-05-21 19:54:24 UTC (rev 88540)
@@ -223,6 +223,10 @@
return $this->parseArticleText( $text );
}
+ /**
+ * @param $text
+ * @return string
+ */
function parseArticleText( $text ) {
if( $text === '' ) {
return '';
Modified: trunk/phase3/includes/SquidPurgeClient.php
===================================================================
--- trunk/phase3/includes/SquidPurgeClient.php 2011-05-21 19:53:07 UTC (rev
88539)
+++ trunk/phase3/includes/SquidPurgeClient.php 2011-05-21 19:54:24 UTC (rev
88540)
@@ -33,6 +33,8 @@
/**
* Open a socket if there isn't one open already, return it.
* Returns false on error.
+ *
+ * @return false|resource
*/
protected function getSocket() {
if ( $this->socket !== null ) {
@@ -64,6 +66,7 @@
/**
* Get read socket array for select()
+ * @return array
*/
public function getReadSocketsForSelect() {
if ( $this->readState == 'idle' ) {
@@ -78,6 +81,7 @@
/**
* Get write socket array for select()
+ * @return array
*/
public function getWriteSocketsForSelect() {
if ( !strlen( $this->writeBuffer ) ) {
@@ -225,6 +229,10 @@
while ( $this->socket && $this->processReadBuffer() ===
'continue' );
}
+ /**
+ * @throws MWException
+ * @return string
+ */
protected function processReadBuffer() {
switch ( $this->readState ) {
case 'idle':
@@ -264,6 +272,10 @@
}
}
+ /**
+ * @param $line
+ * @return
+ */
protected function processStatusLine( $line ) {
if ( !preg_match( '!^HTTP/(\d+)\.(\d+) (\d{3}) (.*)$!', $line,
$m ) ) {
$this->log( 'invalid status line' );
@@ -280,6 +292,9 @@
$this->readState = 'header';
}
+ /**
+ * @param $line string
+ */
protected function processHeaderLine( $line ) {
if ( preg_match( '/^Content-Length: (\d+)$/i', $line, $m ) ) {
$this->bodyRemaining = intval( $m[1] );
Modified: trunk/phase3/includes/StringUtils.php
===================================================================
--- trunk/phase3/includes/StringUtils.php 2011-05-21 19:53:07 UTC (rev
88539)
+++ trunk/phase3/includes/StringUtils.php 2011-05-21 19:54:24 UTC (rev
88540)
@@ -13,6 +13,13 @@
* Compared to delimiterReplace(), this implementation is fast but
memory-
* hungry and inflexible. The memory requirements are such that I don't
* recommend using it on anything but guaranteed small chunks of text.
+ *
+ * @param $startDelim
+ * @param $endDelim
+ * @param $replace
+ * @param $subject
+ *
+ * @return string
*/
static function hungryDelimiterReplace( $startDelim, $endDelim,
$replace, $subject ) {
$segments = explode( $startDelim, $subject );
@@ -36,17 +43,19 @@
* This implementation is slower than hungryDelimiterReplace but uses
far less
* memory. The delimiters are literal strings, not regular expressions.
*
+ * If the start delimiter ends with an initial substring of the end
delimiter,
+ * e.g. in the case of C-style comments, the behaviour differs from the
model
+ * regex. In this implementation, the end must share no characters with
the
+ * start, so e.g. /*\/ is not considered to be both the start and end
of a
+ * comment. /*\/xy/*\/ is considered to be a single comment with
contents /xy/.
+ *
* @param $startDelim String: start delimiter
* @param $endDelim String: end delimiter
* @param $callback Callback: function to call on each match
* @param $subject String
* @param $flags String: regular expression flags
+ * @return string
*/
- # If the start delimiter ends with an initial substring of the end
delimiter,
- # e.g. in the case of C-style comments, the behaviour differs from the
model
- # regex. In this implementation, the end must share no characters with
the
- # start, so e.g. /*/ is not considered to be both the start and end of a
- # comment. /*/xy/*/ is considered to be a single comment with contents
/xy/.
static function delimiterReplaceCallback( $startDelim, $endDelim,
$callback, $subject, $flags = '' ) {
$inputPos = 0;
$outputPos = 0;
@@ -180,6 +189,9 @@
/**
* Workalike for explode() with limited memory usage.
* Returns an Iterator
+ * @param $separator
+ * @param $subject
+ * @return \ArrayIterator|\ExplodeIterator
*/
static function explode( $separator, $subject ) {
if ( substr_count( $subject, $separator ) > 1000 ) {
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
