class.ilAssQuestionLifecycle.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2019 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilAssQuestionLifecycle
{
    const DRAFT = 'draft';
    const REVIEW = 'review';
    const REJECTED = 'rejected';
    const FINAL = 'final';
    const SHARABLE = 'sharable';
    const OUTDATED = 'outdated';
    
    protected $identifier;
    
    protected function __construct()
    {
        $this->setIdentifier(self::DRAFT);
    }
    
    public function getIdentifier()
    {
        return $this->identifier;
    }
    
    public function setIdentifier($identifier)
    {
        $this->identifier = $identifier;
    }
    
    public function getValidIdentifiers()
    {
        return [self::DRAFT, self::REVIEW, self::REJECTED, self::FINAL, self::SHARABLE, self::OUTDATED];
    }
    
    public function getMappedLomLifecycle()
    {
        switch ($this->getIdentifier()) {
            case self::OUTDATED:
                
                return ilAssQuestionLomLifecycle::UNAVAILABLE;
            
            case self::SHARABLE:
            case self::FINAL:
                
                return ilAssQuestionLomLifecycle::FINAL;
            
            case self::REJECTED:
            case self::REVIEW:
            case self::DRAFT:
            default:
                
                return ilAssQuestionLomLifecycle::DRAFT;
        }
    }
    
    public function getTranslation(ilLanguage $lng)
    {
        return $this->getTranslationByIdentifier($lng, $this->getIdentifier());
    }
    
    protected function getTranslationByIdentifier(ilLanguage $lng, $identifier)
    {
        switch ($identifier) {
            case self::DRAFT:
                
                return $lng->txt('qst_lifecycle_draft');
            
            case self::REVIEW:
                
                return $lng->txt('qst_lifecycle_review');
            
            case self::REJECTED:
                
                return $lng->txt('qst_lifecycle_rejected');
            
            case self::FINAL:
                
                return $lng->txt('qst_lifecycle_final');
            
            case self::SHARABLE:
                
                return $lng->txt('qst_lifecycle_sharable');
            
            case self::OUTDATED:
                
                return $lng->txt('qst_lifecycle_outdated');
            
            default: return '';
        }
    }
    
    public function getSelectOptions(ilLanguage $lng)
    {
        $selectOptions = [];
        
        foreach ($this->getValidIdentifiers() as $identifier) {
            $selectOptions[$identifier] = $this->getTranslationByIdentifier($lng, $identifier);
        }
        
        return $selectOptions;
    }
    
    public function validateIdentifier($identifier)
    {
        if (!in_array($identifier, $this->getValidIdentifiers())) {
            throw new ilTestQuestionPoolInvalidArgumentException(
                'invalid ilias lifecycle given: ' . $identifier
            );
        }
    }
    
    public static function getInstance($identifier)
    {
        $lifecycle = new self();
        $lifecycle->validateIdentifier($identifier);
        $lifecycle->setIdentifier($identifier);
        
        return $lifecycle;
    }
    
    public static function getDraftInstance()
    {
        $lifecycle = new self();
        $lifecycle->setIdentifier(self::DRAFT);
        
        return $lifecycle;
    }
}