forked from magento/magento2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Poll.php
287 lines (254 loc) · 7.15 KB
/
Poll.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
<?php
/**
* Magento
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@magentocommerce.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade Magento to newer
* versions in the future. If you wish to customize Magento for your
* needs please refer to http://www.magentocommerce.com for more information.
*
* @category Mage
* @package Mage_Poll
* @copyright Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
*/
/**
* Poll model
*
* @method Mage_Poll_Model_Resource_Poll _getResource()
* @method Mage_Poll_Model_Resource_Poll getResource()
* @method string getPollTitle()
* @method Mage_Poll_Model_Poll setPollTitle(string $value)
* @method Mage_Poll_Model_Poll setVotesCount(int $value)
* @method int getStoreId()
* @method Mage_Poll_Model_Poll setStoreId(int $value)
* @method string getDatePosted()
* @method Mage_Poll_Model_Poll setDatePosted(string $value)
* @method string getDateClosed()
* @method Mage_Poll_Model_Poll setDateClosed(string $value)
* @method int getActive()
* @method Mage_Poll_Model_Poll setActive(int $value)
* @method int getClosed()
* @method Mage_Poll_Model_Poll setClosed(int $value)
* @method int getAnswersDisplay()
* @method Mage_Poll_Model_Poll setAnswersDisplay(int $value)
*
* @category Mage
* @package Mage_Poll
* @author Magento Core Team <core@magentocommerce.com>
*/
class Mage_Poll_Model_Poll extends Mage_Core_Model_Abstract
{
const XML_PATH_POLL_CHECK_BY_IP = 'web/polls/poll_check_by_ip';
protected $_pollCookieDefaultName = 'poll';
protected $_answersCollection = array();
protected $_storeCollection = array();
protected function _construct()
{
$this->_init('Mage_Poll_Model_Resource_Poll');
}
/**
* Retrieve Cookie Object
*
* @return Mage_Core_Model_Cookie
*/
public function getCookie()
{
return Mage::app()->getCookie();
}
/**
* Get Cookie Name
*
* @param int $pollId
* @return string
*/
public function getCookieName($pollId = null)
{
return $this->_pollCookieDefaultName . $this->getPollId($pollId);
}
/**
* Retrieve defined or current Id
*
* @deprecated since 1.7.0.0
* @param int $pollId
* @return int
*/
public function getPoolId($pollId = null)
{
return $this->getPollId($pollId);
}
/**
* Retrieve defined or current Id
*
* @param int|null $pollId
* @return int
*/
public function getPollId($pollId = null)
{
if (is_null($pollId)) {
$pollId = $this->getId();
}
return $pollId;
}
/**
* Check if validation by IP option is enabled in config
*
* @return bool
*/
public function isValidationByIp()
{
return (1 == Mage::getStoreConfig(self::XML_PATH_POLL_CHECK_BY_IP));
}
/**
* Declare poll as voted
*
* @param int $pollId
* @return Mage_Poll_Model_Poll
*/
public function setVoted($pollId=null)
{
$this->getCookie()->set($this->getCookieName($pollId), $this->getPollId($pollId));
return $this;
}
/**
* Check if poll is voted
*
* @param int $pollId
* @return bool
*/
public function isVoted($pollId = null)
{
$pollId = $this->getPollId($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(Mage::helper('Mage_Core_Helper_Http')->getRemoteAddr(), $pollId))) {
return true;
}
return false;
}
/**
* Get random active pool identifier
*
* @return int
*/
public function getRandomId()
{
return $this->_getResource()->getRandomId($this);
}
/**
* Get all ids for not closed polls
*
* @return array
*/
public function getAllIds()
{
return $this->_getResource()->getAllIds($this);
}
/**
* Add vote to poll
*
* @return unknown
*/
public function addVote(Mage_Poll_Model_Poll_Vote $vote)
{
if ($this->hasAnswer($vote->getPollAnswerId())) {
$vote->setPollId($this->getId())
->save();
$this->setVoted();
}
return $this;
}
/**
* Check answer existing for poll
*
* @param mixed $answer
* @return boll
*/
public function hasAnswer($answer)
{
$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;
}
public function resetVotesCount()
{
$this->_getResource()->resetVotesCount($this);
return $this;
}
public function getVotedPollsIds()
{
$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('Mage_Core_Model_Session')->getJustVotedPoll()) {
$idsArray[$match[1]] = $match[1];
}
}
}
// load from db for this ip
foreach ($this->_getResource()->getVotedPollIdsByIp(Mage::helper('Mage_Core_Helper_Http')->getRemoteAddr()) as $pollId) {
$idsArray[$pollId] = $pollId;
}
return $idsArray;
}
public function addAnswer($object)
{
$this->_answersCollection[] = $object;
return $this;
}
public function getAnswers()
{
return $this->_answersCollection;
}
public function addStoreId($storeId)
{
$ids = $this->getStoreIds();
if (!in_array($storeId, $ids)) {
$ids[] = $storeId;
}
$this->setStoreIds($ids);
return $this;
}
public function getStoreIds()
{
$ids = $this->_getData('store_ids');
if (is_null($ids)) {
$this->loadStoreIds();
$ids = $this->getData('store_ids');
}
return $ids;
}
public function loadStoreIds()
{
$this->_getResource()->loadStoreIds($this);
}
public function getVotesCount()
{
return $this->_getData('votes_count');
}
}