GuestBook Class Reference

Inheritance diagram for GuestBook:

Collaboration diagram for GuestBook:

List of all members.

Public Member Functions
	render ()
	getSortColumns ()
	getGbSortBy ()
	getGbSortDir ()
	getEntries ()
	floodProtection ()
	getSortOrderByParameterName ()
	getSortOrderParameterName ()
	getSortIdent ()
	getDefaultSorting ()
	prepareSortColumns ()
	getPageNavigation ()
	saveEntry ()
	getBreadCrumb ()
Protected Attributes
	$_iCntPages = null
	$_blShowLogin = false
	$_aSortColumns = null
	$_sListOrderBy = false
	$_sListOrderDir = false
	$_blFloodProtection = null
	$_aEntries = null
	$_sThisTemplate = 'page/guestbook/guestbook.tpl'
	$_sThisLoginTemplate = 'page/guestbook/guestbook_login.tpl'
	$_blShowSorting = true
	$_oPageNavigation = null
	$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

---

Detailed Description

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

Definition at line 7 of file guestbook.php.

---

Member Function Documentation

GuestBook.floodProtection

(

)

Template variable getter. Returns boolean of flood protection

Returns:

bool

Definition at line 165 of file guestbook.php.

GuestBook.getBreadCrumb

(

)

Returns Bread Crumb - you are here page1/page2/page3...

Returns:

array

Reimplemented from oxUBase.

Definition at line 336 of file guestbook.php.

GuestBook.getDefaultSorting

(

)

Returns default category sorting for selected category

Returns:

array

Reimplemented from oxUBase.

Definition at line 214 of file guestbook.php.

GuestBook.getEntries

(

)

Loads guestbook entries for active page and returns them.

Returns:

array $oEntries guestbook entries

Definition at line 142 of file guestbook.php.

GuestBook.getGbSortBy

(

)

Template variable getter. Returns order by

Returns:

string

Definition at line 122 of file guestbook.php.

GuestBook.getGbSortDir

(

)

Template variable getter. Returns order directory

Returns:

void

Definition at line 132 of file guestbook.php.

GuestBook.getPageNavigation

(

)

Template variable getter. Returns page navigation

Returns:

object

Reimplemented from oxUBase.

Definition at line 271 of file guestbook.php.

GuestBook.getSortColumns

(

)

Template variable getter. Returns sorting columns

Returns:

array

Reimplemented from oxUBase.

Definition at line 109 of file guestbook.php.

GuestBook.getSortIdent

(

)

Returns page sort indentificator. It is used as intentificator in session variable aSorting[ident]

Returns:

string

Reimplemented from oxUBase.

Definition at line 204 of file guestbook.php.

GuestBook.getSortOrderByParameterName

(

)

Returns sorted column parameter name

Returns:

string

Reimplemented from oxUBase.

Definition at line 184 of file guestbook.php.

GuestBook.getSortOrderParameterName

(

)

Returns sorted column direction parameter name

Returns:

string

Reimplemented from oxUBase.

Definition at line 194 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

Deprecated:

since v4.7.3/5.0.3 (2013-01-07); use getSorting();

Returns:

void

Reimplemented from oxUBase.

Definition at line 235 of file guestbook.php.

GuestBook.render

(

)

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

Returns:

string $this->_sThisTemplate current template file name

Reimplemented from oxUBase.

Definition at line 90 of file guestbook.php.

GuestBook.saveEntry

(

)

Method applies validation to entry and saves it to DB. On error/success returns name of action to perform (on error: "guestbookentry?error=x"", on success: "guestbook").

Returns:

string

Reimplemented in GuestbookEntry.

Definition at line 287 of file guestbook.php.

---

Member Data Documentation

GuestBook.$_aEntries = null [protected]

Definition at line 49 of file guestbook.php.

GuestBook.$_aSortColumns = null [protected]

Reimplemented from oxUBase.

Definition at line 25 of file guestbook.php.

GuestBook.$_blFloodProtection = null [protected]

Definition at line 43 of file guestbook.php.

GuestBook.$_blShowLogin = false [protected]

Definition at line 19 of file guestbook.php.

GuestBook.$_blShowSorting = true [protected]

Reimplemented from oxUBase.

Definition at line 67 of file guestbook.php.

GuestBook.$_iCntPages = null [protected]

Definition at line 13 of file guestbook.php.

GuestBook.$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW [protected]

Current view search engine indexing state: VIEW_INDEXSTATE_INDEX - index without limitations VIEW_INDEXSTATE_NOINDEXNOFOLLOW - no index / no follow VIEW_INDEXSTATE_NOINDEXFOLLOW - no index / follow

Reimplemented from oxUBase.

Definition at line 80 of file guestbook.php.

GuestBook.$_oPageNavigation = null [protected]

Definition at line 73 of file guestbook.php.

GuestBook.$_sListOrderBy = false [protected]

Reimplemented from oxUBase.

Definition at line 31 of file guestbook.php.

GuestBook.$_sListOrderDir = false [protected]

Reimplemented from oxUBase.

Definition at line 37 of file guestbook.php.

GuestBook.$_sThisLoginTemplate = 'page/guestbook/guestbook_login.tpl' [protected]

Definition at line 61 of file guestbook.php.

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

Reimplemented from oxView.

Reimplemented in GuestbookEntry.

Definition at line 55 of file guestbook.php.

---

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

• application/controllers/guestbook.php