SubtypeTable.php

Go to the documentation of this file.

<?php
namespace Elgg\Database;

global $SUBTYPE_CACHE;
$SUBTYPE_CACHE = null;


class SubtypeTable {
    private $CONFIG;

    public function __construct() {
        global $CONFIG;
        $this->CONFIG = $CONFIG;
    }

    function getId($type, $subtype) {
        global $SUBTYPE_CACHE;
    
        if (!$subtype) {
            return false;
        }
    
        if ($SUBTYPE_CACHE === null) {
            _elgg_populate_subtype_cache();
        }
    
        // use the cache before hitting database
        $result = _elgg_retrieve_cached_subtype($type, $subtype);
        if ($result !== null) {
            return $result->id;
        }
    
        return false;
    }
    
    function getSubtype($subtype_id) {
        global $SUBTYPE_CACHE;
    
        if (!$subtype_id) {
            return '';
        }
    
        if ($SUBTYPE_CACHE === null) {
            _elgg_populate_subtype_cache();
        }
    
        if (isset($SUBTYPE_CACHE[$subtype_id])) {
            return $SUBTYPE_CACHE[$subtype_id]->subtype;
        }
    
        return false;
    }
    
    function retrieveFromCache($type, $subtype) {
        global $SUBTYPE_CACHE;
    
        if ($SUBTYPE_CACHE === null) {
            _elgg_populate_subtype_cache();
        }
    
        foreach ($SUBTYPE_CACHE as $obj) {
            if ($obj->type === $type && $obj->subtype === $subtype) {
                return $obj;
            }
        }
        return null;
    }
    
    function populateCache() {
        global $SUBTYPE_CACHE;
        
        $results = _elgg_services()->db->getData("SELECT * FROM {$this->CONFIG->dbprefix}entity_subtypes");
        
        $SUBTYPE_CACHE = array();
        foreach ($results as $row) {
            $SUBTYPE_CACHE[$row->id] = $row;
        }
    }
    
    function getClass($type, $subtype) {
        global $SUBTYPE_CACHE;
    
        if ($SUBTYPE_CACHE === null) {
            _elgg_populate_subtype_cache();
        }
        
        // use the cache before going to the database
        $obj = _elgg_retrieve_cached_subtype($type, $subtype);
        if ($obj) {
            return $obj->class;
        }
    
        return null;
    }
    
    function getClassFromId($subtype_id) {
        global $SUBTYPE_CACHE;
    
        if (!$subtype_id) {
            return null;
        }
    
        if ($SUBTYPE_CACHE === null) {
            _elgg_populate_subtype_cache();
        }
        
        if (isset($SUBTYPE_CACHE[$subtype_id])) {
            return $SUBTYPE_CACHE[$subtype_id]->class;
        }
    
        return null;
    }
    
    function add($type, $subtype, $class = "") {
        global $SUBTYPE_CACHE;
    
        if (!$subtype) {
            return 0;
        }
    
        $id = get_subtype_id($type, $subtype);
    
        if (!$id) {
            // In cache we store non-SQL-escaped strings because that's what's returned by query
            $cache_obj = (object) array(
                'type' => $type,
                'subtype' => $subtype,
                'class' => $class,
            );
    
            $type = sanitise_string($type);
            $subtype = sanitise_string($subtype);
            $class = sanitise_string($class);
    
            $id = _elgg_services()->db->insertData("INSERT INTO {$this->CONFIG->dbprefix}entity_subtypes"
                . " (type, subtype, class) VALUES ('$type', '$subtype', '$class')");
            
            // add entry to cache
            $cache_obj->id = $id;
            $SUBTYPE_CACHE[$id] = $cache_obj;
        }
    
        return $id;
    }
    
    function remove($type, $subtype) {
        global $SUBTYPE_CACHE;
    
        $type = sanitise_string($type);
        $subtype = sanitise_string($subtype);
    
        $success = _elgg_services()->db->deleteData("DELETE FROM {$this->CONFIG->dbprefix}entity_subtypes"
            . " WHERE type = '$type' AND subtype = '$subtype'");
        
        if ($success) {
            // invalidate the cache
            $SUBTYPE_CACHE = null;
        }
        
        return (bool) $success;
    }
    
    function update($type, $subtype, $class = '') {
        global $SUBTYPE_CACHE;
    
        $id = get_subtype_id($type, $subtype);
        if (!$id) {
            return false;
        }
    
        if ($SUBTYPE_CACHE === null) {
            _elgg_populate_subtype_cache();
        }
    
        $unescaped_class = $class;
    
        $type = sanitise_string($type);
        $subtype = sanitise_string($subtype);
        $class = sanitise_string($class);
        
        $success = _elgg_services()->db->updateData("UPDATE {$this->CONFIG->dbprefix}entity_subtypes
            SET type = '$type', subtype = '$subtype', class = '$class'
            WHERE id = $id
        ");
    
        if ($success && isset($SUBTYPE_CACHE[$id])) {
            $SUBTYPE_CACHE[$id]->class = $unescaped_class;
        }
    
        return $success;
    }
}