phpDocumentor base
[ class tree: base ] [ index: base ] [ all elements ]

Class: Links

Source Location: /myphp-1.9/myphp-1.9-base/html/util/Links.php

Class Links

Class Overview

Returns a complete predefined Link as HTML.

The link is found by the $name

  1. Usage:
  2. $html = new Links($name,$text,$class,$title,$aux,$target);
  3. print $html->getHtml();
  4. Or
  5. Links::display($name,$text,$class,$title,$aux,$target);

Located in /myphp-1.9/myphp-1.9-base/html/util/Links.php [line 39]

Object
   |
   --Html
      |
      --Link
         |
         --Links

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Link

Link::$aux
Link::$class
Link::$href
Link::$name
Link::$target
Link::$text
Link::$title

Inherited From Html

Html::$elements
Html::$sizeof

Inherited From Object

Object::$cachefile
Object::$html
Object::$sql

Inherited From Link

Link::Link()
Constructor
Link::display()
Display html
Link::getHtml()
Get the complete html for a link
Link::getParams()
Get the complete html for a link

Inherited From Html

Html::Html()
Constructor
Html::add()
Add an element, the number of elements are stored internally in an array.
Html::content()
Read the content of the specified filename
Html::display()
Display the html
Html::get()
Get the complete html for a key
Html::getAttribute()
Get the complete html for an attribute, i.e. <a class="myclass" ...
Html::getElement()
Get the element at position $i in array
Html::getElements()
Get all the elements as html
Html::getHtml()
Get Html
Html::getHtmlHelp()
Get html help
Html::getSizeof()
Get the number of elements added
Html::getTag()
Get the complete html for a html tag, i.e. <p>My paragraph</p>
Html::read()
Read the content of the specified filename and language
Html::set()
Set the named attribute (key) of a class to specified value
Html::setObject()
Set the named object to the class attribute (key), with same name
Html::showsource()
Show source
Html::update()
Save the content of the specified filename and language

Inherited From Object

Object::Object()
Constructor
Object::addHtml()
Add the current html to the SourceCode object
Object::getCacheFileName()
Returns the name of the cache file name
Object::getClassName()
Returns the name of the instanciated class
Object::getHtml()
Returns the html for the element
Object::getMsg()
Get the formatted message and debug level and Log to file ?
Object::save()
Save the SQL cache file
Object::setCacheFileName()
Set the path/name of the cache file
Object::toString()
Returns the information for this class
Object::write()
Write the content to the file opened by fp

[ Top ]
Method Summary
Links   Links()   Constructor
String   changeLanguage()   Change to the new language
void   display()   Display a prdefined link, when the LINK_name is supplied
String   setLink()   Get the complete html for a Link

[ Top ]
Methods
Constructor Links  [line 49]

  Links Links( [String $name = ''], [String $text = ''], [String $class = ''], [String $title = ''], [String $aux = ''], [String $target = '']  )

Constructor

Parameters:
String   $name:  The name of an image i.e. 'logo'
String   $text:  The text for the link
String   $class:  The css class of the link
String   $title:  The tool tip of the link
String   $aux:  Add 'br' or 'li' html tags, if required
String   $target:  The target for the link I.e. _BLANK


[ Top ]
changeLanguage  [line 327]

  String changeLanguage( String $language  )

Change to the new language

Parameters:
String   $language:  The new Language

API Tags:
Return:  The html


[ Top ]
display  [line 361]

  void display( [String $name = ''], [String $text = ''], [String $class = ''], [String $title = ''], [String $aux = ''], [String $target = '']  )

Display a prdefined link, when the LINK_name is supplied

  1. Usage:
  2. Links::display($name,$text,$class,$title,$aux,$target);

Parameters:
String   $name:  The name of an image i.e. 'logo'
String   $text:  The text for the link
String   $class:  The css class of the link
String   $title:  The tool tip of the link
String   $aux:  Add 'br' or 'li' html tags, if required
String   $target:  The target for the link. I.e. _BLANK

API Tags:
Static:  


Redefinition of:
Link::display()
Display html

[ Top ]
setLink  [line 60]

  String setLink( String $name  )

Get the complete html for a Link

Parameters:
String   $name:  The name of a link i.e. 'print'

API Tags:
Return:  the html


[ Top ]

Documentation generated on Thu, 22 Dec 2005 17:12:55 +0100 by phpDocumentor 1.3.0RC3