PrivateSettingsTable.php

Go to the documentation of this file.

<?php

namespace Elgg\Database;

use Elgg\Database;
use ElggEntity;
use Elgg\Cache\PrivateSettingsCache;
use Elgg\Values;

class PrivateSettingsTable {

    protected $db;

    protected $entities;

    protected $cache;

    public function __construct(Database $db, EntityTable $entities, PrivateSettingsCache $cache) {
        $this->db = $db;
        $this->entities = $entities;
        $this->cache = $cache;
    }

    public function get(ElggEntity $entity, $name) {
        return elgg_extract($name, $this->getAllForEntity($entity));
    }

    public function getAllForEntity(ElggEntity $entity) {
        $values = $this->cache->load($entity->guid);
        if (isset($values)) {
            return $values;
        }

        $qb = Select::fromTable('private_settings');
        $qb->select('name')
            ->addSelect('value')
            ->where($qb->compare('entity_guid', '=', $entity->guid, ELGG_VALUE_INTEGER));

        $result = $this->db->getData($qb);

        $return = [];

        if (!empty($result)) {
            foreach ($result as $r) {
                $return[$r->name] = $r->value;
            }
        }

        $this->cache->save($entity->guid, $return);

        return $return;
    }

    public function getAllForGUIDs($guids) {
        $guids = Values::normalizeGuids($guids);
        
        if (!is_array($guids) || empty($guids)) {
            return [];
        }
        
        $qb = Select::fromTable('private_settings');
        $qb->select('entity_guid')
            ->addSelect('name')
            ->addSelect('value')
            ->where($qb->compare('entity_guid', 'IN', $guids));

        $result = $this->db->getData($qb);
        if (empty($result)) {
            return [];
        }
        
        $return = [];
        
        foreach ($result as $r) {
            $return[$r->entity_guid][$r->name] = $r->value;
        }
    
        return $return;
    }

    public function set(ElggEntity $entity, $name, $value) {
        $entity->invalidateCache();

        $value_type = is_int($value) ? ELGG_VALUE_INTEGER : ELGG_VALUE_STRING;

        $qb = Select::fromTable('private_settings');
        $qb->select('id')
            ->where($qb->compare('name', '=', $name, ELGG_VALUE_STRING))
            ->andWhere($qb->compare('entity_guid', '=', $entity->guid, ELGG_VALUE_INTEGER));

        $row = $this->db->getDataRow($qb);

        if (!empty($row)) {
            $qb = Update::table('private_settings');
            $qb->set('value', $qb->param($value, $value_type))
                ->where($qb->compare('id', '=', $row->id, ELGG_VALUE_INTEGER));

            $result = $this->db->updateData($qb);
        } else {
            $qb = Insert::intoTable('private_settings');
            $qb->values([
                'entity_guid' => $qb->param($entity->guid, ELGG_VALUE_INTEGER),
                'name' => $qb->param($name, ELGG_VALUE_STRING),
                'value' => $qb->param($value, $value_type),
            ]);

            $result = $this->db->insertData($qb);
        }

        return $result !== false;
    }

    public function remove(ElggEntity $entity, $name) {
        $entity->invalidateCache();

        $qb = Delete::fromTable('private_settings');
        $qb->where($qb->compare('name', '=', $name, ELGG_VALUE_STRING))
            ->andWhere($qb->compare('entity_guid', '=', $entity->guid, ELGG_VALUE_INTEGER));

        return (bool) $this->db->deleteData($qb);
    }

    public function removeAllForEntity(ElggEntity $entity) {
        $entity->invalidateCache();

        $qb = Delete::fromTable('private_settings');
        $qb->where($qb->compare('entity_guid', '=', $entity->guid, ELGG_VALUE_INTEGER));

        return (bool) $this->db->deleteData($qb);
    }

}