/**
* Output a HTTP header, wrapper for PHP's header()
- * @param string $string header to output
- * @param bool $replace replace current similar header
+ * @param string $string Header to output
+ * @param bool $replace Replace current similar header
* @param null|int $http_response_code Forces the HTTP response code to the specified value.
*/
public function header( $string, $replace = true, $http_response_code = null ) {
/**
* Set the browser cookie
- * @param string $name name of cookie
- * @param string $value value to give cookie
+ * @param string $name Name of cookie
+ * @param string $value Value to give cookie
* @param int|null $expire Unix timestamp (in seconds) when the cookie should expire.
* 0 (the default) causes it to expire $wgCookieExpiration seconds from now.
* null causes it to be a session cookie.
* secure: bool, secure attribute ($wgCookieSecure)
* httpOnly: bool, httpOnly attribute ($wgCookieHttpOnly)
* raw: bool, if true uses PHP's setrawcookie() instead of setcookie()
- * For backwards compatability, if $options is not an array then it and
+ * For backwards compatibility, if $options is not an array then it and
* the following two parameters will be interpreted as values for
* 'prefix', 'domain', and 'secure'
* @since 1.22 Replaced $prefix, $domain, and $forceSecure with $options
global $wgCookieSecure, $wgCookieExpiration, $wgCookieHttpOnly;
if ( !is_array( $options ) ) {
- // Backwards compatability
+ // Backwards compatibility
$options = array( 'prefix' => $options );
if ( func_num_args() >= 5 ) {
$options['domain'] = func_get_arg( 4 );
/**
* Stores a HTTP header
- * @param string $string header to output
- * @param bool $replace replace current similar header
+ * @param string $string Header to output
+ * @param bool $replace Replace current similar header
* @param null|int $http_response_code Forces the HTTP response code to the specified value.
*/
public function header( $string, $replace = true, $http_response_code = null ) {
/**
* @todo document. It just ignore optional parameters.
*
- * @param string $name name of cookie
- * @param string $value value to give cookie
- * @param int $expire number of seconds til cookie expires (Default: 0)
- * @param array $options ignored
+ * @param string $name Name of cookie
+ * @param string $value Value to give cookie
+ * @param int $expire Number of seconds til cookie expires (Default: 0)
+ * @param array $options Ignored
*/
public function setcookie( $name, $value, $expire = 0, $options = null ) {
$this->cookies[$name] = $value;