The TabBar class is a user-interface control that manages a line of tabs for multi-page dialogs. More...

Inheritance diagram for TabBar:

Public Member Functions
	TabBar ($id, $tabs, $queryString="", $useQueryString=true, $showNumber=false)
	Construct a new TabBar control. More...

	preserveQueryString ()
	Preserve the current query string in tab links. More...

	dynamicLoad ($container)

	writeScript ()

	writeHTML ()
	Writes the HTML for this control to standard output. More...

	appendQueryString ($url, $qs)
	Appends a query string to the supplied URL. More...

	getNextPage ()
	Get the next page in the tab list after the current page. More...

	getPage ($idx, $appendQueryString=true)
	Return the URL for the page at the specified tab index. More...

	findPage ($page)
	Finds the tab containing the specified URL. More...

	next ()
	Move to the next page in the tab list. More...

	drawCheckList ()

	drawCheckListEntry ($title, $form)

	setDefaultStateImage ($img)

Public Attributes
	$id
	The DOM ID of the TabBar container element. More...

	$tabs = array()
	The tab records in this tab bar. More...

	$queryString = null
	The query string parameters to append to the navigation links. More...

	$useQueryString = true
	Whether a query string is being used as the navigation key. More...

	$page = ""
	The current page (for display purposes). This can be set explicitly to force the correct tab display when in a sub-page, for instance. More...

	$showNumber
	True to display the step number, false if not. More...

	$states = array()
	Array of display states to apply, indexed by tab. More...

	$flags = array()
	Array of flags to apply, indexed by tab. More...

	$anchor = ""
	Anchor name to generate (leave empty for no anchor tag) More...

	$cssClass = ""
	CSS class to apply to the top level container for the tabs. More...

	$defaultStateImage
	Image to show in the default tab state. More...

	$showStates = true
	true to show tab states, false to ignore them More...

	$dynamic = false
	true to indicate dynamic (AJAX-based) loading More...

	$container = ""
	The DOM ID of the container that will contain dynamically loaded content. More...

	$dynamicLoadHandler = null
	Javascript function to call to handle dynamic content load (optional) More...

	$dynamicLoadFirstTab = true
	By default, dynamically loaded tab bars will do a request for the content of the first tab on page load. Set to false to disable this. More...

	$disabled = false
	Set to true to generate disabled tab navigation. More...

Detailed Description

The TabBar class is a user-interface control that manages a line of tabs for multi-page dialogs.

Definition at line 39 of file tab_bar.inc.

Member Function Documentation

◆ appendQueryString()

TabBar::appendQueryString	(	$url,
		$qs
	)

Appends a query string to the supplied URL.

Parameters

string	$url
string	$qs

Returns: string

Definition at line 311 of file tab_bar.inc.

      {
           if ($url[0] == "&") 
           {
                $url = $qs.$url;
           }
           else
           {
                $url .= (strstr($url, "?") !== false) ? "&$qs" : "?$qs";
           }
           return $url;
      }

◆ drawCheckList()

TabBar::drawCheckList ( )

Definition at line 446 of file tab_bar.inc.

      {
      ?>
              <table class="checklist">
      <?
           foreach($this->tabs as $title => $form)
           {
                $this->drawCheckListEntry($title, $form);
           }
      ?>
      </table>
      <?
      }

◆ drawCheckListEntry()

TabBar::drawCheckListEntry	(	$title,
		$form
	)

Definition at line 460 of file tab_bar.inc.

      {
           if (get_class($form) == "TabBar")
           {
 ?>
  <tr>
   <td colspan="2" class="title"><b><?echo $title?></b></td>
  </tr>
 <?
                foreach($form->tabs as $t => $f)
                {
                     $this->drawCheckListEntry($t, $f);
                }
           }
           else
           {
                $status = $this->flags[$form];
                 
                if ($status && $this->states[$status])
                {
                     $img = "<img src='{$this->states[$status]}' alt='$status'/>";
                }
                else if ($this->defaultStateImage)
                {
                     $img = "<img src='{$this->defaultStateImage}' alt=''/>";
                }
      ?>
       <tr>
        <td class="status"><?echo $img ?></td>
        <td class="link"><a href="<?echo $form ?>?<?echo $this->queryString?>"><?echo $title ?></a></td>
       </tr>
      <?
                
           }
      }

◆ dynamicLoad()

TabBar::dynamicLoad ( $container )

Definition at line 104 of file tab_bar.inc.

      {
           $this->container = $container;
           $this->dynamic = true;
      }

◆ findPage()

TabBar::findPage ( $page )

Finds the tab containing the specified URL.

Parameters

$page The page to find

Returns: mixed returns the name of the tab if found, false otherwise

Reimplemented in TwoLevelTabBar.

Definition at line 411 of file tab_bar.inc.

      {
           foreach($this->tabs as $text => $url)
           {
                if ($this->comparePaths($url, $page))
                {
                     return $text;
                }
           }
           
           return false;
      }

◆ getNextPage()

TabBar::getNextPage ( )

Get the next page in the tab list after the current page.

Returns: string

Reimplemented in TwoLevelTabBar.

Definition at line 329 of file tab_bar.inc.

      {
           $found = false;
           
           foreach($this->tabs as $text => $url)
           {
                trace("getNextPage::text is $text and url is $url; this page is {$this->page}", 3);
                if ($found)
                {
                     $dest = ($this->queryString!="") ? $this->appendQueryString($url, $this->queryString) : $url;
                     trace("getNextPage::found; dest is$dest", 3);
                     return $dest;
                }
                else if ($this->comparePaths($url, $this->page))
                {
                     $found = true;
                     trace("getNextPage::url is this page", 3);   
                } 
           }
  
           return ($found) ? "" : false;
      }

◆ getPage()

TabBar::getPage	(	$idx,
		$appendQueryString = `true`
	)

Return the URL for the page at the specified tab index.

Parameters

string $idx the index of the tab for which we require the URL

Definition at line 357 of file tab_bar.inc.

      {
           $i = 0;
           
           foreach($this->tabs as $text => $entry)
           {
                if (is_object($entry) && get_class($entry) == "TabBar")
                {
                     $num = count($entry->tabs);
                     
                     if ($num >= $idx - $i)
                     {
                          $entry->queryString = $this->queryString;
                          return $entry->getPage($idx - $i);
                     }
                     else
                     {
                          $i += $num;
                          continue;
                     }
                }
                else
                {
                     $url = $entry;
                }
                          
                if ($i == $idx) break;
                $i++;
           }
           
           $dest = ($appendQueryString && $this->queryString!="") ? $this->appendQueryString($url, $this->queryString) : $url;
           return $dest;  
      }

◆ next()

TabBar::next ( )

Move to the next page in the tab list.

If the current tab is the last in the set, redirect to the first tab in the list (wraparound).

Definition at line 428 of file tab_bar.inc.

      {
           $next = $this->getNextPage();
           if (!$next)
           {
                $next = $this->getPage(0);
           }
  
           /* 
            * JDG 6/15/2010, insert "/" before identifier but not if
            * the page is *.php
            */
           //if(!preg_match("/.php/i", $next))
           //   $next = "/". $next;
           trace("tabbar::next:: next is $next",3);
           redirect($next);    
      }

◆ preserveQueryString()

TabBar::preserveQueryString ( )

Preserve the current query string in tab links.

Definition at line 89 of file tab_bar.inc.

      {
           $qs = getCleanQueryString();
           if ($qs)
           {
                $this->queryString = $qs;
                $this->useQueryString = true;
           }
           else
           {
                $this->queryString = null;
                $this->useQueryString = false;
           }
      }

◆ setDefaultStateImage()

TabBar::setDefaultStateImage ( $img )

Definition at line 496 of file tab_bar.inc.

      {
           foreach($this->tabs as $text => $entry)
           {
                if (is_object($entry) && get_class($entry) == "TabBar")
                {
                     $entry->defaultStateImage = $img;
                }
           }
      
           $this->defaultStateImage = $img;
      }    

◆ TabBar()

TabBar::TabBar	(	$id,
		$tabs,
		$queryString = `""`,
		$useQueryString = `true`,
		$showNumber = `false`
	)

Construct a new TabBar control.

Parameters

string	$queryString	the Query String portion of the page URIs
array	$tabs	the steps in the workflow
string	$queryString	the query string to append to the links
bool	$useQueryString	flag to indicate whether a query string is required. If so, and none is provided, then all tabs except the first are disabled.
bool	$showNumber	flag to indicate whether to display step numbers

Definition at line 71 of file tab_bar.inc.

      {
           global $config;
           global $isAdmin;
           
           $this->id             = $id;
           $this->tabs           = $tabs;
           $this->page           = ($config['prettyURLs'] === false) ? basename($_SERVER["PHP_SELF"]) :  $_REQUEST['identifier'];
           if ($isAdmin) $this->page = "/admin/{$this->page}";
           $this->queryString    = $queryString;
           $this->useQueryString = $useQueryString;
           $this->showNumber     = $showNumber;
           trace("PAGE: **** {$this->page}", 4);
      }

◆ writeHTML()

TabBar::writeHTML ( )

Writes the HTML for this control to standard output.

Reimplemented in WizardBar.

Definition at line 192 of file tab_bar.inc.

      {
           foreach($this->tabs as $text => $entry)
           {
                if (is_object($entry) && get_class($entry) == "TabBar")
                {
                     $entry->page = $this->page;
                     $entry->queryString = $this->queryString;
                }
           }
           
          $first   = true;
          $future  = false;
     
          if ($this->anchor) echo "<a name='<?echo $this->anchor?>'></a>";
          
          echo "<div id='{$this->id}'";
          
          if ($this->cssClass) echo " class='{$this->cssClass}'";
          
          echo "><ul>";
          
          foreach ($this->tabs as $text => $entry)
      {
           ++$count;
           $active = "";
           $style = "";
           
           //AJG - make it easier to have conditional tabs. 
           if ($entry === null) continue;
           
           if (is_string($entry))
           {
                $url = $entry;
           }
           else if (is_object($entry) && get_class($entry) == "TabBar")
           {
                if ($entry->findPage($this->page))
                {
                     $url = $this->page;
                }
                else
                {
                     $url = $entry->getPage(0, false);
                }
           }
           
              if (!$first)
           {
                echo $this->spacer;
           }
           else
           {
                $first = false;
           }
          
           $isMatch = $this->comparePaths($url, $this->page);
           // JDG 12/01/09, get the basename of the url, in case we need a
           // longer path in the tab include file, as with digital movies
           if ($isMatch)
              {
                $style = " class='current'";
              }
  
           if (($this->disabled || ($this->queryString == "" && $this->useQueryString)) && $count > 1)
           {
                $active = " class='disabled'";
              }
         
           if ($this->showNumber) $text = "$count.&nbsp;$text";
          
           if ($this->useQueryString)
           {
                $dest = ($this->queryString!="") ? $this->appendQueryString($url, $this->queryString) :"#";
           }
           else
           {
                $dest = ($isMatch && !$this->dynamic) ? "#" : $url;
           }
         
           if ($this->anchor)
           {
                $dest = ($dest != "#") ? "$dest#{$this->anchor}" : "#{$this->anchor}";
           }
           
           if ($this->showStates)
           {
                if (array_key_exists($url, $this->flags))
                {
                     $text = "<img src='{$this->states[$this->flags[$url]]}' style='border: none; display: inline-block;vertical-align: middle'/>&nbsp;$text";             
                }
                else if ($this->defaultStateImage)
                {
                     $text = "<img src='{$this->defaultStateImage}' style='border: none; display: inline-block;vertical-align: middle'/>&nbsp;$text";
                }
           }
              echo "<li$style><a href=\"$dest\"$active>$text</a></li>";
      }
           
           echo "</ul></div>\n";
           
           foreach($this->tabs as $text => $entry)
           {
                if (is_object($entry) && get_class($entry) == "TabBar" &&
                     $entry->findPage($this->page))
                {
                     $entry->useQueryString = $this->useQueryString;
                     $entry->writeHTML();
                }
           }
      }

◆ writeScript()

TabBar::writeScript ( )

Definition at line 110 of file tab_bar.inc.

      {
           $script = "";
           if (!$this->dynamic) return $script;
           
           $script .= <<<ENDSCRIPT
      <script type="text/javascript">
      window.addEvent('domready', function()
      {
           document.id('{$this->id}').getElements("a").each(function(a)
           {
                a.loadTab = function(override)
 ENDSCRIPT;
           if ($this->dynamicLoadHandler)
           {
                $script .= <<<ENDSCRIPT
                {
                     var url = override ? override : this.href;
                     {$this->dynamicLoadHandler}(url);
                };   
 ENDSCRIPT;
           }
           else
           {
                $script .= <<<ENDSCRIPT
                {
                     var request = new Request.HTML(
                     {
                          evalScripts: false,
                          evalResponse: false,
                          method: 'get', 
                          url: override ? override : this.href, 
                          onSuccess: function(tree, elements, html, script) 
                          { 
                               var container = document.id('{$this->container}');
                               container.set('text', '');
                               container.adopt(tree);
           
                               Browser.exec(script);
  
                          }.bind(this)
                     });
                     
                     request.send();
                };
 ENDSCRIPT;
           }
  
           $script .= <<<ENDSCRIPT
  
                a.addEvent('click', function(e) 
                {
                     new DOMEvent(e).stop();
                     var url = a.href;
                     var parent = a.getParent();
                     document.id('{$this->id}').getElements("li").each(function(l) { l.removeClass("current"); });
                     parent.addClass('current');
                     
                     a.loadTab();             
                });
           });
 ENDSCRIPT;
  
           if ($this->dynamicLoadFirstTab)
           {
                $script .= <<<ENDSCRIPT
           document.id('{$this->id}').getElements("li.current a").each(function(a)
           {
                a.loadTab();
           });
 ENDSCRIPT;
           }
  
           $script .= <<<ENDSCRIPT
      });
      </script> 
 ENDSCRIPT;
           return $script;
      }

Member Data Documentation

◆ $anchor

TabBar::$anchor = ""

Anchor name to generate (leave empty for no anchor tag)

Definition at line 49 of file tab_bar.inc.

◆ $container

TabBar::$container = ""

The DOM ID of the container that will contain dynamically loaded content.

Definition at line 55 of file tab_bar.inc.

◆ $cssClass

TabBar::$cssClass = ""

CSS class to apply to the top level container for the tabs.

Definition at line 50 of file tab_bar.inc.

◆ $defaultStateImage

TabBar::$defaultStateImage

Image to show in the default tab state.

Definition at line 51 of file tab_bar.inc.

◆ $disabled

TabBar::$disabled = false

Set to true to generate disabled tab navigation.

Definition at line 59 of file tab_bar.inc.

◆ $dynamic

TabBar::$dynamic = false

true to indicate dynamic (AJAX-based) loading

Definition at line 54 of file tab_bar.inc.

◆ $dynamicLoadFirstTab

TabBar::$dynamicLoadFirstTab = true

By default, dynamically loaded tab bars will do a request for the content of the first tab on page load. Set to false to disable this.

Definition at line 57 of file tab_bar.inc.

◆ $dynamicLoadHandler

TabBar::$dynamicLoadHandler = null

Javascript function to call to handle dynamic content load (optional)

Definition at line 56 of file tab_bar.inc.

◆ $flags

TabBar::$flags = array()

Array of flags to apply, indexed by tab.

Definition at line 48 of file tab_bar.inc.

◆ $id

TabBar::$id

The DOM ID of the TabBar container element.

Definition at line 41 of file tab_bar.inc.

◆ $page

TabBar::$page = ""

The current page (for display purposes). This can be set explicitly to force the correct tab display when in a sub-page, for instance.

Definition at line 45 of file tab_bar.inc.

◆ $queryString

TabBar::$queryString = null

The query string parameters to append to the navigation links.

Definition at line 43 of file tab_bar.inc.

◆ $showNumber

TabBar::$showNumber

True to display the step number, false if not.

Definition at line 46 of file tab_bar.inc.

◆ $showStates

TabBar::$showStates = true

true to show tab states, false to ignore them

Definition at line 52 of file tab_bar.inc.

◆ $states

TabBar::$states = array()

Array of display states to apply, indexed by tab.

Definition at line 47 of file tab_bar.inc.

◆ $tabs

TabBar::$tabs = array()

The tab records in this tab bar.

Definition at line 42 of file tab_bar.inc.

◆ $useQueryString

TabBar::$useQueryString = true

Whether a query string is being used as the navigation key.

Definition at line 44 of file tab_bar.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/framework/tab_bar.inc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ appendQueryString()

◆ drawCheckList()

◆ drawCheckListEntry()

◆ dynamicLoad()

◆ findPage()

◆ getNextPage()

◆ getPage()

◆ next()

◆ preserveQueryString()

◆ setDefaultStateImage()

◆ TabBar()

◆ writeHTML()

◆ writeScript()

Member Data Documentation

◆ $anchor

◆ $container

◆ $cssClass

◆ $defaultStateImage

◆ $disabled

◆ $dynamic

◆ $dynamicLoadFirstTab

◆ $dynamicLoadHandler

◆ $flags

◆ $id

◆ $page

◆ $queryString

◆ $showNumber

◆ $showStates

◆ $states

◆ $tabs

◆ $useQueryString