Changeset 534 for trunk/lib/Navigation.inc.php

Timestamp:

Jul 27, 2015 7:56:08 AM (9 years ago)

Author:

anonymous

Message:

Improved module maker validation output. Allow disabling cache at run time for ACL. Added ACL getList() method. Improved ACL CLI listing. Fixed app boomerang array initialization. Now retaining identical boomerang URLs if the key is different. Added a maximum boomerang time. Added a way to disable cache per request through a query string. Added validator isDecimal() method. Added disableSelectOptions() HTML method. Added getGravatarURL() method. Change how navigation page array is managed. Updated navigation currentPage() method to test an array of URLs.

File:

• trunk/lib/Navigation.inc.php (modified) (8 diffs)

trunk/lib/Navigation.inc.php

@@ -48 +48 @@
         'path_delimiter' => ' / ',
         'last_crumb_format' => '%s',
+        'current_page_url' => null, // This should be set at runtime using, e.g., $_SERVER['REQUEST_URI']
     );
     public $pages = array();
@@ -57 +58 @@
     {
         $app =& App::getInstance();
+
+        // Define current_page_url here because _SERVER, not a static scalar, cannot be defined in the defaults above.
+        // Using PHP_SELF for legacy compatability, but it might make sense to override this with REQUEST_URI.
+        // This could be overwritten by passed params.
+        $this->_params['current_page_url'] = $_SERVER['PHP_SELF'];
 
         if (isset($params) && is_array($params)) {
@@ -72 +78 @@
      * @access  public
      * @param   string  $title      The title of the page.
-     * @param   string  $url        The URL to the page. Set to null to use PHP_SELF.
+     * @param   string  $url        The URL to the page. Set to null to use REQUEST_URI.
      * @param   array   $vars       Additional page variables.
      */
@@ -81 +87 @@
             'head_title' => $title,
             'body_title' => $title,
-            'url' => is_null($url) ? $_SERVER['PHP_SELF'] : $url,
+            'url' => is_null($url) ? $this->_params['current_page_url'] : $url,
         );
-        $this->pages[] = array_merge($page, $vars);
+        // An "unformed page element" has settings applied (via ->set()) but no page added (via ->add()).
+        if (empty($this->pages) || isset(end($this->pages)['title'])) {
+            // There are no unformed page elements; add a whole new page.
+            $this->pages[] = array_merge($page, $vars);
+        } else {
+            // Append the new page to the unformed page element.
+            $curr_page =& $this->pages[key($this->pages)];
+            $curr_page = array_merge($curr_page, $page, $vars);
+        }
     }
 
@@ -143 +157 @@
     {
         // Set params of current page.
-        $curr_page =& $this->pages[sizeof($this->pages) - 1];
+        if (empty($this->pages)) {
+            // If we're setting a value on an empty pages array, we need to add one "unformed" element first.
+            $this->pages[] = array();
+        }
+        end($this->pages);
+        $curr_page =& $this->pages[key($this->pages)];
         $curr_page[$key] = $val;
     }
@@ -157 +176 @@
     public function get($key, $default='')
     {
-        $curr_page =& $this->pages[sizeof($this->pages) - 1];
+        end($this->pages);
+        $curr_page =& $this->pages[key($this->pages)];
 
         switch ($key) {
@@ -375 +395 @@
      * @access  public
      *
-     * @param   string  $test_uri       A URI to test against the current page.
+     * @param   mixed   $test_uri       A URI, or an array of URIs, to test against the current page.
      * @param   mixed   $true_return    The value to return if the current page matches the test URI.
      * @param   mixed   $false_return   The value to return if the current page does not match the test URI.
@@ -387 +407 @@
     {
         $app =& App::getInstance();
+
+        // If given an array, test each URI recursively returning TRUE on a first match, or FALSE if none match.
+        if (is_array($test_uri)) {
+            foreach ($test_uri as $uri) {
+                if ($this->currentPage($uri, $true_return, $false_return, $include_query)) {
+                    return true;
+                }
+            }
+            return false;
+        }
 
         $actual_uri = $include_query ? $_SERVER['REQUEST_URI'] : strtok($_SERVER['REQUEST_URI'], '?');