class.ilVerificationObject.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */
 
include_once ('./Services/Object/classes/class.ilObject2.php');
 
abstract class ilVerificationObject extends ilObject2
{
        protected $map = array();
        protected $properties = array();
 
        const TYPE_STRING = 1;
        const TYPE_BOOL = 2;
        const TYPE_INT = 3;
        const TYPE_DATE = 4;
        const TYPE_RAW = 5;
        const TYPE_ARRAY = 6;
 
        function __construct($a_id = 0, $a_reference = true)
        {
                $this->map = $this->getPropertyMap();
                parent::__construct($a_id, $a_reference);               
        }
 
        abstract protected function getPropertyMap();
 
        public function hasProperty($a_name)
        {
                return array_key_exists($a_name, $this->map);
        }
 
        public function getPropertyType($a_name)
        {
                if($this->hasProperty($a_name))
                {
                        return $this->map[$a_name];
                }
        }
 
        public function getProperty($a_name)
        {
                if($this->hasProperty($a_name))
                {
                        return $this->properties[$a_name];
                }
        }
 
        public function setProperty($a_name, $a_value)
        {
                if($this->hasProperty($a_name))
                {
                        $this->properties[$a_name] = $a_value;
                }
        }
 
        protected function importProperty($a_type, $a_data = null, $a_raw_data = null)
        {
                $data_type = $this->getPropertyType($a_type);
                if($data_type)
                {
                        $value = null;
                        
                        switch($data_type)
                        {
                                case self::TYPE_STRING:
                                        $value = (string)$a_data;
                                        break;
 
                                case self::TYPE_BOOL:
                                        $value = (bool)$a_data;
                                        break;
 
                                case self::TYPE_INT:
                                        $value = (int)$a_data;
                                        break;
 
                                case self::TYPE_DATE:
                                        $value = new ilDate($a_data, IL_CAL_DATE);
                                        break;
 
                                case self::TYPE_ARRAY:
                                        if($a_data)
                                        {
                                                $value = unserialize($a_data);
                                        }
                                        break;
 
                                case self::TYPE_RAW:
                                        $value = $a_raw_data;
                                        break;
                        }
 
                        $this->setProperty($a_type, $value);
                }
        }
 
        protected function exportProperty($a_name)
        {
                $data_type = $this->getPropertyType($a_name);
                if($data_type)
                {
                        $value = $this->getProperty($a_name);
                        $raw_data = null;
 
                        switch($data_type)
                        {
                                case self::TYPE_DATE:
                                        if($value)
                                        {
                                                $value = $value->get(IL_CAL_DATE);
                                        }
                                        break;
 
                                case self::TYPE_ARRAY:
                                        if($value)
                                        {
                                                $value = serialize($value);
                                        }
                                        break;
 
                                case self::TYPE_RAW:                                    
                                        $raw_data = $value;
                                        $value = null;
                                        break;
                        }
 
                        return array("parameters" => $value,
                                "raw_data" => $raw_data);
                }
        }
 
        protected function doRead()
        {
                global $ilDB;
 
                if($this->id)
                {               
                        $set = $ilDB->query("SELECT * FROM il_verification".
                                " WHERE id = ".$ilDB->quote($this->id, "integer"));
                        if($ilDB->numRows($set))
                        {
                                while($row = $ilDB->fetchAssoc($set))
                                {                                       
                                        $this->importProperty($row["type"], $row["parameters"],
                                                $row["raw_data"]);
                                }
                        }
                        return true;
                }
                return false;
        }
 
        public function doCreate()
        {
                return $this->saveProperties();
        }
        
        public function doUpdate()
        {
                return $this->saveProperties();
        }
        
        protected function saveProperties()
        {
                global $ilDB;
                
                if($this->id)
                {
                        // remove all existing properties
                        $ilDB->manipulate("DELETE FROM il_verification".
                                " WHERE id = ".$ilDB->quote($this->id, "integer"));
                        
                        foreach($this->getPropertyMap() as $name => $type)
                        {
                                $property = $this->exportProperty($name);
                                
                                $fields = array("id" => array("integer", $this->id),
                                        "type" => array("text", $name),
                                        "parameters" => array("text", $property["parameters"]),
                                        "raw_data" => array("text", $property["raw_data"]));
 
                                $ilDB->insert("il_verification", $fields);
                        }
                        
                        $this->handleQuotaUpdate();
 
                        return true;
                }
                return false;
        }
        
 
        public function doDelete()
        {
                global $ilDB;
 
                if($this->id)
                {
                        // remove all files
                        include_once "Services/Verification/classes/class.ilVerificationStorageFile.php";
                        $storage = new ilVerificationStorageFile($this->id);
                        $storage->delete();
                        
                        $this->handleQuotaUpdate();
                        
                        $ilDB->manipulate("DELETE FROM il_verification".
                                " WHERE id = ".$ilDB->quote($this->id, "integer"));
                        return true;
                }
                return false;
        }
        
        public static function initStorage($a_id, $a_subdir = null)
        {               
                include_once "Services/Verification/classes/class.ilVerificationStorageFile.php";
                $storage = new ilVerificationStorageFile($a_id);
                $storage->create();
                
                $path = $storage->getAbsolutePath()."/";
                
                if($a_subdir)
                {
                        $path .= $a_subdir."/";
                        
                        if(!is_dir($path))
                        {
                                mkdir($path);
                        }
                }
                                
                return $path;
        }
        
        public function getFilePath()
        {               
                $file = $this->getProperty("file");
                if($file)
                {
                        $path = $this->initStorage($this->getId(), "certificate");
                        return $path.$file;
                }
        }
        
        public function getOfflineFilename()
        {
                return ilUtil::getASCIIFilename($this->getTitle()).".pdf";              
        }
        
        protected function handleQuotaUpdate()
        {                                                                               
                include_once "Services/DiskQuota/classes/class.ilDiskQuotaHandler.php";
                ilDiskQuotaHandler::handleUpdatedSourceObject($this->getType(), 
                        $this->getId(),
                        ilUtil::dirsize($this->initStorage($this->getId())), 
                        array($this->getId()),
                        true);  
        }
}
 
?>