phpDocumentor page
[ class tree: page ] [ index: page ] [ all elements ]
page
Packages:
base
cache
component
db
db-init
ecommerce
file
form
layout
log
menu
mvc
myPHP
page
profiler
sax
showsource
sms
summa
tab
table
template
tree-node
util

Files:
Comment.php
Define.php
Div.php
Document.php
Header.php
Hr.php
Iframe.php
index.php
init.php
Li.php
myphp-package.php
Ol.php
Page.php
Paragraph.php
Setup.php
Span.php
Tag.php
Text.php
Ul.php

Classes:
Comment
Div
Document
Header
Hr
Iframe
Li
Ol
Page
Paragraph
Span
Tag
Text
Ul

Class: Page

Source Location: /myphp-1.9/myphp-1.9-page/html/component/Page.php

Class Page

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail

Generates the html for a Page. This is the taglib 

  1.  Usage:
    2. 

  2.    $page = new Page();
    3. 

  3.    print $page->getHtml();
    4. 

  4.  Or:
    5. 

  5.    Page::display();
    6. 

  6.    Page::p('Some Paragraph');
    7.

Located in /myphp-1.9/myphp-1.9-page/html/component/Page.php [line 70] 

Object
   |
   --Html
      |
      --Page

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail
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 ]
Method Summary
Class Overview | Inherited Properties and Methods | Properties Method Summary | Methods Detail
Page   Page()   Constructor
void   banner()   Display banner
void   bannerif()   Display bannerif
void   bodyend()   Display bodyend
void   bodystart()   Display bodystart
void   bottommenu()   Display bottommenu
void   br()   Display br
void   comment()   Display comment
void   company()   Display company
void   copyright()   Display copyright
void   css()   Display css
void   customer()   Display customer
void   display()   Display html
void   doctype()   Display doctype
void   end()   Display end
void   footer()   Display footer
String   getHtml()   Returns the content html for the page
void   google()   Display google
void   googleend()   Display googleend
void   googlestart()   Display googlestart
void   h1()   Display h1
void   h2()  
void   h3()  
void   h4()  
void   h5()  
void   h6()  
void   headstart()   Display headstart
void   hr()   Display hr
void   iframe()   Display iframe
void   image()   Display image
void   imagelink()   Display imagelink
void   imagerotator()   Display imagerotator
void   javascript()   Display javascript
void   leftmenu()   Display leftmenu
void   li()   Display li
void   line()   Display line
void   link()   Display link
void   locator()   Display locator
void   mailto()   Display mailto
void   menulink()   Display menulink
void   meta()   Display meta
void   metarotator()   Display metarotator
void   noscript()   Display noscript
void   p()   Display p
void   rightmenu()   Display rightmenu
void   shortcuticon()   Display shortcuticon
void   show()   Display all
void   start()   Display start
void   text()   Display text
void   title()   Display title
void   topmenu()   Display topmenu

[ Top ]
Properties
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Methods
Class Overview | Inherited Properties and Methods | | Properties | Method Summary | Methods Detail
Constructor Page  [line 75]

  Page Page( )

Constructor



[ Top ]
banner  [line 548]

  void banner( [String $width = ''], [mixed $link = ''], [mixed $imagelink = ''], String $link_id, String $imagelink_id  )

Display banner 

  1.  Usage:
    2. 

  2.     Page::banner($width,$link,$imagelink);
    3.

Parameters:
String   $width:  The width of the table
String   $link_id:  The link object to use
String   $imagelink_id:  The imagelink object to use

API Tags:
Static:  


[ Top ]
bannerif  [line 561]

  void bannerif( [String $width = '']  )

Display bannerif 

  1.  Usage:
    2. 

  2.     Page::bannerif($width);
    3.

Parameters:
String   $width:  The width of the table

API Tags:
Static:  


[ Top ]
bodyend  [line 768]

  void bodyend( )

Display bodyend 

  1.  Usage:
    2. 

  2.     Page::bodyend();
    3.


API Tags:
Static:  


[ Top ]
bodystart  [line 503]

  void bodystart( )

Display bodystart 

  1.  Usage:
    2. 

  2.     Page::bodystart();
    3.


API Tags:
Static:  


[ Top ]
bottommenu  [line 689]

  void bottommenu( [String $links = ''], [String $text = ''], [String $width = ''], [String $class = '']  )

Display bottommenu 

  1.  Usage:
    2. 

  2.     Page::bottommenu($links,$text,$width,$class);
    3.

Parameters:
String   $links:  An array of links
String   $text:  The text above the menu links
String   $width:  The width of the menu
String   $class:  The css class for the menu

API Tags:
Static:  


[ Top ]
br  [line 258]

  void br( )

Display br 

  1.  Usage:
    2. 

  2.     Page::br();
    3.


API Tags:
Static:  


[ Top ]
comment  [line 284]

  void comment( [String $text = '']  )

Display comment 

  1.  Usage:
    2. 

  2.     Page::comment($text);
    3.

Parameters:
String   $text:  The text to add as comment

API Tags:
Static:  


[ Top ]
company  [line 730]

  void company( [String $text = ''], [String $width = ''], [mixed $class = ''], [mixed $border = ''], [mixed $cellPadding = ''], [mixed $cellSpacing = '']  )

Display company 

  1.  Usage:
    2. 

  2.     Page::company($text,$width);
    3.

Parameters:
String   $text:  The text of the table
String   $width:  The width of the table, default 100%

API Tags:
Static:  


[ Top ]
copyright  [line 702]

  void copyright( [String $width = '']  )

Display copyright 

  1.  Usage:
    2. 

  2.     Page::copyright($width);
    3.

Parameters:
String   $width:  The width of the table, default 100%

API Tags:
Static:  


[ Top ]
css  [line 465]

  void css( [String $href = '']  )

Display css 

  1.  Usage:
    2. 

  2.     Page::css($href);
    3.

Parameters:
String   $href:  The url to the css file (i.e. /css/my.css)

API Tags:
Static:  


[ Top ]
customer  [line 716]

  void customer( [String $text = ''], [String $width = ''], [mixed $class = ''], [mixed $border = ''], [mixed $cellPadding = ''], [mixed $cellSpacing = '']  )

Display customer 

  1.  Usage:
    2. 

  2.     Page::customer($text,$width);
    3.

Parameters:
String   $text:  The text of the table
String   $width:  The width of the table, default 100%

API Tags:
Static:  


[ Top ]
display  [line 156]

  void display( )

Display html 

  1.  Usage:
    2. 

  2.     Page::display();
    3.


API Tags:
Static:  

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

[ Top ]
doctype  [line 396]

  void doctype( [String $doctype = '']  )

Display doctype 

  1.  Usage:
    2. 

  2.     Page::doctype($doctype);
    3.

Parameters:
String   $doctype:  The doctype to use

API Tags:
Static:  


[ Top ]
end  [line 188]

  void end( [mixed $element = '']  )

Display end 

  1.  Usage:
    2. 

  2.     Page::end();     // Generates an end of PAGE
    3. 

  3.     Page::end('ul'); // Generates an end </ul>
    4. 

  4.     Page::end('p');  
    5.


API Tags:
Static:  


[ Top ]
footer  [line 756]

  void footer( [String $width = '']  )

Display footer 

  1.  Usage:
    2. 

  2.     Page::footer($width);
    3.

Parameters:
String   $width:  The width of the table, default 100%

API Tags:
Static:  


[ Top ]
getHtml  [line 83]

  String getHtml( )

Returns the content html for the page


API Tags:
Return:  the complete html

Redefinition of:
Html::getHtml()
Get Html

[ Top ]
google  [line 600]

  void google( [mixed $text = ''], String $tex,  )

Display google 

  1.  Usage:
    2. 

  2.     Page::google($text);
    3.

Parameters:
String   $tex,:  The default search pattern

API Tags:
Static:  


[ Top ]
googleend  [line 612]

  void googleend( )

Display googleend 

  1.  Usage:
    2. 

  2.     Page::googleend();
    3.


API Tags:
Static:  


[ Top ]
googlestart  [line 587]

  void googlestart( )

Display googlestart 

  1.  Usage:
    2. 

  2.     Page::googlestart();
    3.


API Tags:
Static:  


[ Top ]
h1  [line 231]

  void h1( String $text, [String $class = ''], [String $name = '']  )

Display h1 

  1.  Usage:
    2. 

  2.     Page::h1($text,$class,$name);
    3.

Parameters:
String   $text:  The text to show with <h1>$text</h1>
String   $class:  The css class name
String   $name:  The name/id attribute for a link identifier

API Tags:
Static:  


[ Top ]
h2  [line 234]

  void h2( mixed $text, [mixed $class = ''], [mixed $name = '']  )



[ Top ]
h3  [line 237]

  void h3( mixed $text, [mixed $class = ''], [mixed $name = '']  )



[ Top ]
h4  [line 240]

  void h4( mixed $text, [mixed $class = ''], [mixed $name = '']  )



[ Top ]
h5  [line 243]

  void h5( mixed $text, [mixed $class = ''], [mixed $name = '']  )



[ Top ]
h6  [line 246]

  void h6( mixed $text, [mixed $class = ''], [mixed $name = '']  )



[ Top ]
headstart  [line 408]

  void headstart( )

Display headstart 

  1.  Usage:
    2. 

  2.     Page::headstart();
    3.


API Tags:
Static:  


[ Top ]
hr  [line 271]

  void hr( [String $class = '']  )

Display hr 

  1.  Usage:
    2. 

  2.     Page::hr($class);
    3.

Parameters:
String   $class:  The css class name

API Tags:
Static:  


[ Top ]
iframe  [line 367]

  void iframe( [mixed $src = ''], String $srct  )

Display iframe 

  1.  Usage:
    2. 

  2.     Page::iframe($src);
    3. 

  3.  will insert an iframe here
    4.

Parameters:
String   $srct:  The source path for the html to iframe

API Tags:
Static:  


[ Top ]
image  [line 353]

  void image( [mixed $src = ''], [String $width = ''], [String $height = ''], [String $alt = ''], [String $class = ''], [String $border = ''], String $srct  )

Display image 

  1.  Usage:
    2. 

  2.     Page::image($src,$width,$height,$alt,$class,$border);
    3. 

  3.  will insert an image here
    4.

Parameters:
String   $srct:  The source path for the image
String   $width:  The width
String   $height:  The height
String   $alt:  The alt text
String   $class:  The css class for the image
String   $border:  The border of an image

API Tags:
Static:  


[ Top ]
imagelink  [line 381]

  void imagelink( [String $image = ''], [String $link = '']  )

Display imagelink 

  1.  Usage:
    2. 

  2.     Page::imagelink($image, $link);
    3.

Parameters:
String   $image:  The image object to show
String   $link:  The link object to go to

API Tags:
Static:  


[ Top ]
imagerotator  [line 743]

  void imagerotator( [String $path = '']  )

Display imagerotator 

  1.  Usage:
    2. 

  2.     Page::imagerotator($path);
    3.

Parameters:
String   $path:  The path to the images to rotate

API Tags:
Static:  


[ Top ]
javascript  [line 478]

  void javascript( [String $href = '']  )

Display javascript 

  1.  Usage:
    2. 

  2.     Page::javascript($href);
    3.

Parameters:
String   $href:  The url to the Javascript file (i.e. /include/my.js)

API Tags:
Static:  


[ Top ]
leftmenu  [line 657]

  void leftmenu( [String $links = ''], [String $text = ''], [String $width = ''], [String $class = '']  )

Display leftmenu 

  1.  Usage:
    2. 

  2.     Page::leftmenu($links,$text,$width,$class);
    3.

Parameters:
String   $links:  an array of links
String   $text:  The text above the menu links
String   $width:  The width of the menu
String   $class:  The css class for the menu

API Tags:
Static:  


[ Top ]
li  [line 202]

  void li( String $text, [String $class = '']  )

Display li 

  1.  Usage:
    2. 

  2.     Page::li($text,$class);
    3.

Parameters:
String   $text:  The text to show with <li>$text</li>
String   $class:  The css class name

API Tags:
Static:  


[ Top ]
line  [line 533]

  void line( [String $width = ''], [String $height = ''], [String $class = ''], [String $border = ''], [String $cellPadding = ''], [String $cellSpacing = '']  )

Display line 

  1.  Usage:
    2. 

  2.     Page::line($width,$height,$class);
    3.

Parameters:
String   $width:  The width of the table
String   $height:  The height of the line
String   $class:  The css class to use
String   $border:  The table border
String   $cellPadding: 
String   $cellSpacing: 

API Tags:
Static:  


[ Top ]
link  [line 317]

  void link( [String $text = ''], [String $href = ''], [String $class = ''], [String $title = ''], [String $aux = '']  )

Display link 

  1.  Usage:
    2. 

  2.     Page::link($text,$href,$class,$title,$aux);
    3.

Parameters:
String   $text:  The text for the link
String   $href:  The url 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 Pages, if required

API Tags:
Static:  


[ Top ]
locator  [line 575]

  void locator( [String $width = ''], [String $class = '']  )

Display locator 

  1.  Usage:
    2. 

  2.     Page::locator($width,$class);
    3.

Parameters:
String   $width:  The width of the table
String   $class:  The css class of the table

API Tags:
Static:  


[ Top ]
mailto  [line 334]

  void mailto( [String $text = ''], [String $href = ''], [String $class = ''], [String $title = ''], [String $aux = '']  )

Display mailto 

  1.  Usage:
    2. 

  2.     Page::mailto($text,$href,$class,$title,$aux);
    3.

Parameters:
String   $text:  The text for the link
String   $href:  The url 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 Pages, if required

API Tags:
Static:  


[ Top ]
menulink  [line 641]

  void menulink( [String $path = '']  )

Display menulink 

  1.  Usage:
    2. 

  2.     Page::menulink($path);
    3.

Parameters:
String   $path:  The directory path to start from

API Tags:
Static:  


[ Top ]
meta  [line 437]

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

Display meta 

  1.  Usage:
    2. 

  2.     Page::meta('the title','the description','the keyword','keyword1,keyword2,...');
    3.

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

API Tags:
Static:  


[ Top ]
metarotator  [line 452]

  void metarotator( [String $group = ''], [String $keyword = ''], [String $file = '']  )

Display metarotator 

  1.  Usage:
    2. 

  2.     Page::metarotator($group,$keyword,$file);
    3.

Parameters:
String   $group:  The Meta group to use
String   $keyword:  The Meta keyword to use
String   $file:  The Meta file to use

API Tags:
Static:  


[ Top ]
noscript  [line 515]

  void noscript( )

Display noscript 

  1.  Usage:
    2. 

  2.     Page::noscript();
    3.


API Tags:
Static:  


[ Top ]
p  [line 216]

  void p( String $text, [String $class = '']  )

Display p 

  1.  Usage:
    2. 

  2.     Page::p($text,$class);
    3.

Parameters:
String   $text:  The text to show with <p>$text</p>
String   $class:  The css class name

API Tags:
Static:  


[ Top ]
rightmenu  [line 673]

  void rightmenu( [String $links = ''], [String $text = ''], [String $width = ''], [String $class = '']  )

Display rightmenu 

  1.  Usage:
    2. 

  2.     Page::rightmenu($links,$text,$width,$class);
    3.

Parameters:
String   $links:  an array of links
String   $text:  The text above the menu links
String   $width:  The width of the menu
String   $class:  The css class for the menu

API Tags:
Static:  


[ Top ]
shortcuticon  [line 491]

  void shortcuticon( [String $href = '']  )

Display shortcuticon 

  1.  Usage:
    2. 

  2.     Page::shortcuticon($href);
    3.

Parameters:
String   $href:  The url to the Shortcut Icon

API Tags:
Static:  


[ Top ]
show  [line 97]

  void show( )

Display all 

  1.  Usage:
    2. 

  2.     Page::show();
    3.


API Tags:
Static:  


[ Top ]
start  [line 174]

  void start( String $element, [String $class = '']  )

Display start 

  1.  Usage:
    2. 

  2.     Page::start('ul'); // Generates a start <ul>
    3. 

  3.     Page::start('p');  
    4.

Parameters:
String   $element:  The html element, Valid elements: p,br,h1..h6,li,b,pre
String   $class:  The css class name

API Tags:
Static:  


[ Top ]
text  [line 300]

  void text( [String $text = ''], [String $element = ''], [String $class = '']  )

Display text 

  1.  Usage:
    2. 

  2.     Page::text(