zendframework/zendframework#6773 zendframework/zendframework#6768 - r…

…emoving redundant docblocks, cleaning up comparison operations syntax and simplifying code

src/PriorityList.php

@@ -12,9 +12,6 @@
 use Countable;
 use Iterator;
 
-/**
- * Priority list
- */
 class PriorityList implements Iterator, Countable
 {
     const EXTR_DATA     = 0x00000001;
@@ -23,7 +20,7 @@ class PriorityList implements Iterator, Countable
     /**
      * Internal list of all items.
      *
-     * @var array
+     * @var array[]
      */
     protected $items = array();
 
@@ -58,8 +55,9 @@ class PriorityList implements Iterator, Countable
      * Insert a new item.
      *
      * @param  string  $name
-     * @param  mixed $value
-     * @param  int $priority
+     * @param  mixed   $value
+     * @param  int     $priority
+     *
      * @return void
      */
     public function insert($name, $value, $priority = 0)
@@ -74,13 +72,23 @@ public function insert($name, $value, $priority = 0)
         );
     }
 
+    /**
+     * @param string $name
+     * @param int    $priority
+     *
+     * @return $this
+     *
+     * @throws \Exception
+     */
     public function setPriority($name, $priority)
     {
         if (!isset($this->items[$name])) {
             throw new \Exception("item $name not found");
         }
+
         $this->items[$name]['priority'] = (int) $priority;
-        $this->sorted = false;
+        $this->sorted                   = false;
+
         return $this;
     }
 
@@ -92,11 +100,10 @@ public function setPriority($name, $priority)
      */
     public function remove($name)
     {
-        if (!isset($this->items[$name])) {
-            return;
+        if (isset($this->items[$name])) {
+            $this->count--;
         }
 
-        $this->count--;
         unset($this->items[$name]);
     }
 
@@ -107,7 +114,7 @@ public function remove($name)
      */
     public function clear()
     {
-        $this->items = array();
+        $this->items  = array();
         $this->serial = 0;
         $this->count  = 0;
         $this->sorted = false;
@@ -158,25 +165,26 @@ protected function compare(array $item1, array $item2)
     /**
      * Get/Set serial order mode
      *
-     * @param bool $flag
+     * @param bool|null $flag
+     *
      * @return bool
      */
     public function isLIFO($flag = null)
     {
         if ($flag !== null) {
-            if (($flag = ($flag === true ? 1 : -1)) !== $this->isLIFO) {
-                $this->isLIFO = $flag;
+            $isLifo = $flag === true ? 1 : -1;
+
+            if ($isLifo !== $this->isLIFO) {
+                $this->isLIFO = $isLifo;
                 $this->sorted = false;
             }
         }
-        return $this->isLIFO === 1;
+
+        return 1 === $this->isLIFO;
     }
 
     /**
-     * rewind(): defined by Iterator interface.
-     *
-     * @see    Iterator::rewind()
-     * @return void
+     * {@inheritDoc}
      */
     public function rewind()
     {
@@ -185,56 +193,43 @@ public function rewind()
     }
 
     /**
-     * current(): defined by Iterator interface.
-     *
-     * @see    Iterator::current()
-     * @return mixed
+     * {@inheritDoc}
      */
     public function current()
     {
         $node = current($this->items);
-        return ($node !== false ? $node['data'] : false);
+
+        return $node ? $node['data'] : false;
     }
 
     /**
-     * key(): defined by Iterator interface.
-     *
-     * @see    Iterator::key()
-     * @return string
+     * {@inheritDoc}
      */
     public function key()
     {
         return key($this->items);
     }
 
     /**
-     * next(): defined by Iterator interface.
-     *
-     * @see    Iterator::next()
-     * @return mixed
+     * {@inheritDoc}
      */
     public function next()
     {
         $node = next($this->items);
-        return ($node !== false ? $node['data'] : false);
+
+        return $node ? $node['data'] : false;
     }
 
     /**
-     * valid(): defined by Iterator interface.
-     *
-     * @see    Iterator::valid()
-     * @return bool
+     * {@inheritDoc}
      */
     public function valid()
     {
-        return (current($this->items) !== false);
+        return current($this->items) !== false;
     }
 
     /**
-     * count(): defined by Countable interface.
-     *
-     * @see    Countable::count()
-     * @return int
+     * {@inheritDoc}
      */
     public function count()
     {
@@ -245,16 +240,19 @@ public function count()
      * Return list as array
      *
      * @param int $flag
+     *
      * @return array
      */
     public function toArray($flag = self::EXTR_DATA)
     {
         $this->sort();
+
         if ($flag == self::EXTR_BOTH) {
             return $this->items;
         }
+
         return array_map(
-            ($flag == self::EXTR_PRIORITY)
+            self::EXTR_PRIORITY === $flag
                 ? function ($item) { return $item['priority']; }
                 : function ($item) { return $item['data']; },
             $this->items