class.ilAssOrderingElement.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilAssOrderingElement
{
        const EXPORT_IDENT_PROPERTY_SEPARATOR = '_';
        
        static $objectInstanceCounter = 0;
        public $objectInstanceId;
        
        public $id = -1;

        protected $randomIdentifier = null;
        
        protected $solutionIdentifier = null;
        
        protected $indentation = 0;
        
        protected $position = null;
        
        protected $content = null;
        
        protected $uploadImageName = null;
        
        protected $uploadImageFile = null;
        
        protected $imageRemovalRequest = null;
        
        protected $imagePathWeb = null;
        
        protected $imagePathFs = null;
        
        protected $imageThumbnailPrefix = null;
        
        public function __construct()
        {
                $this->objectInstanceId = ++self::$objectInstanceCounter;
        }
        
        public function __clone()
        {
                $this->objectInstanceId = ++self::$objectInstanceCounter;
        }
        
        public function getClone()
        {
                return clone $this;
        }
        
        public function getId()
        {
                return $this->id;
        }
        
        public function setId($id)
        {
                $this->id = $id;
        }
        
        public function getRandomIdentifier() 
        {
                return $this->randomIdentifier;
        }
        
        public function setRandomIdentifier($randomIdentifier) 
        {
                $this->randomIdentifier = $randomIdentifier;
        }
        
        public function getSolutionIdentifier()
        {
                return $this->solutionIdentifier;
        }
        
        public function setSolutionIdentifier($solutionIdentifier)
        {
                $this->solutionIdentifier = $solutionIdentifier;
        }
        
        public function setIndentation($indentation)
        {
                $this->indentation = $indentation;
        }
        
        public function getIndentation()
        {
                return $this->indentation;
        }
        
        public function getPosition()
        {
                return $this->position;
        }
        
        public function setPosition($position)
        {
                $this->position = $position;
        }
        
        public function getContent()
        {
                return $this->content;
        }
        
        public function setContent($content)
        {
                $this->content = $content;
        }
        
        public function getUploadImageFile()
        {
                return $this->uploadImageFile;
        }
        
        public function setUploadImageFile($uploadImageFile)
        {
                $this->uploadImageFile = $uploadImageFile;
        }
        
        public function getUploadImageName()
        {
                return $this->uploadImageName;
        }
        
        public function setUploadImageName($uploadImageName)
        {
                $this->uploadImageName = $uploadImageName;
        }
        
        public function isImageUploadAvailable()
        {
                return (bool)strlen( $this->getUploadImageFile() );
        }
        
        public function isImageRemovalRequest()
        {
                return $this->imageRemovalRequest;
        }
        
        public function setImageRemovalRequest($imageRemovalRequest)
        {
                $this->imageRemovalRequest = $imageRemovalRequest;
        }
        
        public function getImagePathWeb()
        {
                return $this->imagePathWeb;
        }
        
        public function setImagePathWeb($imagePathWeb)
        {
                $this->imagePathWeb = $imagePathWeb;
        }
        
        public function getImagePathFs()
        {
                return $this->imagePathFs;
        }
        
        public function setImagePathFs($imagePathFs)
        {
                $this->imagePathFs = $imagePathFs;
        }
        
        public function getImageThumbnailPrefix()
        {
                return $this->imageThumbnailPrefix;
        }
        
        public function setImageThumbnailPrefix($imageThumbnailPrefix)
        {
                $this->imageThumbnailPrefix = $imageThumbnailPrefix;
        }
        
        public function isSameElement(ilAssOrderingElement $element)
        {
                if( $element->getRandomIdentifier() != $this->getRandomIdentifier() )
                {
                        return false;
                }
                
                if( $element->getSolutionIdentifier() != $this->getSolutionIdentifier() )
                {
                        return false;
                }
                
                if( $element->getPosition() != $this->getPosition() )
                {
                        return false;
                }
                
                if( $element->getIndentation() != $this->getIndentation() )
                {
                        return false;
                }
                
                return true;
        }
        
        public function getStorageValue1($orderingType)
        {
                switch( $orderingType )
                {
                        case OQ_NESTED_TERMS:
                        case OQ_NESTED_PICTURES:
                                
                                return $this->getPosition();
                        
                        case OQ_TERMS:
                        case OQ_PICTURES:
                                
                                return $this->getSolutionIdentifier();
                }
        }
        
        public function getStorageValue2($orderingType)
        {
                switch( $orderingType )
                {
                        case OQ_NESTED_TERMS:
                        case OQ_NESTED_PICTURES:
                                
                                return $this->getRandomIdentifier() . ':' . $this->getIndentation();
                        
                        case OQ_TERMS:
                        case OQ_PICTURES:
                                
                                return $this->getPosition() + 1;
                }
        }
        
        public function __toString()
        {
                return $this->getContent();
        }
        
        protected function thumbnailFileExists()
        {
                if( !strlen($this->getContent()) )
                {
                        return false;
                }
                
                return file_exists($this->getThumbnailFilePath());
        }
        
        protected function getThumbnailFilePath()
        {
                return $this->getImagePathFs() . $this->getImageThumbnailPrefix() . $this->getContent();
        }
        
        protected function getThumbnailFileUrl()
        {
                return $this->getImagePathWeb() . $this->getImageThumbnailPrefix() . $this->getContent();
        }
        
        protected function imageFileExists()
        {
                if( !strlen($this->getContent()) )
                {
                        return false;
                }
                
                return file_exists($this->getImageFilePath());
        }
        
        protected function getImageFilePath()
        {
                return $this->getImagePathFs() .  $this->getContent();
        }
        
        protected function getImageFileUrl()
        {
                return $this->getImagePathWeb() . $this->getContent();
        }
        
        public function getPresentationImageUrl()
        {
                if( $this->thumbnailFileExists() )
                {
                        return $this->getThumbnailFileUrl();
                }
                
                if( $this->imageFileExists() )
                {
                        return $this->getImageFileUrl();
                }
                
                return '';
        }

        public function getExportIdent()
        {
                $ident = array(
                        $this->getRandomIdentifier(),
                        $this->getSolutionIdentifier(),
                        $this->getPosition(),
                        $this->getIndentation()
                );
                
                return implode(self::EXPORT_IDENT_PROPERTY_SEPARATOR, $ident);
        }
        
        public function isExportIdent($ident)
        {
                if( !strlen($ident) )
                {
                        return false;
                }
                
                $parts = explode(self::EXPORT_IDENT_PROPERTY_SEPARATOR, $ident);
                
                if( count($parts) != 4 )
                {
                        return false;
                }
                
                if( !ilAssOrderingElementList::isValidRandomIdentifier($parts[0]) )
                {
                        return false;
                }
                
                if( !ilAssOrderingElementList::isValidSolutionIdentifier($parts[1]) )
                {
                        return false;
                }
                
                if( !ilAssOrderingElementList::isValidPosition($parts[2]) )
                {
                        return false;
                }
                
                if( !ilAssOrderingElementList::isValidIndentation($parts[3]) )
                {
                        return false;
                }
                
                return true;
        }
        
        public function setExportIdent($ident)
        {
                if( $this->isExportIdent($ident) )
                {
                        list($randomId, $solutionId, $pos, $indent) = explode(
                                self::EXPORT_IDENT_PROPERTY_SEPARATOR, $ident
                        );
                        
                        $this->setRandomIdentifier($randomId);
                        $this->setSolutionIdentifier($solutionId);
                        $this->setPosition($pos);
                        $this->setIndentation($indent);
                }
        }
}