RebelCode/sql-cqrs-resource-models-abstract

<?php

namespace RebelCode\Storage\Resource\Sql;

use InvalidArgumentException;
use OutOfRangeException;
use Dhii\Util\String\StringableInterface as Stringable;
use stdClass;
use Traversable;

/**
 * Functionality for building the FROM portion of an SQL query.
 *
 * @since [*next-version*]
 */
trait BuildSqlFromCapableTrait
{
    /**
     * Builds the SQL FROM section.
     *
     * @since [*next-version*]
     *
     * @param array|stdClass|Traversable $tables A mapping of tables aliases (keys) to their real names (values).
     *
     * @return string The build SQL table FROM section.
     */
    protected function _buildSqlFrom($tables)
    {
        $parts = [];

        foreach ($tables as $_alias => $_table) {
            $_escTable = $this->_escapeSqlReference($_table);
            $_escAlias = $this->_escapeSqlReference($_alias);

            $parts[] = sprintf('%1$s AS %2$s', $_escTable, $_escAlias);
        }

        $imploded = implode(', ', $parts);

        return sprintf('FROM %s', $imploded);
    }

    /**
     * Escapes an SQL reference with an optional prefix.
     *
     * @since [*next-version*]
     *
     * @param string|Stringable      $reference The reference string.
     * @param string|Stringable|null $prefix    The reference prefix, if any.
     *
     * @throws InvalidArgumentException If either argument is not a valid string.
     * @throws OutOfRangeException      If an invalid string is given as argument.
     *
     * @return string The escaped string.
     */
    abstract protected function _escapeSqlReference($reference, $prefix = null);
}