Merge branch 'master' of git.gnu.io:gnu/gnu-social into mmn_fixes

[quix0rs-gnu-social.git] / extlib / HTMLPurifier / HTMLPurifier / PropertyList.php

diff --git a/extlib/HTMLPurifier/HTMLPurifier/PropertyList.php b/extlib/HTMLPurifier/HTMLPurifier/PropertyList.php
index 2b99fb7bc3caffe0a8c8439199e05ae1930aea21..189348fd9ec97287ec7272f4be962b4ca7318068 100644 (file)
--- a/extlib/HTMLPurifier/HTMLPurifier/PropertyList.php
+++ b/extlib/HTMLPurifier/HTMLPurifier/PropertyList.php
@@ -6,61 +6,93 @@
 class HTMLPurifier_PropertyList
 {
     /**
-     * Internal data-structure for properties
+     * Internal data-structure for properties.
+     * @type array
      */
     protected $data = array();
 
     /**
-     * Parent plist
+     * Parent plist.
+     * @type HTMLPurifier_PropertyList
      */
     protected $parent;
 
+    /**
+     * Cache.
+     * @type array
+     */
     protected $cache;
 
-    public function __construct($parent = null) {
+    /**
+     * @param HTMLPurifier_PropertyList $parent Parent plist
+     */
+    public function __construct($parent = null)
+    {
         $this->parent = $parent;
     }
 
     /**
      * Recursively retrieves the value for a key
+     * @param string $name
+     * @throws HTMLPurifier_Exception
      */
-    public function get($name) {
-        if ($this->has($name)) return $this->data[$name];
+    public function get($name)
+    {
+        if ($this->has($name)) {
+            return $this->data[$name];
+        }
         // possible performance bottleneck, convert to iterative if necessary
-        if ($this->parent) return $this->parent->get($name);
+        if ($this->parent) {
+            return $this->parent->get($name);
+        }
         throw new HTMLPurifier_Exception("Key '$name' not found");
     }
 
     /**
      * Sets the value of a key, for this plist
+     * @param string $name
+     * @param mixed $value
      */
-    public function set($name, $value) {
+    public function set($name, $value)
+    {
         $this->data[$name] = $value;
     }
 
     /**
      * Returns true if a given key exists
+     * @param string $name
+     * @return bool
      */
-    public function has($name) {
+    public function has($name)
+    {
         return array_key_exists($name, $this->data);
     }
 
     /**
      * Resets a value to the value of it's parent, usually the default. If
      * no value is specified, the entire plist is reset.
+     * @param string $name
      */
-    public function reset($name = null) {
-        if ($name == null) $this->data = array();
-        else unset($this->data[$name]);
+    public function reset($name = null)
+    {
+        if ($name == null) {
+            $this->data = array();
+        } else {
+            unset($this->data[$name]);
+        }
     }
 
     /**
      * Squashes this property list and all of its property lists into a single
      * array, and returns the array. This value is cached by default.
-     * @param $force If true, ignores the cache and regenerates the array.
+     * @param bool $force If true, ignores the cache and regenerates the array.
+     * @return array
      */
-    public function squash($force = false) {
-        if ($this->cache !== null && !$force) return $this->cache;
+    public function squash($force = false)
+    {
+        if ($this->cache !== null && !$force) {
+            return $this->cache;
+        }
         if ($this->parent) {
             return $this->cache = array_merge($this->parent->squash($force), $this->data);
         } else {
@@ -70,15 +102,19 @@ class HTMLPurifier_PropertyList
 
     /**
      * Returns the parent plist.
+     * @return HTMLPurifier_PropertyList
      */
-    public function getParent() {
+    public function getParent()
+    {
         return $this->parent;
     }
 
     /**
      * Sets the parent plist.
+     * @param HTMLPurifier_PropertyList $plist Parent plist
      */
-    public function setParent($plist) {
+    public function setParent($plist)
+    {
         $this->parent = $plist;
     }
 }