Datalist.php

Go to the documentation of this file.

<?php

namespace Elgg\Database;

use Elgg\Cache\Pool;
use Elgg\Database;
use Elgg\Logger;

class Datalist {
    
    const MAX_NAME_LENGTH = 255;
    
    protected $cache;

    protected $db;

    protected $logger;

    protected $table;

    public function __construct(Pool $cache, Database $db, Logger $logger, $table) {
        $this->cache = $cache;
        $this->db = $db;
        $this->logger = $logger;
        $this->table = $table;
    }

    public function setCache(Pool $pool) {
        $this->cache = $pool;
    }

    public function get($name) {
        $name = trim($name);
        if (!$this->validateName($name)) {
            return false;
        }

        return $this->cache->get($name, function() use ($name) {

            $sql = "SELECT * FROM {$this->table} WHERE name = :name";
            $params = [
                ':name' => $name,
            ];
            $result = $this->db->getDataRow($sql, null, $params);
            return $result ? $result->value : null;
        });
    }

    public function set($name, $value) {
        $name = trim($name);
        if (!$this->validateName($name)) {
            return false;
        }

        $sql = "
            INSERT INTO {$this->table}
            SET name = :name, value = :value
            ON DUPLICATE KEY UPDATE value = :value
        ";

        $params = [
            ':name' => $name,
            ':value' => $value,
        ];

        $success = $this->db->insertData($sql, $params);
        
        $this->cache->put($name, $value);

        return $success !== false;
    }

    public function runFunctionOnce($functionname, $timelastupdatedcheck = 0) {
        $lastupdated = $this->get($functionname);
        if ($lastupdated) {
            $lastupdated = (int) $lastupdated;
        } elseif ($lastupdated !== false) {
            $lastupdated = 0;
        } else {
            // unable to check datalist
            return false;
        }
        if (is_callable($functionname) && $lastupdated <= $timelastupdatedcheck) {
            $functionname();
            $this->set($functionname, time());
            return true;
        } else {
            return false;
        }
    }

    protected function validateName($name) {

        $max = self::MAX_NAME_LENGTH;

        // Can't use elgg_strlen() because not available until core loaded.
        if (is_callable('mb_strlen')) {
            $is_valid = (mb_strlen($name) <= $max);
        } else {
            $is_valid = (strlen($name) <= $max);
        }

        if (!$is_valid) {
            $this->logger->error("The name length for configuration variables cannot be greater than $max");
        }

        return $is_valid;
    }

}