models/CSERDmodel/CSERDreview.php5

<?php

class CSERDreview extends CSERDModelBase {
    protected $questionnaire;
    
    public static $ATTRIBUTES = array(
        'reviewId' => array(
            'nullable' => false,
            'commit' => SModel2::COMMIT_NEVER,
            'type' => 'int'
        ),
        'state' => array(
            'type' => 'string'
        ),
        'active' => array(
            'type' => 'int',
            'default' => null
        ),
        'type' => array(
            'nullable' => false,
            'type' => 'string'
        ),
        'cserdId' => array(
            'type' => 'int',
            'default' => null
        ),
        'authorId' => array(
            'nullable' => false,
            'commit' => SModel2::COMMIT_FIRST,
            'type' => 'int',
            'foreign' => array('table' => 'user', 'on' => 'userId', 'object' => 'author')
        ),
        'ownerId' => array(
            'nullable' => false,
            'commit' => SModel2::COMMIT_FIRST,
            'type' => 'int',
            'foreign' => array('table' => 'user', 'on' => 'userId', 'object' => 'owner')
        ),
        'created' => array(
            'nullable' => false,
            'commit' => SModel2::COMMIT_CHANGED,
            'type' => 'time',
            'default' => ''
        ),
        'modified' => array(
            'nullable' => false,
            'type' => 'time',
            'default' => '0000-00-00 00:00:00'
        ),
        'solicited' => array(
            'type' => 'int',
            'default' => null
        ),
        'cache' => array(
            'type' => 'string'
        ),
        'project' => array(
            'type' => 'string'
        ),
        'author' => array(
            'commit' => SModel2::COMMIT_FOREIGN,
            'type' => 'CSERDuser'
        ),
        'owner' => array(
            'commit' => SModel2::COMMIT_FOREIGN,
            'type' => 'CSERDuser'
        )
    );

    public function __construct($constraints = null, $multi = false) {
        parent::__construct();

        $this->registerAttributes(self::$ATTRIBUTES);
        $this->registerTableName('review');
        $this->registerPrimaryKey('reviewId', true);

        if($constraints !== null)
            $this->populate($constraints, $multi);
    }

    public static function getAttributesStatic() {
        return self::$ATTRIBUTES;
    }

    public static function getTableNameStatic() {
        return 'review';
    }

    public static function retrieve($constraints = array(), $checkOnly = false) {
        $list = self::getList($constraints, array(1), array(), $checkOnly);
        if(!$list || count($list) == 0)
            return $checkOnly ? false : null;
        else if($checkOnly)
            return $list > 0;
        else
            return $list[0];
    }

    public static function exists($constraints = array()) {
        return self::retrieve($constraints, true);
    }

    public static function retrieveMulti($constraints = array(), $checkOnly = false, $depth = 1) {
        $list = self::getListMulti($constraints, array(1), array(), $checkOnly, $depth);
        if(!$list || count($list) == 0)
            return $checkOnly ? false : null;
        else if($checkOnly)
            return $list > 0;
        else
            return $list[0];
    }

    public static function existsMulti($constraints = array()) {
        return self::retrieveMulti($constraints, true);
    }

    public static function getList($constraints = array(), $limit = array(), $order = array(), $count = false) {
        return parent::getListBase(self::getDBI(), $constraints, $limit, $order, $count, 'CSERDreview', true);
    }

    public static function getListMulti($constraints = array(), $limit = array(), $order = array(), $count = false, $depth = 1) {
        return parent::getListBaseMulti(self::getDBI(), $constraints, $limit, $order, $count,
                                            'CSERDreview', true, $depth);
    }


    public function getParentAuthor() {
        return CSERDuser::retrieve(array('userId' => $this->authorId));
    }

    public function getParentAuthorMulti($depth = 1) {
        return CSERDuser::retrieveMulti(array('Base.userId' => $this->authorId), false, $depth);
    }

    public function getParentOwner() {
        return CSERDuser::retrieve(array('userId' => $this->ownerId));
    }

    public function getParentOwnerMulti($depth = 1) {
        return CSERDuser::retrieveMulti(array('Base.userId' => $this->ownerId), false, $depth);
    }

    public function listreviewSubjects($constraints = array(), $limit = array(), $order = array(), $count = false) {
        return parent::getListBase(self::getDBI(),
                            array_merge($constraints, array('reviewId' => $this->reviewId)),
                            $limit, $order, $count, 'CSERDreviewSubject', true);
    }

    public function listreviewSubjectsMulti($constraints = array(), $limit = array(), $order = array(), $count = false, $depth = 1) {
        return parent::getListBaseMulti(self::getDBI(),
                            array_merge($constraints, array('Base.reviewId' => $this->reviewId)),
                            $limit, $order, $count, 'CSERDreviewSubject', true, $depth);
    }

    public function addreviewSubject($subject) {
        $obj =  new CSERDreviewSubject();

        if(is_object($subject))
            $obj->subject = $subject;
        else
            $obj->subjectId = $subject;
        $obj->reviewId = $this->reviewId;

        if(!$obj->commit())
            return null;

        return $obj;
    }

    public function listcomments($constraints = array(), $limit = array(), $order = array(), $count = false) {
        return parent::getListBase(self::getDBI(),
                            array_merge($constraints, array('reviewId' => $this->reviewId)),
                            $limit, $order, $count, 'CSERDcomment', true);
    }

    public function listcommentsMulti($constraints = array(), $limit = array(), $order = array(), $count = false, $depth = 1) {
        return parent::getListBaseMulti(self::getDBI(),
                            array_merge($constraints, array('Base.reviewId' => $this->reviewId)),
                            $limit, $order, $count, 'CSERDcomment', true, $depth);
    }

    public function addcomment($owner, $author, $comment = '', $timestamp = '') {
        $obj =  new CSERDcomment();

        if($comment != '')
            $obj->comment = $comment;
        $obj->timestamp = $timestamp;
        $obj->reviewId = $this->reviewId;
        if(is_object($owner))
            $obj->owner = $owner;
        else
            $obj->ownerId = $owner;
        if(is_object($author))
            $obj->author = $author;
        else
            $obj->authorId = $author;

        if(!$obj->commit())
            return null;

        return $obj;
    }

    public function listresponses($constraints = array(), $limit = array(), $order = array(), $count = false) {
        return parent::getListBase(self::getDBI(),
                            array_merge($constraints, array('reviewId' => $this->reviewId)),
                            $limit, $order, $count, 'CSERDresponse', true);
    }

    public function listresponsesMulti($constraints = array(), $limit = array(), $order = array(), $count = false, $depth = 1) {
        return parent::getListBaseMulti(self::getDBI(),
                            array_merge($constraints, array('Base.reviewId' => $this->reviewId)),
                            $limit, $order, $count, 'CSERDresponse', true, $depth);
    }

    public function addresponse($question, $response = '') {
        $obj =  new CSERDresponse();

        if(is_object($question))
            $obj->question = $question;
        else
            $obj->questionId = $question;
        $obj->reviewId = $this->reviewId;
        if($response != '')
            $obj->response = $response;

        if(!$obj->commit())
            return null;

        return $obj;
    }
    
    protected function setQuestionnaire($questionnaire) {
        $this->questionnaire = $questionnaire;
    }
    
    public function getQuestionnaire() {
        if (!isset($this->questionnaire)){
            $q = new CSERDquestionnaire($this->reviewId);
            if ($q === false) {
                print("Unable to complete populate(): attempt to populate Questionnaire "
                                . "object for the review failed.");
                //$this->setError($q->getError());
                return false;
            }
            $this->setQuestionnaire($q);
        }
        
        return $this->questionnaire;

    }
    

    public function updateCache($q = '') {
    
        if ($q === '') {
            $q = new CSERDquestionnaire($this->reviewId);
            if ($q === false) {
                return false;
            }
            $this->questionnaire = $q;
        }
        $this->cache = HTMLQuestionnaireEncoder::encode($q);
//      var_dump($this->cache);
//      exit;
        return true;
    }
    
    public function updateDateModified() {
        $this->modified = DateParser::currentDateMysql();
        $this->commit();
    }
    
    /* -------------------------------------------- */
    /* Workflow Transition Functions */
    /* -------------------------------------------- */
    
    /* submitReview()
        move a review from private to pending */
    public function submitReview() {
        if ($this->state != 'private') {
            print("Attempt to call submitReview() on Review '" . $this->reviewId .
                "' failed: current workflow state is " . $this->state .
                ". Transition requires 'private'.");
            return false;
        }
        $this->state = 'pending';
        $this->updateDateModified();
        $this->commit();
        $cserdId = $this->cserdId;
        if (!SDRServiceCache::updateAverageReviewRating($cserdId))
            return false;
        return true;
    }
    
    /* rejectReview()
        move a review from pending to private */    
    public function rejectReview() {
        if ($this->state != 'pending') {
            print("Attempt to call rejectReview() on Review $reviewId failed: "
                 . "current workflow state is " . $this->state . ". Transition requires 'pending'.");
            return false;
        }
        $this->updateDateModified();
        $this->state = 'returned';
        $this->commit();
        $cserdId = $this->cserdId;
        if (!SDRServiceCache::updateAverageReviewRating($cserdId))
            return false;
        return true;
    }

    /* publishReview()
        move a review from pending to published */
    public function publishReview() {
        if ($this->state != 'pending') {
            print("Attempt to call publishReview() on Review '" . $this->reviewId .
                "' failed: current workflow state is " . $this->state .
                ". Transition requires 'pending'.");
            return false;
        }
        $this->updateDateModified();
        $this->state = 'published';
        $this->commit();
        
        $cserdId = $this->cserdId;
        if (!SDRServiceCache::updateAverageReviewRating($cserdId)) {
            return false;
        }
        return true;
    }

    /* unpublishReview()
        move a review from published to pending */
    public function unpublishReview() {
        if ($this->state != 'published') {
            print("Attempt to call unpublishReview() on Review '" . $this->reviewId .
                "' failed: current workflow state is " . $this->state .
                ". Transition requires 'published'.");
            return false;
        }
        $this->updateDateModified();
        $this->state = 'pending';
        $this->commit();
        $cserdId = $this->cserdId;
        if (!SDRServiceCache::updateAverageReviewRating($cserdId))
            return false;
        return true;
    }
    
    public function deleteReview() {
        if ($this->state != 'published') {
            print("Attempt to call unpublishReview() on Review '" . $this->reviewId .
                "' failed: current workflow state is " . $this->state .
                ". Transition requires 'published'.");
            return false;
        }
        $this->updateDateModified();
        $this->active = 'false';
        $this->commit();
        $cserdId = $this->cserdId;
        if (!SDRServiceCache::updateAverageReviewRating($cserdId))
            return false;
        return true;
    }

    
    public function isValidReview()
    {
        //print("active is " . $this->getActive());
        //print_r($this);
        return (
            ($this->state != "") &&
            ($this->authorId != "") &&
            ($this->ownerId != "") &&
            ($this->active === true || $this->active === false) &&
            ($this->cserdId != "") &&
            ($this->type != ""));
    }

}

?>

---