GuestBook Class Reference

Inheritance diagram for GuestBook:

Inheritance graph
[legend]
Collaboration diagram for GuestBook:

Collaboration graph
[legend]

List of all members.


Detailed Description

Shop guestbook page. Manages, collects, denies user comments.

Public Member Functions

 render ()
 showLogin ()
 getSortColumns ()
 getGbSortBy ()
 getGbSortDir ()
 getEntries ()
 floodProtection ()
 prepareSortColumns ()
 getPageNavigation ()

Protected Attributes

 $_iCntPages = null
 $_blShowLogin = false
 $_aSortColumns = false
 $_sSortBy = false
 $_sSortDir = false
 $_blFloodProtection = null
 $_aEntries = null
 $_sThisTemplate = 'guestbook.tpl'
 $_sThisLoginTemplate = 'guestbook_login.tpl'
 $_blShowSorting = true
 $_oPageNavigation = null
 $_iViewIndexState = 1

Member Function Documentation

GuestBook.render (  ) 

Loads guestbook entries, forms guestbook naviagation URLS, executes parent.render() and returns name of template to render guestbook._sThisTemplate.

Template variables: entries, navigationPages

Returns:
string $this->_sThisTemplate current template file name

Reimplemented from oxUBase.

GuestBook.showLogin (  ) 

Sets variable bShowLogin to true

Returns:
null

GuestBook.getSortColumns (  ) 

Template variable getter. Returns sorting columns

Returns:
array

Reimplemented from oxView.

GuestBook.getGbSortBy (  ) 

Template variable getter. Returns order by

Returns:
string

GuestBook.getGbSortDir (  ) 

Template variable getter. Returns order directory

Returns:
void

GuestBook.getEntries (  ) 

Loads guestbook entries for active page and returns them.

Returns:
array $oEntries guestbook entries

GuestBook.floodProtection (  ) 

Template variable getter. Returns boolean of flood protection

Returns:
bool

GuestBook.prepareSortColumns (  ) 

Retrieves from session or gets new sorting parameters for guestbook entries. Sets new sorting parameters (reverse or new column sort) to session.

Template variables: gborderby, gborder, allsortcolumns

Session variables: gborderby, gborder

Returns:
void

Reimplemented from oxView.

GuestBook.getPageNavigation (  ) 

Template variable getter. Returns page navigation

Returns:
object


Member Data Documentation

GuestBook.$_iCntPages = null [protected]

GuestBook.$_blShowLogin = false [protected]

GuestBook.$_aSortColumns = false [protected]

GuestBook.$_sSortBy = false [protected]

GuestBook.$_sSortDir = false [protected]

GuestBook.$_blFloodProtection = null [protected]

GuestBook.$_aEntries = null [protected]

GuestBook.$_sThisTemplate = 'guestbook.tpl' [protected]

Reimplemented from oxView.

GuestBook.$_sThisLoginTemplate = 'guestbook_login.tpl' [protected]

GuestBook.$_blShowSorting = true [protected]

Reimplemented from oxView.

GuestBook.$_oPageNavigation = null [protected]

GuestBook.$_iViewIndexState = 1 [protected]

Current view search engine indexing state: 0 - index without limitations 1 - no index / no follow 2 - no index / follow

Reimplemented from oxView.


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

Generated on Wed Oct 29 23:41:51 2008 for OXID eShop CE by  doxygen 1.5.5