blueshoes php application framework and cms            core_html
[ class tree: core_html ] [ index: core_html ] [ all elements ]

Class: Bs_HnXmlHandler

Source Location: /core/html/Bs_HnXmlHandler.class.php

Class Overview

Bs_Object
   |
   --Bs_HnXmlHandler

*********************************************************************** HtmlNavigation Xml Handler class.


Author(s):

Version:

  • 4.3.$Revision: 1.4 $ $Date: 2003/12/27 16:05:36 $

Copyright:

  • blueshoes.org

Methods


Inherited Variables

Inherited Methods

Class: Bs_Object

Bs_Object::Bs_Object()
Bs_Object::getErrors()
Basic error handling: Get *all* errors as string array from the global Bs_Error-error stack.
Bs_Object::getLastError()
Basic error handling: Get last error string from the global Bs_Error-error stack.
Bs_Object::getLastErrors()
Basic error handling: Get last errors string array from the global Bs_Error-error stack sinc last call of getLastErrors().
Bs_Object::persist()
Persists this object by serializing it and saving it to a file with unique name.
Bs_Object::setError()
Basic error handling: Push an error string on the global Bs_Error-error stack.
Bs_Object::toHtml()
Dumps the content of this object to a string using PHP's var_dump().
Bs_Object::toString()
Dumps the content of this object to a string using PHP's var_dump().
Bs_Object::unpersist()
Fetches an object that was persisted with persist()

Class Details

[line 22]
*********************************************************************** HtmlNavigation Xml Handler class.

dependencies: PHP.XPath,




Tags:

since:  bs4.3
version:  4.3.$Revision: 1.4 $ $Date: 2003/12/27 16:05:36 $
copyright:  blueshoes.org
author:  andrej arn <at blueshoes dot org>


[ Top ]


Class Methods


constructor Bs_HnXmlHandler [line 53]

Bs_HnXmlHandler Bs_HnXmlHandler( )

Constructor.



[ Top ]

method addNavElement [line 123]

bool addNavElement( string $otherNode, string $relation, string $caption, string $url)

adds a navigation tree element.

example: you have this structure:

home foo bar hello world

now you want to add: 1) a child of 'bar': addNavElement() 2do continue here




Tags:

access:  public


Parameters:

string   $otherNode  
string   $relation  
string   $caption  
string   $url  

[ Top ]

method getAllUrls [line 86]

array getAllUrls( [array $arr = NULL])

returns all urls.



Tags:

return:  (of strings)
access:  public


Parameters:

array   $arr   (used internally only on recursive calls!)

[ Top ]

method getNavData [line 74]

array getNavData( )

returns the navigation data.



Tags:

see:  var $_navData, $this->loadDataByXmlFile() etc
throws:  bool FALSE (if no nav data available.)
access:  public


[ Top ]

method loadDataByXmlFile [line 137]

bool loadDataByXmlFile( string $fileFullPath)

loads the navigation data using an xml file.



Tags:

return:  (see Bs_Error::getLastError() if you get FALSE.)
since:  bs4.3
see:  $this->loadDataByXmlString()
access:  public


Parameters:

string   $fileFullPath  

[ Top ]

method loadDataByXmlString [line 165]

void loadDataByXmlString( string $str)

loads the navigation data using an xml string.



Tags:

todo:  implement this
since:  bs4.3
see:  $this->loadDataByXmlFile()
access:  public


Parameters:

string   $str  

[ Top ]


Documentation generated on Mon, 29 Dec 2003 21:10:49 +0100 by phpDocumentor 1.2.3