mjacobus/php-query-builder

<?php

namespace PO\QueryBuilder;

/**
 * @author Marcelo Jacobus <marcelo.jacobus@gmail.com>
 */
class Helper
{

    /**
     * Default to false. Works in Mysql and Postgres
     * @var boolean wheter should be double quoted
     */
    protected $doubleQuoted = false;

    /**
     * Set the double quotes flag
     *
     * @param  bool   $flag
     * @return string
     */
    public function setDoubleQuoted($flag)
    {
        $this->doubleQuoted = $flag;

        return $this;
    }

    /**
     * Get the double quote flag
     *
     * @return bool
     */
    public function isDoubleQuoted()
    {
        return $this->doubleQuoted;
    }

    /**
     * Quote value with either double or single quotes, depending on the
     * configuration
     *
     * @param  string $value
     * @return string
     */
    public function quote($value)
    {
        if ($this->isDoubleQuoted()) {
            return $this->doubleQuote($value);
        } else {
            return $this->singleQuote($value);
        }
    }

    /**
     * Quote value with double quotes
     *
     * @param  string $value
     * @return string
     */
    public function doubleQuote($value)
    {
        $escaped =  str_replace('"', '\"', $value);

        return '"' . $escaped . '"';
    }

    /**
     * Quote value with single quotes
     *
     * @param  string $value
     * @return string
     */
    public function singleQuote($value)
    {
        $escaped =  str_replace("'", "\'", $value);

        return "'" . $escaped . "'";
    }

    /**
     * Quote value if it is not a number or placeholder
     *
     * @param  string $value
     * @return string
     */
    public function quoteIfNecessary($value)
    {
        if ($this->isNumber($value) || $this->isPlaceholder($value)) {
            return $value;
        }

        return $this->quote($value);
    }

    /**
     * Informs if given value is number
     * @param  string $value
     * @return bool
     */
    public function isNumber($value)
    {
        return is_numeric($value);
    }

    /**
     * Informs if given value is a string
     * @param  string $value
     * @return bool
     */
    public function isString($value)
    {
        return gettype($value) === 'string';
    }

    /**
     * Informs if given value is a placeholder
     * @param  string $value
     * @return bool
     */
    public function isPlaceholder($value)
    {
        return preg_match('/^\:[_a-zA-Z]+$/', $value) === 1;
    }

    /**
     * Replace the given string with the given placeholders
     *
     * @param  string $string
     * @param  array  $values the key value pair of placeholders
     * @return string the string to be replaced
     */
    public function replacePlaceholders($string, $values, $quoteIfNecessary = true)
    {
        foreach ($values as $placeholder => $value) {
            $replacement = $quoteIfNecessary ? $this->quoteIfNecessary($value) : $value;
            $string = str_replace(":{$placeholder}", $replacement, $string);
        }

        return $string;
    }

    /**
     * Get the value that should be placed into the query
     * I.E:
     *     true     => TRUE
     *     "string" => "string"
     *     null     => NULL
     *
     *     To force return as it is
     *     array('value' => $someVar) => $someVar
     *
     * @param  mixed  $value
     * @return string
     */
    public function toDbValue($value)
    {
        if ($this->isString($value)) {
            return $this->quoteIfNecessary($value);
        }

        // smelly code. Refactor

        if ($value === true) {
            return 'TRUE';
        }

        if ($value === false) {
            return 'FALSE';
        }

        if ($value === null) {
            return 'NULL';
        }

        if (is_array($value)) {
            if (isset($value['value'])) {
                return $value['value'];
            }
        }

        return $value;
    }
}