limesurvey_ynh/sources/application/models/Token.php

<?php
	/**
	 *
	 * For code completion we add the available scenario's here
	 * Attributes
	 * @property int      $tid
	 * @property string   $firstname
	 * @property string   $lastname
	 * @property string   $email
	 * @property string   $emailstatus
	 * @property string   $token
	 * @property string   $language
	 * @property string   $blacklisted
	 * @property string   $sent
	 * @property string   $remindersent
	 * @property int      $remindercount
	 * @property string   $completed
	 * @property int      $usesleft
	 * @property DateTime $validfrom
	 * @property DateTime $validuntil
	 *
	 * Relations
	 * @property Survey $survey The survey this token belongs to.
	 *
	 * Scopes
	 * @method Token incomplete() incomplete() Select only uncompleted tokens
	 * @method Token usable() usable() Select usable tokens: valid daterange and userleft > 0
	 *
	 */
	abstract class Token extends Dynamic
	{


		public function attributeLabels() {
			$labels = array(
				'tid' => gT('Token ID'),
				'partcipant' => gt('Participant ID'),
				'firstname' => gT('First name'),
				'lastname' => gT('Last name'),
				'email' => gT('Email address'),
				'emailstatus' => gT('Email status'),
				'token' => gT('Token'),
				'language' => gT('Language code'),
				'blacklisted' => gT('Blacklisted'),
				'sent' => gT('Invitation sent date'),
				'remindersent' => gT('Last reminder sent date'),
				'remindercount' =>gT('Total numbers of sent reminders'),
				'completed' => gT('Completed'),
				'usesleft' => gT('Uses left'),
				'validfrom' => gT('Valid from'),
				'validuntil' => gT('Valid until'),
			);
			// Check if we have custom attributes.
			if ($this->hasAttribute('attribute_1'))
			{
				foreach (unserialize($this->survey->attributedescriptions) as $key => $info)
				{
					$labels[$key] = $info['description'];
				}
			}
			return $labels;
		}
		public function beforeDelete() {
			$result = parent::beforeDelete();
			if ($result && isset($this->surveylink))
			{
				if (!$this->surveylink->delete())
				{
					throw new CException('Could not delete survey link. Token was not deleted.');
				}
				return true;
			}
			return $result;
		}

		public function findByToken($token)
		{
			return $this->findByAttributes(array(
				'token' => $token
			));
		}
		
		public function generateToken()
		{
			$length = $this->survey->tokenlength;

			$this->token = randomChars($length);
			$counter = 0;
			while (!$this->validate('token'))
			{
				$this->token = randomChars($length);
				$counter++;
				// This is extremely unlikely.
				if ($counter > 10)
				{
					throw new CHttpException(500, 'Failed to create unique token in 10 attempts.');
				}
			}
		}

		/**
		 *
		 * @param mixed $className Either the classname or the survey id.
		 * @return Token
		 */
		public static function model($className = null) {
			return parent::model($className);
		}

		/**
		 * 
		 * @param int $surveyId
		 * @param string $scenario
		 * @return Token Description
		 */
		public static function create($surveyId, $scenario = 'insert') {
			return parent::create($surveyId, $scenario);
		}
		public function relations()
		{
			$result = array(
				'responses' => array(self::HAS_MANY, 'Response_' . $this->dynamicId, array('token' => 'token')),
				'survey' =>  array(self::BELONGS_TO, 'Survey', '', 'on' => "sid = {$this->dynamicId}"),
				'surveylink' => array(self::BELONGS_TO, 'SurveyLink', array('participant_id' => 'participant_id'), 'on' => "survey_id = {$this->dynamicId}")
			);
			return $result;
		}

		public function rules()
		{
			return array(
				array('token', 'unique', 'allowEmpty' => true),
				array(implode(',', $this->tableSchema->columnNames), 'safe'),
                array('remindercount','numerical', 'integerOnly'=>true,'allowEmpty'=>true), 
                array('email','filter','filter'=>'trim'),        
                array('email','LSYii_EmailIDNAValidator', 'allowEmpty'=>true, 'allowMultiple'=>true), 
                array('usesleft','numerical', 'integerOnly'=>true,'allowEmpty'=>true),
                array('mpid','numerical', 'integerOnly'=>true,'allowEmpty'=>true),     
                array('blacklisted', 'in','range'=>array('Y','N'), 'allowEmpty'=>true), 
			);
		}

		public function scopes()
		{
            $now = dateShift(date("Y-m-d H:i:s"), "Y-m-d H:i:s", Yii::app()->getConfig("timeadjust"));
            return array(
                'incomplete' => array(
                    'condition' => "completed = 'N'"
                ),
                'usable' => array(
                    'condition' => "COALESCE(validuntil, '$now') >= '$now' AND COALESCE(validfrom, '$now') <= '$now'"
                ),
                'editable' => array(
                    'condition' => "COALESCE(validuntil, '$now') >= '$now' AND COALESCE(validfrom, '$now') <= '$now'"
                )
            );
		}
		public function summary()
		{
			$criteria = $this->getDbCriteria();
			$criteria->select = array(
				"COUNT(*) as count",
				"COUNT(CASE WHEN (token IS NULL OR token='') THEN 1 ELSE NULL END) as invalid",
				"COUNT(CASE WHEN (sent!='N' AND sent<>'') THEN 1 ELSE NULL END) as sent",
				"COUNT(CASE WHEN (emailstatus LIKE 'OptOut%') THEN 1 ELSE NULL END) as optout",
				"COUNT(CASE WHEN (completed!='N' and completed<>'') THEN 1 ELSE NULL END) as completed"
			);
			$command = $this->getCommandBuilder()->createFindCommand($this->getTableSchema(),$criteria);
			return $command->queryRow();
		}

		public function tableName()
		{
			return '{{tokens_' . $this->dynamicId . '}}';
		}           
	}

?>