GuestBook Class Reference

Inheritance diagram for GuestBook:

[legend]

Collaboration diagram for GuestBook:

[legend]

List of all members.

---

Detailed Description

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

Definition at line 7 of file guestbook.php.

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.

Definition at line 93 of file guestbook.php.

GuestBook.showLogin

(

)

Sets variable bShowLogin to true

Returns:

null

Definition at line 128 of file guestbook.php.

GuestBook.getSortColumns

(

)

Template variable getter. Returns sorting columns

Returns:

array

Reimplemented from oxView.

Definition at line 138 of file guestbook.php.

GuestBook.getGbSortBy

(

)

Template variable getter. Returns order by

Returns:

string

Definition at line 148 of file guestbook.php.

GuestBook.getGbSortDir

(

)

Template variable getter. Returns order directory

Returns:

void

Definition at line 158 of file guestbook.php.

GuestBook.getEntries

(

)

Loads guestbook entries for active page and returns them.

Returns:

array $oEntries guestbook entries

Definition at line 168 of file guestbook.php.

GuestBook.floodProtection

(

)

Template variable getter. Returns boolean of flood protection

Returns:

bool

Definition at line 190 of file guestbook.php.

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.

Definition at line 218 of file guestbook.php.

GuestBook.getPageNavigation

(

)

Template variable getter. Returns page navigation

Returns:

object

Definition at line 254 of file guestbook.php.

---

Member Data Documentation

GuestBook.$_iCntPages = null [protected]

Definition at line 13 of file guestbook.php.

GuestBook.$_blShowLogin = false [protected]

Definition at line 19 of file guestbook.php.

GuestBook.$_aSortColumns = false [protected]

Definition at line 25 of file guestbook.php.

GuestBook.$_sSortBy = false [protected]

Definition at line 31 of file guestbook.php.

GuestBook.$_sSortDir = false [protected]

Definition at line 37 of file guestbook.php.

GuestBook.$_blFloodProtection = null [protected]

Definition at line 43 of file guestbook.php.

GuestBook.$_aEntries = null [protected]

Definition at line 49 of file guestbook.php.

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

Reimplemented from oxView.

Reimplemented in GuestbookEntry.

Definition at line 55 of file guestbook.php.

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

Definition at line 61 of file guestbook.php.

GuestBook.$_blShowSorting = true [protected]

Reimplemented from oxView.

Definition at line 67 of file guestbook.php.

GuestBook.$_oPageNavigation = null [protected]

Definition at line 73 of file guestbook.php.

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.

Definition at line 81 of file guestbook.php.

---

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

• views/guestbook.php