OXID eShop CE  4.8.10
 All Classes Files Functions Variables Pages
Public Member Functions | Protected Attributes | List of all members
GuestBook Class Reference
+ Inheritance diagram for GuestBook:
+ Collaboration diagram for GuestBook:

Public Member Functions

 render ()
 getSortColumns ()
 getGbSortBy ()
 getGbSortDir ()
 getEntries ()
 floodProtection ()
 getSortOrderByParameterName ()
 getSortOrderParameterName ()
 getSortIdent ()
 getDefaultSorting ()
 prepareSortColumns ()
 getPageNavigation ()
 saveEntry ()
 getBreadCrumb ()
- Public Member Functions inherited from oxUBase
 init ()
 getViewId ()
 showSorting ()
 setComponents ($aComponents=null)
 getComponents ()
 getComponent ($sName)
 setIsOrderStep ($blIsOrderStep=null)
 getIsOrderStep ()
 setActiveCategory ($oCategory)
 getActiveCategory ()
 getListType ()
 getListDisplayType ()
 getCustomListDisplayType ()
 setListType ($sType)
 loadCurrency ()
 dontShowEmptyCategories ()
 showCategoryArticlesCount ()
 isLanguageLoaded ()
 getTopNavigationCatCnt ()
 addRssFeed ($sTitle, $sUrl, $key=null)
 getUserSelectedSorting ()
 getSavedSorting ($sSortIdent)
 setListOrderBy ($sColumn)
 setListOrderDirection ($sDirection)
 getListOrderBy ()
 getListOrderDirection ()
 setMetaDescription ($sDescription)
 setMetaKeywords ($sKeywords)
 getMetaKeywords ()
 getMetaDescription ()
 getActCurrency ()
 setActCurrency ($oCur)
 getCompareItemCount ()
 noIndex ()
 isSortingActive ()
 getMenueList ()
 setMenueList ($aMenue)
 getNavigationParams ()
 setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
 getSorting ($sSortIdent)
 getSortingSql ($sIdent)
 getTitleSuffix ()
 getTitlePageSuffix ()
 getTitlePrefix ()
 getDynUrlParams ()
 getLink ($iLang=null)
 getCanonicalUrl ()
 getSimilarRecommListIds ()
 getSearchParamForHtml ()
 showSearch ()
 getRssLinks ()
 setSortColumns ($aSortColumns)
 getEditTags ()
 getRecommSearch ()
 getPaymentList ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtTheseProducts ()
 getArticleId ()
 getTitle ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 getAdditionalParams ()
 generatePageNavigationUrl ()
 getPageNavigationLimitedTop ($iPositionCount=7)
 getPageNavigationLimitedBottom ($iPositionCount=11)
 generatePageNavigation ($iPositionCount=0)
 getViewProduct ()
 setViewProduct ($oProduct)
 getViewProductList ()
 getActPage ()
 getActTag ()
 getActVendor ()
 getActManufacturer ()
 setActVendor ($oVendor)
 setActManufacturer ($oManufacturer)
 getActSearch ()
 getCategoryTree ()
 setCategoryTree ($oCatTree)
 getManufacturerTree ()
 setManufacturerTree ($oManufacturerTree)
 getAddUrlParams ()
 getTop5ArticleList ($iCount=null)
 getBargainArticleList ()
 isLowOrderPrice ()
 getMinOrderPrice ()
 getNewsRealStatus ()
 getProduct ()
 getManufacturerlist ()
 setManufacturerlist ($aList)
 setRootVendor ($oVendor)
 getRootVendor ()
 setRootManufacturer ($oManufacturer)
 getRootManufacturer ()
 getVendorId ()
 getManufacturerId ()
 getSearchCatTree ()
 setSearchCatTree ($aTree)
 getCatMoreUrl ()
 getCatTreePath ()
 getContentByIdent ($sIdent)
 getContentCategory ()
 getMustFillFields ()
 isFieldRequired ($sField)
 getFormId ()
 canAcceptFormData ()
 getPromoFinishedList ()
 getPromoCurrentList ()
 getPromoFutureList ()
 getShowPromotionList ()
 isEnabledPrivateSales ()
 getFieldValidationErrors ()
 setRootCatChanged ($blRootCatChanged)
 isRootCatChanged ()
 getInvoiceAddress ()
 getDeliveryAddress ()
 setDeliveryAddress ($aDeliveryAddress)
 setInvoiceAddress ($aAddress)
 getActiveUsername ()
 getWishlistUserId ()
 getSearchCatId ()
 getSearchVendor ()
 getSearchManufacturer ()
 getLastProducts ()
 getNewBasketItemMsgType ()
 isActive ($sName)
 isFbWidgetVisible ()
 isEnabledDownloadableFiles ()
 showRememberMe ()
 isVatIncluded ()
 isPriceCalculated ()
 showTags ()
 getWishlistName ()
 getWidgetLink ()
- Public Member Functions inherited from oxView
 setViewParameters ($aParams=null)
 getViewParameter ($sKey)
 setIsCallForCache ($blIsCallForCache=null)
 getIsCallForCache ()
 addTplParam ($sPara, $sValue)
 getBelboonParam ()
 getViewConfig ()
 getTemplateName ()
 setTemplateName ($sTemplate)
 setClassName ($sClassName)
 getClassName ()
 setFncName ($sFncName)
 getFncName ()
 setViewData ($aViewData=null)
 getViewData ()
 getViewDataElement ($sParamId=null)
 setClassLocation ($sClassLocation=null)
 getClassLocation ()
 setThisAction ($sThisAction=null)
 getThisAction ()
 setParent ($oParent=null)
 getParent ()
 setIsComponent ($blIsComponent=null)
 getIsComponent ()
 executeFunction ($sFunction)
 getTrustedShopId ()
 getTSExcellenceId ()
 getCharSet ()
 getShopVersion ()
 getShopEdition ()
 getRevision ()
 getPackageInfo ()
 getShopFullEdition ()
 isDemoVersion ()
 isBetaVersion ()
 isRCVersion ()
 showBetaNote ()
 isDemoShop ()
 showNewsletter ()
 setShowNewsletter ($blShow)
 getShopLogo ()
 setShopLogo ($sLogo)
 getActCategory ()
 setActCategory ($oCategory)
 getCategoryId ()
 setCategoryId ($sCategoryId)
 getErrorDestination ()
 getActionClassName ()
 isConnectedWithFb ()
 getFbUserId ()
 showFbConnectToAccountMsg ()
 isMall ()
 showRdfa ()
 getSidForWidget ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

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
- Protected Attributes inherited from oxUBase
 $_blFbWidgetsOn = null
 $_sRemoveMetaChars = '.\+*?[^]$(){}=!<>|:&'
 $_oaComponents = array()
 $_blIsOrderStep = false
 $_sListType = null
 $_aListDisplayTypes = array( 'grid', 'line', 'infogrid' )
 $_sListDisplayType = null
 $_sCustomListDisplayType = null
 $_oActCategory = null
 $_oActManufacturer = null
 $_oActVendor = null
 $_oActiveRecommList = null
 $_oActSearch = null
 $_blShowSorting = false
 $_blLoadCurrency = null
 $_blLoadManufacturerTree = null
 $_blDontShowEmptyCats = null
 $_blLoadLanguage = null
 $_iTopCatNavItmCnt = null
 $_aRssLinks = null
 $_sListOrderBy = null
 $_sListOrderDir = null
 $_sMetaDescription = null
 $_sMetaKeywords = null
 $_sMetaDescriptionIdent = null
 $_sMetaKeywordsIdent = null
 $_sAdditionalParams = null
 $_oActCurrency = null
 $_blEnabledPrivateSales = null
 $_blCommonAdded = false
 $_iViewIndexState = VIEW_INDEXSTATE_INDEX
 $_blForceNoIndex = false
 $_iCompItemsCnt = null
 $_sContentId = null
 $_oContent = null
 $_sViewResetID = null
 $_blActiveSorting = null
 $_aMenueList = null
 $_aComponentNames
 $_aUserComponentNames = array()
 $_oProduct = null
 $_iActPage = null
 $_aArticleList = null
 $_oManufacturerTree = null
 $_oCategoryTree = null
 $_aTop5ArticleList = null
 $_aBargainArticleList = null
 $_blLowOrderPrice = null
 $_sMinOrderPrice = null
 $_iNewsRealStatus = null
 $_aBlockRedirectParams = array( 'fnc', 'stoken', 'force_sid', 'force_admin_sid' )
 $_oRootVendor = null
 $_sVendorId = null
 $_aManufacturerlist = null
 $_oRootManufacturer = null
 $_sManufacturerId = null
 $_aSearchCatTree = null
 $_blNewsSubscribed = null
 $_oDelAddress = null
 $_sCatTreePath = null
 $_aContents = array()
 $_blTop5Action = false
 $_blBargainAction = false
 $_aMustFillFields = null
 $_blShowTagCloud = true
 $_blRootCatChanged = false
 $_aInvoiceAddress = null
 $_aDeliveryAddress = null
 $_sActiveUsername = null
 $_blLoadComponents = true
 $_aSortColumns = null
- Protected Attributes inherited from oxView
 $_aViewData = array()
 $_sClassLocation = null
 $_sThisAction = null
 $_oParent = null
 $_blIsComponent = false
 $_sThisTemplate = null
 $_sViewId = null
 $_sClass = null
 $_sFnc = null
 $_sTrustedShopId = null
 $_sTSExcellenceId = null
 $_sCharSet = null
 $_sVersion = null
 $_blDemoVersion = null
 $_blDemoShop = null
 $_iNewsStatus = null
 $_sShopLogo = null
 $_sCategoryId = null
 $_oClickCat = null
 $_blIsCallForCache = false
 $_oViewConf = null

Additional Inherited Members

- Protected Member Functions inherited from oxUBase
 _getComponentNames ()
 _processRequest ()
 _getMetaFromSeo ($sDataType)
 _getMetaFromContent ($sMetaIdent)
 _forceNoIndex ()
 _setNrOfArtPerPage ()
 _getSeoObjectId ()
 _prepareMetaDescription ($sMeta, $iLength=1024, $blRemoveDuplicatedWords=false)
 _prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
 _removeDuplicatedWords ($aInput, $aSkipTags=array())
 _getSubject ($iLang)
 _getRequestParams ($blAddPageNr=true)
 _getSeoRequestParams ()
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
 _canRedirect ()
- Static Protected Attributes inherited from oxUBase
static $_aCollectedComponentNames = null

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 340 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

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

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

Definition at line 80 of file guestbook.php.

GuestBook::$_oPageNavigation = null
protected

Definition at line 73 of file guestbook.php.

GuestBook::$_sListOrderBy = false
protected

Definition at line 31 of file guestbook.php.

GuestBook::$_sListOrderDir = false
protected

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

Definition at line 55 of file guestbook.php.

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