Annotations.php

Go to the documentation of this file.

<?php

namespace Elgg\Database;

use Doctrine\DBAL\Query\Expression\CompositeExpression;
use Elgg\Database\Clauses\AnnotationWhereClause;
use Elgg\Database\Clauses\EntityWhereClause;
use Elgg\Database\Clauses\MetadataWhereClause;
use Elgg\Database\Clauses\PrivateSettingWhereClause;
use Elgg\Database\Clauses\RelationshipWhereClause;
use Elgg\Exceptions\InvalidArgumentException;
use Elgg\Exceptions\InvalidParameterException;
use Elgg\Exceptions\LogicException;

class Annotations extends Repository {

    public function count() {
        $qb = Select::fromTable('annotations', 'n_table');

        $count_expr = $this->options->distinct ? "DISTINCT n_table.id" : "*";
        $qb->select("COUNT({$count_expr}) AS total");

        $qb = $this->buildQuery($qb);

        $result = _elgg_services()->db->getDataRow($qb);

        if (empty($result)) {
            return 0;
        }

        return (int) $result->total;
    }

    public function calculate($function, $property, $property_type = null) {

        if (!in_array(strtolower($function), QueryBuilder::$calculations)) {
            throw new InvalidArgumentException("'$function' is not a valid numeric function");
        }

        if (!isset($property_type)) {
            $property_type = 'annotation';
        }

        $qb = Select::fromTable('annotations', 'n_table');

        switch ($property_type) {
            case 'attribute':
                if (!in_array($property, \ElggEntity::PRIMARY_ATTR_NAMES)) {
                    throw new InvalidParameterException("'$property' is not a valid attribute");
                }

                $alias = $qb->joinEntitiesTable('n_table', 'entity_guid', 'inner', 'e');
                $qb->select("{$function}({$alias}.{$property}) AS calculation");
                break;

            case 'annotation' :
                $alias = 'n_table';
                if (!empty($this->options->annotation_name_value_pairs) && $this->options->annotation_name_value_pairs[0]->names != $property) {
                    $alias = $qb->joinAnnotationTable('n_table', 'entity_guid', $property);
                }
                $qb->select("{$function}($alias.value) AS calculation");
                break;

            case 'metadata' :
                $alias = $qb->joinMetadataTable('n_table', 'entity_guid', $property);
                $qb->select("{$function}({$alias}.value) AS calculation");
                break;

            case 'private_setting' :
                $alias = $qb->joinPrivateSettingsTable('n_table', 'entity_guid', $property);
                $qb->select("{$function}({$alias}.value) AS calculation");
                break;
        }

        $qb = $this->buildQuery($qb);

        $result = _elgg_services()->db->getDataRow($qb);

        if (empty($result)) {
            return 0;
        }

        return (int) $result->calculation;
    }

    public function get($limit = null, $offset = null, $callback = null) {

        $qb = Select::fromTable('annotations', 'n_table');

        $distinct = $this->options->distinct ? "DISTINCT" : "";
        $qb->select("$distinct n_table.*");

        $this->expandInto($qb, 'n_table');

        $qb = $this->buildQuery($qb);

        // Keeping things backwards compatible
        $original_order = elgg_extract('order_by', $this->options->__original_options);
        if (empty($original_order) && $original_order !== false) {
            $qb->addOrderBy('n_table.time_created', 'asc');
            $qb->addOrderBy('n_table.id', 'asc');
        }

        if ($limit > 0) {
            $qb->setMaxResults((int) $limit);
            $qb->setFirstResult((int) $offset);
        }

        $callback = $callback ? : $this->options->callback;
        if (!isset($callback)) {
            $callback = function ($row) {
                return new \ElggAnnotation($row);
            };
        }

        $results = _elgg_services()->db->getData($qb, $callback);
        if (!empty($results) && $this->options->preload_owners) {
            _elgg_services()->entityPreloader->preload($results, ['owner_guid']);
        }

        return $results;
    }

    public function execute() {

        if ($this->options->annotation_calculation) {
            $clauses = $this->options->annotation_name_value_pairs;
            if (count($clauses) > 1 && $this->options->annotation_name_value_pairs_operator !== 'OR') {
                throw new LogicException("Annotation calculation can not be performed on multiple annotation name value pairs merged with AND");
            }

            $clause = array_shift($clauses);

            return $this->calculate($this->options->annotation_calculation, $clause->names, 'annotation');
        } else if ($this->options->metadata_calculation) {
            $clauses = $this->options->metadata_name_value_pairs;
            if (count($clauses) > 1 && $this->options->metadata_name_value_pairs_operator !== 'OR') {
                throw new LogicException("Metadata calculation can not be performed on multiple metadata name value pairs merged with AND");
            }

            $clause = array_shift($clauses);

            return $this->calculate($this->options->metadata_calculation, $clause->names, 'metadata');
        } else if ($this->options->count) {
            return $this->count();
        } else if ($this->options->batch) {
            return $this->batch($this->options->limit, $this->options->offset, $this->options->callback);
        } else {
            return $this->get($this->options->limit, $this->options->offset, $this->options->callback);
        }
    }

    protected function buildQuery(QueryBuilder $qb) {

        $ands = [];

        foreach ($this->options->joins as $join) {
            $join->prepare($qb, 'n_table');
        }

        foreach ($this->options->wheres as $where) {
            $ands[] = $where->prepare($qb, 'n_table');
        }

        $ands[] = $this->buildPairedAnnotationClause($qb, $this->options->annotation_name_value_pairs, $this->options->annotation_name_value_pairs_operator);
        $ands[] = $this->buildEntityWhereClause($qb);
        $ands[] = $this->buildPairedMetadataClause($qb, $this->options->metadata_name_value_pairs, $this->options->metadata_name_value_pairs_operator);
        $ands[] = $this->buildPairedMetadataClause($qb, $this->options->search_name_value_pairs, 'OR');
        $ands[] = $this->buildPairedPrivateSettingsClause($qb, $this->options->private_setting_name_value_pairs, $this->options->private_setting_name_value_pairs_operator);
        $ands[] = $this->buildPairedRelationshipClause($qb, $this->options->relationship_pairs);

        $ands = $qb->merge($ands);

        if (!empty($ands)) {
            $qb->andWhere($ands);
        }

        return $qb;
    }

    protected function buildEntityWhereClause(QueryBuilder $qb) {
        $joined_alias = $qb->joinEntitiesTable('n_table', 'entity_guid', 'inner', 'e');
        return EntityWhereClause::factory($this->options)->prepare($qb, $joined_alias);
    }

    protected function buildPairedAnnotationClause(QueryBuilder $qb, $clauses, $boolean = 'AND') {
        $parts = [];

        if (empty($clauses)) {
            // We need to make sure that enabled and access clauses are appended to the query
            $clauses[] = new AnnotationWhereClause();
        }

        foreach ($clauses as $clause) {
            $parts[] = $clause->prepare($qb, 'n_table');
        }

        return $qb->merge($parts, $boolean);
    }

    protected function buildPairedMetadataClause(QueryBuilder $qb, $clauses, $boolean = 'AND') {
        $parts = [];

        foreach ($clauses as $clause) {
            if (strtoupper($boolean) === 'OR' || count($clauses) > 1) {
                $joined_alias = $qb->joinMetadataTable('n_table', 'entity_guid');
            } else {
                $joined_alias = $qb->joinMetadataTable('n_table', 'entity_guid', $clause->names);
            }
            $parts[] = $clause->prepare($qb, $joined_alias);
        }

        return $qb->merge($parts, $boolean);
    }

    protected function buildPairedPrivateSettingsClause(QueryBuilder $qb, $clauses, $boolean = 'AND') {
        $parts = [];

        foreach ($clauses as $clause) {
            if (strtoupper($boolean) === 'OR' || count($clauses) > 1) {
                $joined_alias = $qb->joinPrivateSettingsTable('n_table', 'entity_guid');
            } else {
                $joined_alias = $qb->joinPrivateSettingsTable('n_table', 'entity_guid', $clause->names);
            }
            $parts[] = $clause->prepare($qb, $joined_alias);
        }

        return $qb->merge($parts, $boolean);
    }

    protected function buildPairedRelationshipClause(QueryBuilder $qb, $clauses, $boolean = 'AND') {
        $parts = [];

        foreach ($clauses as $clause) {
            $join_on = $clause->join_on == 'guid' ? 'entity_guid' : $clause->join_on;
            if (strtoupper($boolean) == 'OR' || count($clauses) > 1) {
                $joined_alias = $qb->joinRelationshipTable('n_table', $join_on, null, $clause->inverse);
            } else {
                $joined_alias = $qb->joinRelationshipTable('n_table', $join_on, $clause->names, $clause->inverse);
            }
            $parts[] = $clause->prepare($qb, $joined_alias);
        }

        return $qb->merge($parts, $boolean);
    }
}