WizardBar Class Reference

The WizardBar class is a user-interface control that draws a stepped nav bar for multi-stage workflows. More...

Inheritance diagram for WizardBar:

Collaboration diagram for WizardBar:

Public Member Functions
	WizardBar ($id, $tabs=array(), $queryString="", $useQueryString=true, $showNumber=false)
	Construct a new WizardBar control. More...
	writeHTML ()
	Writes the HTML for this control to standard output. More...
Public Member Functions inherited from TabBar
	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 ()
	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
	$spacer = " » "
	Spacer that appears between wizard steps. More...
	$strict = false
	When strict is set to true, navigation to future steps is always disabled. More...
	$rootSteps = 1
	The number of steps that can be reached without a query string when useQueryString is true. More...
	$scriptLinks = false
	True to specify that destinations are javascript and should be place in onclick attributes. More...
Public Attributes inherited from TabBar
	$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 WizardBar class is a user-interface control that draws a stepped nav bar for multi-stage workflows.

Definition at line 44 of file wizard_bar.inc.

Member Function Documentation

WizardBar()

WizardBar::WizardBar	(		$id,
			$tabs = array(),
			$queryString = "",
			$useQueryString = true,
			$showNumber = false
	)

Construct a new WizardBar 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 61 of file wizard_bar.inc.

     {
          parent::TabBar($id, $tabs, $queryString, $useQueryString, $showNumber);
     }

writeHTML()

WizardBar::writeHTML

(

)

Writes the HTML for this control to standard output.

Reimplemented from TabBar.

Definition at line 69 of file wizard_bar.inc.

     {
         $first   = true;
         $future  = false;
          $count   = 0;
 
         echo "<div id='{$this->id}'";
         
         if ($this->cssClass) echo " class='{$this->cssClass}'";
         
         echo "><ul>";        
          foreach($this->tabs as $text => $url)
         {
               
          ++$count;
          $active = "";
          $style = "";
 
          if (!$first)
               {    
                    $spacer = $this->spacer;
          }
          else
          {
               $spacer = "";
               $first = false;
               $style = "first ";
          }
          
               if ($url == $this->page)
             {
               $style .= "current";
               $future = true;             
             }
               elseif (($this->disabled || 
                         ($future && $this->strict) ||
                         ($future && ($this->queryString == "" && $this->useQueryString)) && $count > $this->rootSteps) 
                         || $this->states[$url] == 'disable')
             {
                    $active = " class='disabled'";
                    $style .= "disabled";
             }
       
          if ($this->showNumber) $text = "$count.&nbsp;$text";
         
          if ($this->useQueryString)
          {
               $dest = ($this->queryString!="" || ($this->rootSteps > 1 && $count <= $this->rootSteps)) ? $this->appendQueryString($url, $this->queryString) :"#";
          }
          else
          {
               $dest = ($url == $this->page || $this->disabled || ($future && $this->strict)) ? "#" : $url;
          }
        
          if ($this->anchor)
          {
               $dest = ($dest != "#") ? "$dest#{$this->anchor}" : "#{$this->anchor}";
          }
          
          if ($this->scriptLinks)
          {
               $link = "href=\"#\"";
               if ($dest != '#')
               {
                    $link .= " onclick=\"$dest; return false\"";
               }
          }
          else
          {
               $link = "href=\"$dest\"";
          }
          
          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 class='$style'>$spacer<a {$link}{$active}>{$text}</a></li>";
          }    
               
     // close wizard div
     echo "</ul></div>\n";
     }

Member Data Documentation

$rootSteps

WizardBar::$rootSteps = 1

The number of steps that can be reached without a query string when useQueryString is true.

Definition at line 48 of file wizard_bar.inc.

$scriptLinks

WizardBar::$scriptLinks = false

True to specify that destinations are javascript and should be place in onclick attributes.

Definition at line 49 of file wizard_bar.inc.

$spacer

WizardBar::$spacer = " » "

Spacer that appears between wizard steps.

Definition at line 46 of file wizard_bar.inc.

$strict

WizardBar::$strict = false

When strict is set to true, navigation to future steps is always disabled.

Definition at line 47 of file wizard_bar.inc.

---

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

• C:/code/cms.sonjara.com/framework/wizard_bar.inc