From: Thiemo Mättig <thiemo.maettig@wikimedia.de>
Date: Fri, 27 Mar 2015 08:58:58 +0000 (+0100)
Subject: Set parameter default to array() in WebResponse::setcookie()
X-Git-Tag: 1.31.0-rc.0~11971^2
X-Git-Url: https://git.cyclocoop.org/%27.%24link.%27?a=commitdiff_plain;h=53e6c5b237d22a61c4101e62f4635bd3a07e446e;p=lhc%2Fweb%2Fwiklou.git

Set parameter default to array() in WebResponse::setcookie()

This is a direct follow-up for the question raised in Ifab16c2.
Null is not a meaningful value in this case. As far as I can see the
only reason it was added was to make the parameter optional. Optional
array parameters are better marked with "= array()".

Change-Id: I86965d390fdb718de7fb81a9f4c48b2261c16aa9
---

diff --git a/includes/WebResponse.php b/includes/WebResponse.php
index 83ac51a341..ab34931c2c 100644
--- a/includes/WebResponse.php
+++ b/includes/WebResponse.php
@@ -60,7 +60,7 @@ class WebResponse {
 	 * @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.
-	 * @param array|null $options Assoc of additional cookie options:
+	 * @param array $options Assoc of additional cookie options:
 	 *     prefix: string, name prefix ($wgCookiePrefix)
 	 *     domain: string, cookie domain ($wgCookieDomain)
 	 *     path: string, cookie path ($wgCookiePath)
@@ -72,7 +72,7 @@ class WebResponse {
 	 *   'prefix', 'domain', and 'secure'
 	 * @since 1.22 Replaced $prefix, $domain, and $forceSecure with $options
 	 */
-	public function setcookie( $name, $value, $expire = 0, $options = null ) {
+	public function setcookie( $name, $value, $expire = 0, $options = array() ) {
 		global $wgCookiePath, $wgCookiePrefix, $wgCookieDomain;
 		global $wgCookieSecure, $wgCookieExpiration, $wgCookieHttpOnly;
 
@@ -188,9 +188,9 @@ class FauxResponse extends WebResponse {
 	 * @param string $name The name of the cookie.
 	 * @param string $value The value to be stored in the cookie.
 	 * @param int|null $expire Ignored in this faux subclass.
-	 * @param array|null $options Ignored in this faux subclass.
+	 * @param array $options Ignored in this faux subclass.
 	 */
-	public function setcookie( $name, $value, $expire = 0, $options = null ) {
+	public function setcookie( $name, $value, $expire = 0, $options = array() ) {
 		$this->cookies[$name] = $value;
 	}