AttributeLoader.php

Go to the documentation of this file.

<?php
namespace Elgg;

class AttributeLoader {

    protected static $primary_attr_names = array(
        'guid',
        'type',
        'subtype',
        'owner_guid',
        'container_guid',
        'site_guid',
        'access_id',
        'time_created',
        'time_updated',
        'last_action',
        'enabled',
    );

    protected static $integer_attr_names = array(
        'guid',
        'owner_guid',
        'container_guid',
        'site_guid',
        'access_id',
        'time_created',
        'time_updated',
        'last_action',
        // \ElggUser
        'prev_last_action',
        'last_login',
        'prev_last_login'
    );

    protected static $null_attr_names = array(
        'name',
        'title',
        'description',
        'url',
    );

    protected $secondary_attr_names = array();

    protected $required_type;

    protected $initialized_attributes;

    protected $class;

    public $requires_access_control = true;

    public $primary_loader = 'get_entity_as_row';

    public $secondary_loader = '';

    public $full_loader = '';

    protected $additional_select_values = array();

    public function __construct($class, $required_type, array $initialized_attrs) {
        if (!is_string($class)) {
            throw new \InvalidArgumentException('$class must be a class name.');
        }
        $this->class = $class;

        if (!is_string($required_type)) {
            throw new \InvalidArgumentException('$requiredType must be a system entity type.');
        }
        $this->required_type = $required_type;

        $this->initialized_attributes = $initialized_attrs;
        $all_attr_names = array_keys($initialized_attrs);
        $this->secondary_attr_names = array_diff($all_attr_names, self::$primary_attr_names);
    }

    protected function isMissingPrimaries($row) {
        return array_diff(self::$primary_attr_names, array_keys($row)) !== array();
    }

    protected function isMissingSecondaries($row) {
        return array_diff($this->secondary_attr_names, array_keys($row)) !== array();
    }

    protected function checkType($row) {
        if ($row['type'] !== $this->required_type) {
            $msg = "GUID:" . $row['guid'] . " is not a valid " . $this->class;
            throw new \InvalidClassException($msg);
        }
    }

    public function getAdditionalSelectValues() {
        return $this->additional_select_values;
    }
    
    public function getRequiredAttributes($row) {
        if (!is_array($row) && !($row instanceof \stdClass)) {
            // assume row is the GUID
            $row = array('guid' => $row);
        }
        $row = (array) $row;
        if (empty($row['guid'])) {
            throw new \InvalidArgumentException('$row must be or contain a GUID');
        }

        $was_missing_primaries = $this->isMissingPrimaries($row);
        $was_missing_secondaries = $this->isMissingSecondaries($row);

        // some types have a function to load all attributes at once, it should be faster
        if (($was_missing_primaries || $was_missing_secondaries) && is_callable($this->full_loader)) {
            $fetched = (array) call_user_func($this->full_loader, $row['guid']);
            if (!$fetched) {
                return array();
            }
            $row = array_merge($row, $fetched);
            $this->checkType($row);
        } else {
            if ($was_missing_primaries) {
                if (!is_callable($this->primary_loader)) {
                    throw new \LogicException('Primary attribute loader must be callable');
                }
                if ($this->requires_access_control) {
                    $fetched = (array) call_user_func($this->primary_loader, $row['guid']);
                } else {
                    $ignoring_access = elgg_set_ignore_access();
                    $fetched = (array) call_user_func($this->primary_loader, $row['guid']);
                    elgg_set_ignore_access($ignoring_access);
                }
                if (!$fetched) {
                    return array();
                }
                $row = array_merge($row, $fetched);
            }

            // We must test type before trying to load the secondaries so that InvalidClassException
            // gets thrown. Otherwise the secondary loader will fail and return false.
            $this->checkType($row);

            if ($was_missing_secondaries) {
                if (!is_callable($this->secondary_loader)) {
                    throw new \LogicException('Secondary attribute loader must be callable');
                }
                $fetched = (array) call_user_func($this->secondary_loader, $row['guid']);
                if (!$fetched) {
                    throw new \IncompleteEntityException("Secondary loader failed to return row for {$row['guid']}");
                }
                $row = array_merge($row, $fetched);
            }
        }

        $row = $this->filterAddedColumns($row);

        $row['subtype'] = (int)$row['subtype'];

        // set to null when reading empty value, to match default empty value; See #5456
        foreach (self::$null_attr_names as $key) {
            if (isset($row[$key]) && !$row[$key]) {
                $row[$key] = null;
            }
        }

        // Note: If there are still missing attributes, we're running on a 1.7 or earlier schema. We let
        // this pass so the upgrades can run.

        // guid needs to be an int  https://github.com/elgg/elgg/issues/4111
        foreach (self::$integer_attr_names as $key) {
            if (isset($row[$key])) {
                $row[$key] = (int) $row[$key];
            }
        }
        return $row;
    }

    protected function filterAddedColumns($row) {
        // make an array with keys as acceptable attribute names
        $acceptable_attrs = self::$primary_attr_names;
        array_splice($acceptable_attrs, count($acceptable_attrs), 0, $this->secondary_attr_names);
        $acceptable_attrs = array_combine($acceptable_attrs, $acceptable_attrs);

        foreach ($row as $key => $val) {
            if (!isset($acceptable_attrs[$key])) {
                $this->additional_select_values[$key] = $val;
                unset($row[$key]);
            }
        }
        return $row;
    }
}