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

Class: Meta

Source Location: /myphp-1.9/myphp-1.9-base/html/page/Meta.php

Class Meta

Class Overview

The Meta Object.

The Meta object is used to define the html meta tags for a page NOTE: The header() function is called inside the file HTML_PAGE_PATH.'/Cache.php, if no cache is defined

  1. Usage:
  2. $meta = new Meta($title,$description,$keyword,$keywords,$language);
  3. print $meta->getHtml();
  4. Or
  5. Meta::display($title,$description,$keyword,$keywords,$language);

Located in /myphp-1.9/myphp-1.9-base/html/page/Meta.php [line 32]

Object
   |
   --Html
      |
      --Meta

Properties

Methods

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

Inherited From Html

Html::$elements
Html::$sizeof

Inherited From Object

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

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 ]
Property Summary
mixed   $author  
mixed   $Cache_Control  
mixed   $Content_Language  
mixed   $Content_Type  
mixed   $copyright  
mixed   $description  
mixed   $Expires  
mixed   $keyword  
mixed   $keywords  
mixed   $Pragma  
mixed   $robots  
mixed   $title  

[ Top ]
Method Summary
Meta   Meta()   Constructor
void   display()   Display html
String   getContent()   Get Meta name Content.
String   getHtml()   Get html
String   getHttpEquiv()   Get Meta http-equiv Content.

[ Top ]
Properties
mixed   $author = '' [line 40]

[ Top ]
mixed   $Cache_Control = '' [line 46]

[ Top ]
mixed   $Content_Language = '' [line 43]

[ Top ]
mixed   $Content_Type = '' [line 42]

[ Top ]
mixed   $copyright = '' [line 39]

[ Top ]
mixed   $description = '' [line 34]

[ Top ]
mixed   $Expires = '' [line 45]

[ Top ]
mixed   $keyword = '' [line 35]

[ Top ]
mixed   $keywords = '' [line 36]

[ Top ]
mixed   $Pragma = '' [line 47]

[ Top ]
mixed   $robots = '' [line 38]

[ Top ]
mixed   $title = '' [line 33]

[ Top ]
Methods
Constructor Meta  [line 57]

  Meta Meta( [String $title = ''], [String $description = ''], [String $keyword = ''], [String $keywords = ''], [String $language = '']  )

Constructor

Parameters:
String   $title:  The title of the page
String   $description:  The description of the page
String   $keyword:  The unique keyword for this page (internal usage)
String   $keywords:  The keywords for the page
String   $language:  The language for the page


[ Top ]
display  [line 168]

  void display( [String $title = ''], [String $description = ''], [String $keyword = ''], [String $keywords = ''], [String $language = '']  )

Display html

  1. Usage:
  2. Meta::display($title,$description,$keyword,$keywords,$language);

Parameters:
String   $title:  The title of the page
String   $description:  The description of the page
String   $keyword:  The unique keyword for this page
String   $keywords:  The keywords for the page
String   $language:  The language for the page

API Tags:
Static:  


Redefinition of:
Html::display()
Display the html

[ Top ]
getContent  [line 132]

  String getContent( $name, $name  )

Get Meta name Content.

Returns the html for the meta name/content

Parameters:
$name,   $name:  the name of the meta tag

API Tags:
Return:  the complete html


[ Top ]
getHtml  [line 103]

  String getHtml( )

Get html

Returns the meta data for the page


API Tags:
Return:  the complete html


Redefinition of:
Html::getHtml()
Get Html

[ Top ]
getHttpEquiv  [line 147]

  String getHttpEquiv( $name, $name  )

Get Meta http-equiv Content.

Get the html for the meta http-equiv/content Any '_' in the $name, are automatically replaced with '-'

Parameters:
$name,   $name:  The name of the meta tag

API Tags:
Return:  The complete html


[ Top ]

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