guestbook.php

Go to the documentation of this file.

<?php

class GuestBook extends oxUBase
{
    protected $_iCntPages = null;

    protected $_blShowLogin = false;

    protected $_aSortColumns = null;

    protected $_sListOrderBy = false;

    protected $_sListOrderDir = false;

    protected $_blFloodProtection = null;

    protected $_aEntries = null;

    protected $_sThisTemplate = 'page/guestbook/guestbook.tpl';

    protected $_sThisLoginTemplate = 'page/guestbook/guestbook_login.tpl';

    protected $_blShowSorting = true;

    protected $_oPageNavigation = null;

    protected $_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW;


    public function render()
    {
        parent::render();

        // #774C no user mail and password check in guesbook
        if ( $this->_blShowLogin ) {
            //no valid login
            return $this->_sThisLoginTemplate;
        }

        $this->getEntries();
        return $this->_sThisTemplate;
    }

    public function getSortColumns()
    {
        if ( $this->_aSortColumns === null) {
            $this->setSortColumns( array( 'author', 'date' ) );
        }
        return $this->_aSortColumns;
    }

    public function getGbSortBy()
    {
        return $this->_sListOrderBy;
    }

    public function getGbSortDir()
    {
        return $this->_sListOrderDir;
    }

    public function getEntries()
    {
        if ( $this->_aEntries === null) {
            $this->_aEntries  = false;
            $iNrofCatArticles = (int) $this->getConfig()->getConfigParam( 'iNrofCatArticles' );
            $iNrofCatArticles = $iNrofCatArticles ? $iNrofCatArticles : 10;

            // loading only if there is some data
            $oEntries = oxNew( 'oxgbentry' );
            if ( $iCnt = $oEntries->getEntryCount() ) {
                $this->_iCntPages = round( $iCnt / $iNrofCatArticles + 0.49 );
                $this->_aEntries  = $oEntries->getAllEntries( $this->getActPage() * $iNrofCatArticles, $iNrofCatArticles, $this->getSortingSql( $this->getSortIdent() ) );
            }
        }

        return $this->_aEntries;
    }

    public function floodProtection()
    {
        if ( $this->_blFloodProtection === null ) {
            $this->_blFloodProtection = false;
            // is user logged in ?
            $sUserId = oxSession::getVar( 'usr' );
            $sUserId = $sUserId ? $sUserId : 0;

            $oEntries = oxNew( 'oxgbentry' );
            $this->_blFloodProtection = $oEntries->floodProtection( $this->getConfig()->getShopId(), $sUserId );
        }
        return $this->_blFloodProtection;
    }

    public function getSortOrderByParameterName()
    {
        return 'gborderby';
    }

    public function getSortOrderParameterName()
    {
        return 'gborder';
    }

    public function getSortIdent()
    {
        return 'oxgb';
    }

    public function getDefaultSorting()
    {
        $aSorting = array ( 'sortby' => 'date', 'sortdir' => 'desc' );
        return $aSorting;
    }

    public function prepareSortColumns()
    {
        $oUtils = oxRegistry::getUtils();

        $this->_aSortColumns  = array( 'author', 'date' );

        $sSortBy  = oxConfig::getParameter( $this->getSortOrderByParameterName() );
        $sSortDir = oxConfig::getParameter( $this->getSortOrderParameterName() );

        if ( !$sSortBy && $aSorting = $this->getSorting( 'oxgb' ) ) {
            $sSortBy  = $aSorting['sortby'];
            $sSortDir = $aSorting['sortdir'];
        }

        // finally setting defaults
        if ( !$sSortBy ) {
            $sSortBy  = 'date';
            $sSortDir = 'desc';
        }

        if ( $sSortBy && oxDb::getInstance()->isValidFieldName( $sSortBy ) &&
             $sSortDir && oxRegistry::getUtils()->isValidAlpha( $sSortDir ) ) {

            $this->_sListOrderBy  = $sSortBy;
            $this->_sListOrderDir = $sSortDir;

            // caching sorting config
            $this->setItemSorting( 'oxgb', $sSortBy, $sSortDir );
        }
    }

    public function getPageNavigation()
    {
        if ( $this->_oPageNavigation === null ) {
            $this->_oPageNavigation = false;
            $this->_oPageNavigation = $this->generatePageNavigation();
        }
        return $this->_oPageNavigation;
    }

    public function saveEntry()
    {
        if (!oxRegistry::getSession()->checkSessionChallenge()) {
            return;
        }

        $sReviewText = trim( ( string ) oxConfig::getParameter( 'rvw_txt', true ) );
        $sShopId     = $this->getConfig()->getShopId();
        $sUserId     = oxSession::getVar( 'usr' );

        // guest book`s entry is validated
        if ( !$sUserId ) {
            oxRegistry::get("oxUtilsView")->addErrorToDisplay( 'ERROR_MESSAGE_GUESTBOOK_ENTRY_ERR_LOGIN_TO_WRITE_ENTRY' );
            //return to same page
            return;
        }

        if ( !$sShopId ) {
            oxRegistry::get("oxUtilsView")->addErrorToDisplay( 'ERROR_MESSAGE_GUESTBOOK_ENTRY_ERR_UNDEFINED_SHOP' );
            return 'guestbookentry';
        }

        // empty entries validation
        if ( '' == $sReviewText ) {
            oxRegistry::get("oxUtilsView")->addErrorToDisplay( 'ERROR_MESSAGE_GUESTBOOK_ENTRY_ERR_REVIEW_CONTAINS_NO_TEXT' );
            return 'guestbook';
        }

        // flood protection
        $oEntrie = oxNew( 'oxgbentry' );
        if ( $oEntrie->floodProtection( $sShopId, $sUserId ) ) {
            oxRegistry::get("oxUtilsView")->addErrorToDisplay( 'ERROR_MESSAGE_GUESTBOOK_ENTRY_ERR_MAXIMUM_NUMBER_EXCEEDED' );
            return 'guestbookentry';
        }

        // double click protection
        if ( $this->canAcceptFormData() ) {
            // here the guest book entry is saved
            $oEntry = oxNew( 'oxgbentry' );
            $oEntry->oxgbentries__oxshopid  = new oxField($sShopId);
            $oEntry->oxgbentries__oxuserid  = new oxField($sUserId);
            $oEntry->oxgbentries__oxcontent = new oxField($sReviewText);
            $oEntry->save();
        }

        return 'guestbook';
    }

    public function getBreadCrumb()
    {
        $aPaths = array();
        $aPath = array();

        $aPath['title'] = oxRegistry::getLang()->translateString( 'GUESTBOOK', oxRegistry::getLang()->getBaseLanguage(), false );
        $aPath['link']  = $this->getLink();
        $aPaths[] = $aPath;

        return $aPaths;
    }
}