QuestionnairePage.php

<?php
/**
 * QuestionnairePage Model
 *
 * @property Questionnaire $Questionnaire
 * @property QuestionnaireQuestion $QuestionnaireQuestion
 *
 * @author Noriko Arai <arai@nii.ac.jp>
 * @author AllCreator <info@allcreator.net>
 * @link http://www.netcommons.org NetCommons Project
 * @license http://www.netcommons.org/license.txt NetCommons License
 */

App::uses('QuestionnairesAppModel', 'Questionnaires.Model');

/**
 * Summary for QuestionnairePage Model
 */
class QuestionnairePage extends QuestionnairesAppModel {

/**
 * use behaviors
 *
 * @var array
 */
	public $actsAs = array(
		'NetCommons.OriginalKey',
		'M17n.M17n' => array(
			'associations' => array(
				'QuestionnaireQuestion' => array(
					'class' => 'Questionnaires.QuestionnaireQuestion',
					'foreignKey' => 'questionnaire_page_id',
				),
			),
			'afterCallback' => false,
		),
	);

/**
 * Validation rules
 *
 * @var array
 */
	public $validate = array();

/**
 * belongsTo associations
 *
 * @var array
 */
	public $belongsTo = array(
		'Questionnaire' => array(
			'className' => 'Questionnaires.Questionnaire',
			'foreignKey' => 'questionnaire_id',
			'conditions' => '',
			'fields' => '',
			'order' => ''
		)
	);

/**
 * hasMany associations
 *
 * @var array
 */
	public $hasMany = array(
		'QuestionnaireQuestion' => array(
			'className' => 'Questionnaires.QuestionnaireQuestion',
			'foreignKey' => 'questionnaire_page_id',
			'dependent' => true,
			'conditions' => '',
			'fields' => '',
			'order' => '',
			'limit' => '',
			'offset' => '',
			'exclusive' => '',
			'finderQuery' => '',
			'counterQuery' => ''
		)
	);

/**
 * Constructor. Binds the model's database table to the object.
 *
 * @param bool|int|string|array $id Set this ID for this model on startup,
 * can also be an array of options, see above.
 * @param string $table Name of database table to use.
 * @param string $ds DataSource connection name.
 * @see Model::__construct()
 * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
 */
	public function __construct($id = false, $table = null, $ds = null) {
		parent::__construct($id, $table, $ds);

		$this->loadModels([
			'QuestionnaireQuestion' => 'Questionnaires.QuestionnaireQuestion',
		]);
	}

/**
 * Called before each find operation. Return false if you want to halt the find
 * call, otherwise return the (modified) query data.
 *
 * @param array $query Data used to execute this query, i.e. conditions, order, etc.
 * @return mixed true if the operation should continue, false if it should abort; or, modified
 *  $query to continue with new $query
 * @link http://book.cakephp.org/2.0/en/models/callback-methods.html#beforefind
 */
	public function beforeFind($query) {
		//hasManyで実行されたとき、多言語の条件追加
		if (! $this->id && isset($query['conditions']['questionnaire_id'])) {
			$questionnaireId = $query['conditions']['questionnaire_id'];
			$query['conditions']['questionnaire_id'] = $this->getQuestionnaireIdsForM17n($questionnaireId);
			$query['conditions']['OR'] = array(
				'language_id' => Current::read('Language.id'),
				'is_translation' => false,
			);

			return $query;
		}

		return parent::beforeFind($query);
	}

/**
 * 多言語データ取得のため、当言語のquestionnaire_idから全言語のquestionnaire_idを取得する
 *
 * @param id $questionnaireId 当言語のquestionnaire_id
 * @return array
 */
	public function getQuestionnaireIdsForM17n($questionnaireId) {
		$questionnaire = $this->Questionnaire->find('first', array(
			'recursive' => -1,
			'callbacks' => false,
			'fields' => array('id', 'key', 'is_active', 'is_latest'),
			'conditions' => array('id' => $questionnaireId),
		));

		$conditions = array(
			'key' => isset($questionnaire['Questionnaire']['key'])
				? $questionnaire['Questionnaire']['key']
				: ''
		);
		if (isset($questionnaire['Questionnaire']['is_latest']) &&
			$questionnaire['Questionnaire']['is_latest']) {
			$conditions['is_latest'] = true;
		} else {
			$conditions['is_active'] = true;
		}

		$questionnaireIds = $this->Questionnaire->find('list', array(
			'recursive' => -1,
			'callbacks' => false,
			'fields' => array('id', 'id'),
			'conditions' => $conditions,
		));

		return array_values($questionnaireIds);
	}

/**
 * getDefaultPage
 * get default data of questionnaire page
 *
 * @return array
 */
	public function getDefaultPage() {
		$page = array(
			'page_title' => __d('questionnaires', 'First Page'),
			'page_sequence' => 0,
			'key' => '',
			'route_number' => 0,
		);
		$page['QuestionnaireQuestion'][0] = $this->QuestionnaireQuestion->getDefaultQuestion();

		return $page;
	}

/**
 * getNextPage
 * get next answer page number
 *
 * @param array $questionnaire questionnaire
 * @param int $nowPageSeq current page sequence number
 * @param array $nowAnswers now answer
 *
 * @return array
 *
 * 速度改善の修正に伴って発生したため抑制
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 * @SuppressWarnings(PHPMD.NPathComplexity)
 */
	public function getNextPage($questionnaire, $nowPageSeq, $nowAnswers) {
		// ページ情報がない？終わりにする
		if (!isset($questionnaire['QuestionnairePage'])) {
			return false;
		}
		// 次ページはデフォルトならば＋１です
		$nextPageSeq = $nowPageSeq + 1;

		$map = [];
		foreach ($questionnaire['QuestionnairePage'] as $QuestionnairePage) {
			if (isset($QuestionnairePage['QuestionnaireQuestion'])) {
				foreach ($QuestionnairePage['QuestionnaireQuestion'] as $question) {
					$map[$question['key']] = $question;
				}
			}
		}
		// 回答にスキップロジックで指定されたものがないかチェックし、行き先があるならそのページ番号を返す
		foreach ($nowAnswers as $answer) {
			$targetQuestion = isset($map[$answer[0]['questionnaire_question_key']])
				? $map[$answer[0]['questionnaire_question_key']]
				: [];

			if ($targetQuestion) {
				// skipロジック対象の質問ならば次ページのチェックを行う
				if ($targetQuestion['is_skip'] == QuestionnairesComponent::SKIP_FLAGS_SKIP) {
					if ($answer[0]['answer_value'] == '') {
						// スキップロジックのところで未回答とされたら無条件に次ページとする
						break;
					}
					$choiceIds = explode(QuestionnairesComponent::ANSWER_VALUE_DELIMITER,
						trim($answer[0]['answer_value'], QuestionnairesComponent::ANSWER_DELIMITER));
					// スキップロジックの選択肢みつけた
					$choice = [];
					foreach ($targetQuestion['QuestionnaireChoice'] as $item) {
						if ($item['key'] === $choiceIds[0]) {
							$choice = $item;
							break;
						}
					}
					if ($choice) {
						if (!empty($choice['skip_page_sequence'])) {
							// スキップ先ページ
							$nextPageSeq = $choice['skip_page_sequence'];
							break;
						}
					}
				}
			}
		}
		// ページ配列はページのシーケンス番号順に取り出されているので
		$pages = $questionnaire['QuestionnairePage'];
		$endPage = end($pages);

		// 指定されたページ番号が全体のページ数よりも大きな数
		// 次ページがもしかして存在しない（つまりエンドかも）もこれでフォローされる
		//if ($nextPageSeq == QuestionnairesComponent::SKIP_GO_TO_END) {
		if ($endPage['page_sequence'] < $nextPageSeq) {
			return false;
		}
		return $nextPageSeq;
	}
/**
 * setPageToQuestionnaire
 * setup page data to questionnaire array
 *
 * @param array &$questionnaire questionnaire data
 * @return void
 */
	public function setPageToQuestionnaire(&$questionnaire) {
		// ページデータがアンケートデータの中にない状態でここが呼ばれている場合、
		if (!isset($questionnaire['QuestionnairePage'])) {
			$pages = $this->find('all', array(
				'conditions' => array(
					'questionnaire_id' => $questionnaire['Questionnaire']['id'],
				),
				'order' => array('page_sequence ASC'),
				'recursive' => -1));

			$questionnaire['QuestionnairePage'] = [];
			foreach ($pages as $page) {
				$page = $page['QuestionnairePage'];
				$questionnaire['QuestionnairePage'][$page['page_sequence']] = $page;
			}
		}
		$questionnaire['Questionnaire']['page_count'] = 0;
		if (isset($questionnaire['QuestionnairePage'])) {
			foreach ($questionnaire['QuestionnairePage'] as &$page) {
				$this->QuestionnaireQuestion->setQuestionToPage($questionnaire, $page);
				$questionnaire['Questionnaire']['page_count']++;
			}
		}
	}
/**
 * Called during validation operations, before validation. Please note that custom
 * validation rules can be defined in $validate.
 *
 * @param array $options Options passed from Model::save().
 * @return bool True if validate operation should continue, false to abort
 * @link http://book.cakephp.org/2.0/en/models/callback-methods.html#beforevalidate
 * @see Model::save()
 * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
 */
	public function beforeValidate($options = array()) {
		$pageIndex = $options['pageIndex'];
		// Pageモデルは繰り返し判定が行われる可能性高いのでvalidateルールは最初に初期化
		// mergeはしません
		$this->validate = array(
			'page_sequence' => array(
				'numeric' => array(
					'rule' => array('numeric'),
					//'message' => 'Your custom message here',
					//'allowEmpty' => false,
					//'required' => false,
				),
				'comparison' => array(
					'rule' => array('comparison', '==', $pageIndex),
					'message' => __d('questionnaires', 'page sequence is illegal.')
				),
			),
			'route_number' => array(
				'numeric' => array(
				'rule' => array('numeric'),
					//'message' => 'Your custom message here',
					//'allowEmpty' => false,
					//'required' => false,
				),
			),
		);
		// validates時にはまだquestionnaire_idの設定ができないのでチェックしないことにする
		// questionnaire_idの設定は上位のQuestionnaireクラスで責任を持って行われるものとする

		parent::beforeValidate($options);

		// 付属の質問以下のvalidate
		if (! isset($this->data['QuestionnaireQuestion'][0])) {
			$this->validationErrors['page_sequence'][] =
				__d('questionnaires', 'please set at least one question.');
		} else {
			$validationErrors = array();
			foreach ($this->data['QuestionnaireQuestion'] as $qIndex => $question) {
				// 質問データバリデータ
				$this->QuestionnaireQuestion->create();
				$this->QuestionnaireQuestion->set($question);
				$options['questionIndex'] = $qIndex;
				if (! $this->QuestionnaireQuestion->validates($options)) {
					$validationErrors['QuestionnaireQuestion'][$qIndex] =
						$this->QuestionnaireQuestion->validationErrors;
				}

				$data = $this->QuestionnaireQuestion->data['QuestionnaireQuestion'];
				unset($this->QuestionnaireQuestion->data['QuestionnaireQuestion']);
				$this->data['QuestionnaireQuestion'][$qIndex] =
						array_merge($data, $this->QuestionnaireQuestion->data);
			}
			$this->validationErrors += $validationErrors;
		}
		return true;
	}
/**
 * saveQuestionnairePage
 * save QuestionnairePage data
 *
 * @param array &$questionnairePages questionnaire pages
 * @param array $block ブロック情報
 * @throws InternalErrorException
 * @return bool
 */
	public function saveQuestionnairePage(&$questionnairePages, $block) {
		$this->loadModels([
			'QuestionnaireQuestion' => 'Questionnaires.QuestionnaireQuestion',
		]);

		// QuestionnairePageが単独でSaveされることはない
		// 必ず上位のQuestionnaireのSaveの折に呼び出される
		// なので、$this->setDataSource('master');といった
		// 決まり処理は上位で行われる
		// ここでは行わない

		foreach ($questionnairePages as &$page) {
			// アンケートは履歴を取っていくタイプのコンテンツデータなのでSave前にはID項目はカット
			// （そうしないと既存レコードのUPDATEになってしまうから）
			// $page['QuestionnairePage']['id']の項目は入ってこないためコメントアウト
			// $page = Hash::remove($page, 'QuestionnairePage.id');
			$this->create();
			if (! $this->save($page, false)) {	// validateは上位のquestionnaireで済んでいるはず
				throw new InternalErrorException(__d('net_commons', 'Internal Server Error'));
			}

			$pageId = $this->id;

			foreach (array_keys($page['QuestionnaireQuestion']) as $key) {
				$page['QuestionnaireQuestion'][$key]['questionnaire_page_id'] = $pageId;
			}
			// もしもQuestionやChoiceのsaveがエラーになった場合は、
			// QuestionやChoiceのほうでInternalExceptionErrorが発行されるのでここでは何も行わない
			$this->QuestionnaireQuestion->saveQuestionnaireQuestion($page['QuestionnaireQuestion'], $block);
		}
		return true;
	}

/**
 * deleteQuestionnairePage
 *
 * アンケートページ情報削除、配下の質問情報に削除命令を実施
 *
 * @param int $questionnaireId アンケートID
 * @return bool
 */
	public function deleteQuestionnairePage($questionnaireId) {
		$pages = $this->find('all', array(
			'conditions' => array(
				'QuestionnairePage.questionnaire_id' => $questionnaireId
			),
			'recursive' => -1
		));
		foreach ($pages as $page) {
			$pageId = $page['QuestionnairePage']['id'];
			if (! $this->QuestionnaireQuestion->deleteQuestionnaireQuestion($pageId)) {
				return false;
			}
			if (! $this->delete($pageId, false)) {
				return false;
			}
		}
		return true;
	}
}