From 85e4c16f39a8b00b229644bcd175663541dfd51a Mon Sep 17 00:00:00 2001
From: Steve Clay <steve@mrclay.org>
Date: Mon, 4 Feb 2013 20:37:25 -0500
Subject: Doc fixes and inline type hints for variables (big static analysis
 cleanup)

---
 engine/classes/ElggFileCache.php | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'engine/classes/ElggFileCache.php')

diff --git a/engine/classes/ElggFileCache.php b/engine/classes/ElggFileCache.php
index 34178d452..e654f1db2 100644
--- a/engine/classes/ElggFileCache.php
+++ b/engine/classes/ElggFileCache.php
@@ -13,6 +13,8 @@ class ElggFileCache extends ElggCache {
 	 * @param string $cache_path The cache path.
 	 * @param int    $max_age    Maximum age in seconds, 0 if no limit.
 	 * @param int    $max_size   Maximum size of cache in seconds, 0 if no limit.
+	 *
+	 * @throws ConfigurationException
 	 */
 	function __construct($cache_path, $max_age = 0, $max_size = 0) {
 		$this->setVariable("cache_path", $cache_path);
-- 
cgit v1.2.3


From ea4ce20b3632a3c55ffedfad1ad53845db5a7e12 Mon Sep 17 00:00:00 2001
From: cash <cash.costello@gmail.com>
Date: Sat, 16 Mar 2013 12:03:21 -0400
Subject: coding standards

---
 engine/classes/ElggAccess.php     | 4 ++++
 engine/classes/ElggCache.php      | 4 ++++
 engine/classes/ElggData.php       | 2 ++
 engine/classes/ElggFileCache.php  | 4 ++++
 engine/classes/ElggXMLElement.php | 8 ++++++++
 5 files changed, 22 insertions(+)

(limited to 'engine/classes/ElggFileCache.php')

diff --git a/engine/classes/ElggAccess.php b/engine/classes/ElggAccess.php
index 6f8d9bb4b..0aed477fc 100644
--- a/engine/classes/ElggAccess.php
+++ b/engine/classes/ElggAccess.php
@@ -16,6 +16,7 @@ class ElggAccess {
 	 */
 	private $ignore_access;
 
+	// @codingStandardsIgnoreStart
 	/**
 	 * Get current ignore access setting.
 	 *
@@ -26,6 +27,7 @@ class ElggAccess {
 		elgg_deprecated_notice('ElggAccess::get_ignore_access() is deprecated by ElggAccess::getIgnoreAccess()', 1.8);
 		return $this->getIgnoreAccess();
 	}
+	// @codingStandardsIgnoreEnd
 
 	/**
 	 * Get current ignore access setting.
@@ -36,6 +38,7 @@ class ElggAccess {
 		return $this->ignore_access;
 	}
 
+	// @codingStandardsIgnoreStart
 	/**
 	 * Set ignore access.
 	 *
@@ -49,6 +52,7 @@ class ElggAccess {
 		elgg_deprecated_notice('ElggAccess::set_ignore_access() is deprecated by ElggAccess::setIgnoreAccess()', 1.8);
 		return $this->setIgnoreAccess($ignore);
 	}
+	// @codingStandardsIgnoreEnd
 
 	/**
 	 * Set ignore access.
diff --git a/engine/classes/ElggCache.php b/engine/classes/ElggCache.php
index 4317f4be9..909eab39b 100644
--- a/engine/classes/ElggCache.php
+++ b/engine/classes/ElggCache.php
@@ -21,6 +21,7 @@ abstract class ElggCache implements ArrayAccess {
 		$this->variables = array();
 	}
 
+	// @codingStandardsIgnoreStart
 	/**
 	 * Set a cache variable.
 	 *
@@ -35,6 +36,7 @@ abstract class ElggCache implements ArrayAccess {
 		elgg_deprecated_notice('ElggCache::set_variable() is deprecated by ElggCache::setVariable()', 1.8);
 		$this->setVariable($variable, $value);
 	}
+	// @codingStandardsIgnoreEnd
 
 	/**
 	 * Set a cache variable.
@@ -52,6 +54,7 @@ abstract class ElggCache implements ArrayAccess {
 		$this->variables[$variable] = $value;
 	}
 
+	// @codingStandardsIgnoreStart
 	/**
 	 * Get variables for this cache.
 	 *
@@ -65,6 +68,7 @@ abstract class ElggCache implements ArrayAccess {
 		elgg_deprecated_notice('ElggCache::get_variable() is deprecated by ElggCache::getVariable()', 1.8);
 		return $this->getVariable($variable);
 	}
+	// @codingStandardsIgnoreEnd
 
 	/**
 	 * Get variables for this cache.
diff --git a/engine/classes/ElggData.php b/engine/classes/ElggData.php
index 426248ca3..4f843cde4 100644
--- a/engine/classes/ElggData.php
+++ b/engine/classes/ElggData.php
@@ -26,6 +26,7 @@ abstract class ElggData implements
 	 */
 	protected $attributes = array();
 
+	// @codingStandardsIgnoreStart
 	/**
 	 * Initialise the attributes array.
 	 *
@@ -44,6 +45,7 @@ abstract class ElggData implements
 			elgg_deprecated_notice('initialise_attributes() is deprecated by initializeAttributes()', 1.8);
 		}
 	}
+	// @codingStandardsIgnoreEnd
 
 	/**
 	 * Initialize the attributes array.
diff --git a/engine/classes/ElggFileCache.php b/engine/classes/ElggFileCache.php
index e654f1db2..94143f777 100644
--- a/engine/classes/ElggFileCache.php
+++ b/engine/classes/ElggFileCache.php
@@ -26,6 +26,7 @@ class ElggFileCache extends ElggCache {
 		}
 	}
 
+	// @codingStandardsIgnoreStart
 	/**
 	 * Create and return a handle to a file.
 	 *
@@ -41,6 +42,7 @@ class ElggFileCache extends ElggCache {
 
 		return $this->createFile($filename, $rw);
 	}
+	// @codingStandardsIgnoreEnd
 
 	/**
 	 * Create and return a handle to a file.
@@ -72,6 +74,7 @@ class ElggFileCache extends ElggCache {
 		return fopen($path . $filename, $rw);
 	}
 
+	// @codingStandardsIgnoreStart
 	/**
 	 * Create a sanitised filename for the file.
 	 *
@@ -86,6 +89,7 @@ class ElggFileCache extends ElggCache {
 
 		return $filename;
 	}
+	// @codingStandardsIgnoreEnd
 
 	/**
 	 * Create a sanitised filename for the file.
diff --git a/engine/classes/ElggXMLElement.php b/engine/classes/ElggXMLElement.php
index 4e4b7e63c..d7e912035 100644
--- a/engine/classes/ElggXMLElement.php
+++ b/engine/classes/ElggXMLElement.php
@@ -76,6 +76,10 @@ class ElggXMLElement {
 		return $result;
 	}
 
+	/**
+	 * @param string $name Property name
+	 * @return mixed
+	 */
 	function __get($name) {
 		switch ($name) {
 			case 'name':
@@ -94,6 +98,10 @@ class ElggXMLElement {
 		return null;
 	}
 
+	/**
+	 * @param string $name Property name
+	 * @return boolean
+	 */
 	function __isset($name) {
 		switch ($name) {
 			case 'name':
-- 
cgit v1.2.3