Mage_Poll_Model_Poll Class Reference

Inheritance diagram for Mage_Poll_Model_Poll:

List of all members.

Public Member Functions
	getCookie ()
	getCookieName ($pollId=null)
	getPoolId ($pollId=null)
	isValidationByIp ()
	setVoted ($pollId=null)
	isVoted ($pollId=null)
	getRandomId ()
	addVote (Mage_Poll_Model_Poll_Vote $vote)
	hasAnswer ($answer)
	resetVotesCount ()
	getVotedPollsIds ()
	addAnswer ($object)
	getAnswers ()
	addStoreId ($storeId)
	getStoreIds ()
	loadStoreIds ()
	getVotesCount ()
Public Attributes
const	XML_PATH_POLL_CHECK_BY_IP = 'web/polls/poll_check_by_ip'
Protected Member Functions
	_construct ()
Protected Attributes
	$_pollCookieDefaultName = 'poll'
	$_answersCollection = array()
	$_storeCollection = array()

---

Detailed Description

Poll model

Author:

Magento Core Team <core@magentocommerce.com>

Definition at line 33 of file Poll.php.

---

Member Function Documentation

_construct

(

)

[protected]

Enter description here...

Reimplemented from Varien_Object.

Definition at line 41 of file Poll.php.

    {
        $this->_init('poll/poll');
    }

addAnswer

(

$

object

)

Definition at line 204 of file Poll.php.

    {
        $this->_answersCollection[] = $object;
        return $this;
    }

addStoreId

(

$

storeId

)

Definition at line 215 of file Poll.php.

    {
        $ids = $this->getStoreIds();
        if (!in_array($storeId, $ids)) {
            $ids[] = $storeId;
        }
        $this->setStoreIds($ids);
        return $this;
    }

addVote

(

Mage_Poll_Model_Poll_Vote $

vote

)

Add vote to poll

Returns:

unknown

Definition at line 143 of file Poll.php.

    {
        if ($this->hasAnswer($vote->getPollAnswerId())) {
            $vote->setPollId($this->getId())
                ->save();
            $this->setVoted();
        }
        return $this;
    }

getAnswers

(

)

Definition at line 210 of file Poll.php.

    {
        return $this->_answersCollection;
    }

getCookie

(

)

Retrieve Cookie Object

Returns:

Mage_Core_Model_Cookie

Definition at line 51 of file Poll.php.

    {
        return Mage::app()->getCookie();
    }

getCookieName

(

$

pollId = null

)

Get Cookie Name

Parameters:

int

$pollId

Returns:

string

Definition at line 62 of file Poll.php.

    {
        return $this->_pollCookieDefaultName . $this->getPoolId($pollId);
    }

getPoolId

(

$

pollId = null

)

Retrieve defined or current Id

Parameters:

int

$pollId

Returns:

int

Definition at line 73 of file Poll.php.

    {
        if (is_null($pollId)) {
            $pollId = $this->getId();
        }
        return $pollId;
    }

getRandomId

(

)

Get random active pool identifier

Returns:

int

Definition at line 133 of file Poll.php.

    {
        return $this->_getResource()->getRandomId($this);
    }

getStoreIds

(

)

Definition at line 225 of file Poll.php.

    {
        $ids = $this->_getData('store_ids');
        if (is_null($ids)) {
            $this->loadStoreIds();
            $ids = $this->getData('store_ids');
        }
        return $ids;
    }

getVotedPollsIds

(

)

Definition at line 182 of file Poll.php.

    {
        $idsArray = array();

        foreach ($this->getCookie()->get() as $cookieName => $cookieValue) {
            $pattern = '#^' . preg_quote($this->_pollCookieDefaultName, '#') . '(\d+)$#';
            $match   = array();
            if (preg_match($pattern, $cookieName, $match)) {
                if ($match[1] != Mage::getSingleton('core/session')->getJustVotedPoll()) {
                    $idsArray[$match[1]] = $match[1];
                }
            }
        }

        // load from db for this ip
        foreach ($this->_getResource()->getVotedPollIdsByIp($_SERVER['REMOTE_ADDR']) as $pollId) {
            $idsArray[$pollId] = $pollId;
        }

        return $idsArray;
    }

getVotesCount

(

)

Definition at line 240 of file Poll.php.

    {
        return $this->_getData('votes_count');
    }

hasAnswer

(

$

answer

)

Check answer existing for poll

Parameters:

mixed

$answer

Returns:

boll

Definition at line 159 of file Poll.php.

    {
        $answerId = false;
        if (is_numeric($answer)) {
            $answerId = $answer;
        }
        elseif ($answer instanceof Mage_Poll_Model_Poll_Answer) {
            $answerId = $answer->getId();
        }

        if ($answerId) {
            return $this->_getResource()->checkAnswerId($this, $answerId);
        }
        return false;
    }

isValidationByIp

(

)

Check if validation by IP option is enabled in config

Returns:

bool

Definition at line 86 of file Poll.php.

    {
        return (1 == Mage::getStoreConfig(self::XML_PATH_POLL_CHECK_BY_IP));
    }

isVoted

(

$

pollId = null

)

Check if poll is voted

Parameters:

int

$pollId

Returns:

bool

Definition at line 110 of file Poll.php.

    {
        $pollId = $this->getPoolId($pollId);

        // check if it is in cookie
        $cookie = $this->getCookie()->get($this->getCookieName($pollId));
        if (false !== $cookie) {
            return true;
        }

        // check by ip
        if (count($this->_getResource()->getVotedPollIdsByIp($_SERVER['REMOTE_ADDR'], $pollId))) {
            return true;
        }

        return false;
    }

loadStoreIds

(

)

Definition at line 235 of file Poll.php.

    {
        $this->_getResource()->loadStoreIds($this);
    }

resetVotesCount

(

)

Definition at line 175 of file Poll.php.

    {
        $this->_getResource()->resetVotesCount($this);
        return $this;
    }

setVoted

(

$

pollId = null

)

Declare poll as voted

Parameters:

int

$pollId

Returns:

Mage_Poll_Model_Poll

Definition at line 97 of file Poll.php.

    {
        $this->getCookie()->set($this->getCookieName($pollId), $this->getPoolId($pollId));

        return $this;
    }

---

Member Data Documentation

$_answersCollection = array() [protected]

Definition at line 38 of file Poll.php.

$_pollCookieDefaultName = 'poll' [protected]

Definition at line 37 of file Poll.php.

$_storeCollection = array() [protected]

Definition at line 39 of file Poll.php.

const XML_PATH_POLL_CHECK_BY_IP = 'web/polls/poll_check_by_ip'

Definition at line 35 of file Poll.php.

---

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

• app/code/core/Mage/Poll/Model/Poll.php