Make code look nice.

Author: alwaysblank

src/Climber.php

@@ -2,7 +2,7 @@
 
 namespace Livy\Climber;
 
-use \Zenodorus as Z;
+use Zenodorus as Z;
 
 /**
  * Class Climber
@@ -141,6 +141,16 @@ function ($data) {
         );
     }
 
+    public function setCurrentUrl($url, $strict = true)
+    {
+        if (count($currentLeaves = $this->getLeafByTarget($url, $strict)) > 0) {
+            foreach ($currentLeaves as $leaf) {
+                $this->activate($leaf);
+            }
+        }
+        return $this;
+    }
+
     public function getLeafByTarget(string $target, bool $strict = true)
     {
         $leaves = [];
@@ -173,21 +183,6 @@ public function getLeafByTarget(string $target, bool $strict = true)
         return $leaves;
     }
 
-    public function setCurrentUrl($url, $strict = true)
-    {
-        if (count($currentLeaves = $this->getLeafByTarget($url, $strict)) > 0) {
-            foreach ($currentLeaves as $leaf) {
-                $this->activate($leaf);
-            }
-        }
-        return $this;
-    }
-
-    public function isActivated()
-    {
-        return count(array_column($this->tree->grow(), 3)) > 0;
-    }
-
     public function activate(int $hint)
     {
         if ($leaf = $this->tree->getLeaf($hint)) {
@@ -227,6 +222,11 @@ public function hook(string $location, $callback, $order = false)
         return null;
     }
 
+    public function isActivated()
+    {
+        return count(array_column($this->tree->grow(), 3)) > 0;
+    }
+
     public function __toString()
     {
         return $this->element();

src/Spotter/Forester.php

@@ -40,8 +40,8 @@ protected function convertToFormat($data)
         }
 
         return [
-          'parent' => $data[0],
-          'data' => isset($data[2]) ? $data[2] : [],
+            'parent' => $data[0],
+            'data'   => isset($data[2]) ? $data[2] : [],
         ];
     }
 }

src/Spotter/Spotter.php

@@ -14,12 +14,12 @@ public function __construct($seed)
         $this->seed = $seed;
     }
 
-    abstract protected function soil();
-
     public function germinate()
     {
         // Only pass this on if it's a valid seed.
         $this->sprout = $this->seed ? $this->soil() : null;
         return $this->sprout;
     }
+
+    abstract protected function soil();
 }

src/Spotter/WordPress.php

@@ -5,11 +5,11 @@
 class WordPress extends Spotter
 {
     public $expected = [
-        'ID' => 'id',
+        'ID'               => 'id',
         'menu_item_parent' => 'parent',
-        'menu_order' => 'order',
-        'url' => 'target',
-        'title' => 'name',
+        'menu_order'       => 'order',
+        'url'              => 'target',
+        'title'            => 'name',
     ];
 
     /**
@@ -20,7 +20,7 @@ protected function soil()
         $temp = [];
         foreach ($this->seed as $item) {
             $temp[$item->ID] = [];
-            
+
             // If there's no parent, `parent` should be null
             if ($item->menu_item_parent == 0) {
                 $item->menu_item_parent = null;

src/Tree.php

@@ -4,7 +4,7 @@
 
 use Livy\Climber\Spotter\Forester;
 use Livy\Climber\Spotter\Spotter;
-use \Zenodorus as Z;
+use Zenodorus as Z;
 
 /**
  * This class generates data trees for processing by Climber.
@@ -172,34 +172,19 @@ protected function plant()
         return null;
     }
 
-    public function getLeafPath(int $id, array $ancestors = [])
+    public function getLeafSiblings(int $id, bool $exclude = null)
     {
-        if (null === $this->getLeaf($id)
-            || null === $this->getLeafContent($id, 0)) {
-            // This item doesn't exist or has no ancestors.
-            // Either we've reached the last step in our path, we were passed
-            // a bad leaf, or this leaf has no parent.
-            return array_reverse($ancestors);
-        }
-
-        array_push($ancestors, $this->getLeafContent($id, 0));
-
-        return $this->getLeafPath($this->getLeafContent($id, 0), $ancestors);
-    }
+        $parent   = $this->getLeafContent($id, 'parent');
+        $tree     = $this->tree;
+        $siblings = array_filter($tree, function ($item) use ($parent) {
+            return $item[0] == $parent;
+        });
 
-    public function isLeafChildOf(int $leaf, int $parent)
-    {
-        $ancestors = $this->getLeafPath($leaf);
-        if (count($ancestors) > 0 && in_array($parent, $ancestors)) {
-            return true;
+        if ($exclude) {
+            unset($siblings[$id]);
         }
 
-        return false;
-    }
-
-    public function getLeaf(int $id)
-    {
-        return isset($this->tree[$id]) ? $this->tree[$id] : null;
+        return $siblings;
     }
 
     public function getLeafContent(int $id, $slot, $data = null)
@@ -242,19 +227,9 @@ protected function query($slot)
         return false;
     }
 
-    public function getLeafSiblings(int $id, bool $exclude = null)
+    public function getLeaf(int $id)
     {
-        $parent   = $this->getLeafContent($id, 'parent');
-        $tree     = $this->tree;
-        $siblings = array_filter($tree, function ($item) use ($parent) {
-            return $item[0] == $parent;
-        });
-
-        if ($exclude) {
-            unset($siblings[$id]);
-        }
-
-        return $siblings;
+        return isset($this->tree[$id]) ? $this->tree[$id] : null;
     }
 
     public function setLeaf(int $id, array...$actions)
@@ -624,16 +599,6 @@ protected function setActive(int $id, string $value)
         );
     }
 
-    /**
-     * We want to know if we're the original or not, so set `$clone`.
-     *
-     * @return void
-     */
-    protected function __clone()
-    {
-        $this->clone = true;
-    }
-
     /**
      * Takes a leaf and returns a new Tree composed of only the children of that leaf.
      *
@@ -664,6 +629,31 @@ public function subtree(int $root, bool $includeRoot = false)
         );
     }
 
+    public function isLeafChildOf(int $leaf, int $parent)
+    {
+        $ancestors = $this->getLeafPath($leaf);
+        if (count($ancestors) > 0 && in_array($parent, $ancestors)) {
+            return true;
+        }
+
+        return false;
+    }
+
+    public function getLeafPath(int $id, array $ancestors = [])
+    {
+        if (null === $this->getLeaf($id)
+            || null === $this->getLeafContent($id, 0)) {
+            // This item doesn't exist or has no ancestors.
+            // Either we've reached the last step in our path, we were passed
+            // a bad leaf, or this leaf has no parent.
+            return array_reverse($ancestors);
+        }
+
+        array_push($ancestors, $this->getLeafContent($id, 0));
+
+        return $this->getLeafPath($this->getLeafContent($id, 0), $ancestors);
+    }
+
     /**
      * Sometimes we don't want to be a clone after all.
      */
@@ -672,6 +662,16 @@ public function declone()
         $this->clone = false;
     }
 
+    /**
+     * We want to know if we're the original or not, so set `$clone`.
+     *
+     * @return void
+     */
+    protected function __clone()
+    {
+        $this->clone = true;
+    }
+
     /**
      * Remove a leaf from the tree.
      *

src/func/common.php

@@ -1,5 +1,6 @@
 <?php
-use \Livy\Climber;
+
+use Livy\Climber;
 
 // phpcs:disable
 $GLOBALS['livy_climber_helper_func_loaded']['common'] = true;
@@ -8,10 +9,10 @@
 /**
  * Returns a Climber object.
  *
- * @param Spotter/[ClassName] $spotter      An instance of a class that
+ * @param Livy\Climber\Spotter\[ClassName] $spotter      An instance of a class that
  *                                          extends Spotter/Spotter.
  * @param string $currentUrl                The URL of the current page.
- * @return Climber|boolean
+ * @return Livy\Climber\Climber|boolean
  */
 function pulley__get_menu($spotter, string $currentUrl = null)
 {
@@ -32,10 +33,10 @@ function pulley__get_menu($spotter, string $currentUrl = null)
  *
  * @see pulley__getMenu()
  *
- * @param Spotter/[ClassName] $spotter      An instance of a class that
+ * @param Livy\Climber\Spotter\[ClassName] $spotter      An instance of a class that
  *                                          extends Spotter/Spotter.
  * @param string $currentUrl                The URL of the current page.
- * @return string
+ * @return void
  */
 function pulley__menu($spotter, string $currentUrl = null)
 {

src/func/wp.php

@@ -1,5 +1,6 @@
 <?php
-use \Livy\Climber;
+
+use Livy\Climber;
 
 // phpcs:disable
 $GLOBALS['livy_climber_helper_func_loaded']['wp'] = true;
@@ -20,8 +21,8 @@
  * `wp_get_nave_menu_items()`.
  *
  * @param int|string|WP_Term $menu
- * @param string $currentUrl
- * @return Climber
+ * @param string             $currentUrl
+ * @return Livy\Climber\Climber
  */
 function pulley__wp_get_menu($menu, string $currentUrl = null)
 {
@@ -37,7 +38,7 @@ function pulley__wp_get_menu($menu, string $currentUrl = null)
  * @see pulley__wp_get_menu()
  *
  * @param int|string|WP_Term $menu
- * @param string $currentUrl
+ * @param string             $currentUrl
  * @return void
  */
 function pulley__wp_menu($menu, string $currentUrl = null)
@@ -53,7 +54,7 @@ function pulley__wp_menu($menu, string $currentUrl = null)
  *
  * @param string $location
  * @param string $currentUrl
- * @return Climber
+ * @return Livy\Climber\Climber|boolean
  */
 function pulley__wp_get_menu_by_location(
     string $location,

tests/shims.php

@@ -114,8 +114,8 @@ class WP_Term
  * validated as `WP_Term` object.
  *
  * @param integer $integer
- * @param string $type
- * @return void
+ * @param string  $type
+ * @return bool|WP_Term
  */
 function get_term($integer, $type)
 {