EntitySortByClause.php

Go to the documentation of this file.

<?php

namespace Elgg\Database\Clauses;

use Elgg\Database\QueryBuilder;
use ElggEntity;

class EntitySortByClause extends OrderByClause {

    public $property;

    public $direction;

    public $signed;

    public $join_type;

    public $property_type;

    public function prepare(QueryBuilder $qb, $table_alias = null) {

        if (!isset($this->property_type)) {
            if (in_array($this->property, ElggEntity::$primary_attr_names)) {
                $this->property_type = 'attribute';
            } else {
                $this->property_type = 'metadata';
            }
        }

        switch ($this->property_type) {
            case 'metadata' :
                $md_alias = $qb->joinMetadataTable($table_alias, 'guid', $this->property, $this->join_type);
                $column = "$md_alias.value";
                break;

            case 'attribute' :
                if (!in_array($this->property, ElggEntity::$primary_attr_names)) {
                    throw new \InvalidParameterException("'$this->property' is not a valid entity attribute");
                }
                $column = "$table_alias.$this->property";
                break;

            case 'private_setting' :
                $ps_alias = $qb->joinPrivateSettingsTable($table_alias, 'guid', $this->property, $this->join_type);
                $column = "$ps_alias.value";
                break;

            case 'annotation' :
                $an_alias = $qb->joinAnnotationTable($table_alias, 'guid', $this->property, $this->join_type);
                $column = "$an_alias.value";
                break;

            default :
                throw new \InvalidParameterException("'$this->property_type' is not a valid entity property type");
        }

        if ($this->signed) {
            $column = "CAST($column AS SIGNED)";
        }

        $this->expr = $column;

        return parent::prepare($qb, $table_alias);
    }
}