| Index: trunk/phase3/includes/objectcache/MemcachedPhpBagOStuff.php |
| — | — | @@ -20,6 +20,8 @@ |
| 21 | 21 | * - compress_threshold: The minimum size an object must be before it is compressed |
| 22 | 22 | * - timeout: The read timeout in microseconds |
| 23 | 23 | * - connect_timeout: The connect timeout in seconds |
| | 24 | + * |
| | 25 | + * @params $params array |
| 24 | 26 | */ |
| 25 | 27 | function __construct( $params ) { |
| 26 | 28 | if ( !isset( $params['servers'] ) ) { |
| Index: trunk/phase3/includes/SquidPurgeClient.php |
| — | — | @@ -139,6 +139,8 @@ |
| 140 | 140 | |
| 141 | 141 | /** |
| 142 | 142 | * Queue a purge operation |
| | 143 | + * |
| | 144 | + * @param $url string |
| 143 | 145 | */ |
| 144 | 146 | public function queuePurge( $url ) { |
| 145 | 147 | $url = str_replace( "\n", '', $url ); |
| — | — | @@ -151,6 +153,9 @@ |
| 152 | 154 | } |
| 153 | 155 | } |
| 154 | 156 | |
| | 157 | + /** |
| | 158 | + * @return bool |
| | 159 | + */ |
| 155 | 160 | public function isIdle() { |
| 156 | 161 | return strlen( $this->writeBuffer ) == 0 && $this->readState == 'idle'; |
| 157 | 162 | } |
| Index: trunk/phase3/includes/Cdb.php |
| — | — | @@ -13,6 +13,10 @@ |
| 14 | 14 | abstract class CdbReader { |
| 15 | 15 | /** |
| 16 | 16 | * Open a file and return a subclass instance |
| | 17 | + * |
| | 18 | + * @param $fileName string |
| | 19 | + * |
| | 20 | + * @return CdbReader |
| 17 | 21 | */ |
| 18 | 22 | public static function open( $fileName ) { |
| 19 | 23 | if ( self::haveExtension() ) { |
| — | — | @@ -25,6 +29,8 @@ |
| 26 | 30 | |
| 27 | 31 | /** |
| 28 | 32 | * Returns true if the native extension is available |
| | 33 | + * |
| | 34 | + * @return bool |
| 29 | 35 | */ |
| 30 | 36 | public static function haveExtension() { |
| 31 | 37 | if ( !function_exists( 'dba_handlers' ) ) { |
| — | — | @@ -61,6 +67,10 @@ |
| 62 | 68 | /** |
| 63 | 69 | * Open a writer and return a subclass instance. |
| 64 | 70 | * The user must have write access to the directory, for temporary file creation. |
| | 71 | + * |
| | 72 | + * @param $fileName string |
| | 73 | + * |
| | 74 | + * @return bool |
| 65 | 75 | */ |
| 66 | 76 | public static function open( $fileName ) { |
| 67 | 77 | if ( CdbReader::haveExtension() ) { |
| Index: trunk/phase3/includes/cache/LinkCache.php |
| — | — | @@ -14,6 +14,8 @@ |
| 15 | 15 | |
| 16 | 16 | /** |
| 17 | 17 | * Get an instance of this class |
| | 18 | + * |
| | 19 | + * @return LinkCache |
| 18 | 20 | */ |
| 19 | 21 | static function &singleton() { |
| 20 | 22 | static $instance; |
| Index: trunk/phase3/includes/cache/MessageCache.php |
| — | — | @@ -64,6 +64,8 @@ |
| 65 | 65 | |
| 66 | 66 | /** |
| 67 | 67 | * Singleton instance |
| | 68 | + * |
| | 69 | + * @var MessageCache |
| 68 | 70 | */ |
| 69 | 71 | private static $instance; |
| 70 | 72 | |
| Index: trunk/phase3/includes/cache/SquidUpdate.php |
| — | — | @@ -25,6 +25,11 @@ |
| 26 | 26 | $this->urlArr = $urlArr; |
| 27 | 27 | } |
| 28 | 28 | |
| | 29 | + /** |
| | 30 | + * @param $title Title |
| | 31 | + * |
| | 32 | + * @return SquidUpdate |
| | 33 | + */ |
| 29 | 34 | static function newFromLinksTo( &$title ) { |
| 30 | 35 | global $wgMaxSquidPurgeTitles; |
| 31 | 36 | wfProfileIn( __METHOD__ ); |
| — | — | @@ -52,6 +57,11 @@ |
| 53 | 58 | |
| 54 | 59 | /** |
| 55 | 60 | * Create a SquidUpdate from an array of Title objects, or a TitleArray object |
| | 61 | + * |
| | 62 | + * @param $titles array |
| | 63 | + * @param $urlArr array |
| | 64 | + * |
| | 65 | + * @return SquidUpdate |
| 56 | 66 | */ |
| 57 | 67 | static function newFromTitles( $titles, $urlArr = array() ) { |
| 58 | 68 | global $wgMaxSquidPurgeTitles; |
| — | — | @@ -65,6 +75,11 @@ |
| 66 | 76 | return new SquidUpdate( $urlArr ); |
| 67 | 77 | } |
| 68 | 78 | |
| | 79 | + /** |
| | 80 | + * @param $title Title |
| | 81 | + * |
| | 82 | + * @return SquidUpdate |
| | 83 | + */ |
| 69 | 84 | static function newSimplePurge( &$title ) { |
| 70 | 85 | $urlArr = $title->getSquidURLs(); |
| 71 | 86 | return new SquidUpdate( $urlArr ); |
| — | — | @@ -74,11 +89,15 @@ |
| 75 | 90 | SquidUpdate::purge( $this->urlArr ); |
| 76 | 91 | } |
| 77 | 92 | |
| 78 | | - /* Purges a list of Squids defined in $wgSquidServers. |
| 79 | | - $urlArr should contain the full URLs to purge as values |
| 80 | | - (example: $urlArr[] = 'http://my.host/something') |
| 81 | | - XXX report broken Squids per mail or log */ |
| 82 | | - |
| | 93 | + /** |
| | 94 | + * Purges a list of Squids defined in $wgSquidServers. |
| | 95 | + * $urlArr should contain the full URLs to purge as values |
| | 96 | + * (example: $urlArr[] = 'http://my.host/something') |
| | 97 | + * XXX report broken Squids per mail or log |
| | 98 | + * |
| | 99 | + * @param $urlArr array |
| | 100 | + * @return void |
| | 101 | + */ |
| 83 | 102 | static function purge( $urlArr ) { |
| 84 | 103 | global $wgSquidServers, $wgHTCPMulticastAddress, $wgHTCPPort; |
| 85 | 104 | |
| — | — | @@ -124,7 +143,7 @@ |
| 125 | 144 | global $wgHTCPMulticastAddress, $wgHTCPMulticastTTL, $wgHTCPPort; |
| 126 | 145 | wfProfileIn( __METHOD__ ); |
| 127 | 146 | |
| 128 | | - $htcpOpCLR = 4; // HTCP CLR |
| | 147 | + $htcpOpCLR = 4; // HTCP CLR |
| 129 | 148 | |
| 130 | 149 | // FIXME PHP doesn't support these socket constants (include/linux/in.h) |
| 131 | 150 | if( !defined( "IPPROTO_IP" ) ) { |
| — | — | @@ -190,6 +209,8 @@ |
| 191 | 210 | * |
| 192 | 211 | * Client functions should not need to call this. |
| 193 | 212 | * |
| | 213 | + * @param $url string |
| | 214 | + * |
| 194 | 215 | * @return string |
| 195 | 216 | */ |
| 196 | 217 | static function expand( $url ) { |