vendor/doctrine/orm/lib/Doctrine/ORM/Query/Filter/SQLFilter.php line 107

Open in your IDE?
  1. <?php
  2. /*
  3.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  4.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  5.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  6.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  7.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  8.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  9.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14.  *
  15.  * This software consists of voluntary contributions made by many individuals
  16.  * and is licensed under the MIT license. For more information, see
  17.  * <http://www.doctrine-project.org>.
  18.  */
  20. namespace Doctrine\ORM\Query\Filter;
  22. use Doctrine\ORM\EntityManagerInterface;
  23. use Doctrine\ORM\Mapping\ClassMetadata;
  24. use Doctrine\ORM\Query\ParameterTypeInferer;
  26. /**
  27.  * The base class that user defined filters should extend.
  28.  *
  29.  * Handles the setting and escaping of parameters.
  30.  *
  31.  * @author Alexander <iam.asm89@gmail.com>
  32.  * @author Benjamin Eberlei <kontakt@beberlei.de>
  33.  * @abstract
  34.  */
  35. abstract class SQLFilter
  36. {
  37.     /**
  38.      * The entity manager.
  39.      *
  40.      * @var EntityManagerInterface
  41.      */
  42.     private $em;
  44.     /**
  45.      * Parameters for the filter.
  46.      *
  47.      * @var array
  48.      */
  49.     private $parameters = [];
  51.     /**
  52.      * Constructs the SQLFilter object.
  53.      *
  54.      * @param EntityManagerInterface $em The entity manager.
  55.      */
  56.     final public function __construct(EntityManagerInterface $em)
  57.     {
  58.         $this->em = $em;
  59.     }
  61.     /**
  62.      * Sets a parameter that can be used by the filter.
  63.      *
  64.      * @param string      $name  Name of the parameter.
  65.      * @param string      $value Value of the parameter.
  66.      * @param string|null $type  The parameter type. If specified, the given value will be run through
  67.      *                           the type conversion of this type. This is usually not needed for
  68.      *                           strings and numeric types.
  69.      *
  70.      * @return self The current SQL filter.
  71.      */
  72.     final public function setParameter($name, $value, $type = null) : self
  73.     {
  74.         if (null === $type) {
  75.             $type = ParameterTypeInferer::inferType($value);
  76.         }
  78.         $this->parameters[$name] = ['value' => $value, 'type' => $type];
  80.         // Keep the parameters sorted for the hash
  81.         ksort($this->parameters);
  83.         // The filter collection of the EM is now dirty
  84.         $this->em->getFilters()->setFiltersStateDirty();
  86.         return $this;
  87.     }
  89.     /**
  90.      * Gets a parameter to use in a query.
  91.      *
  92.      * The function is responsible for the right output escaping to use the
  93.      * value in a query.
  94.      *
  95.      * @param string $name Name of the parameter.
  96.      *
  97.      * @return string The SQL escaped parameter to use in a query.
  98.      *
  99.      * @throws \InvalidArgumentException
  100.      */
  101.     final public function getParameter($name)
  102.     {
  103.         if (!isset($this->parameters[$name])) {
  104.             throw new \InvalidArgumentException("Parameter '" . $name . "' does not exist.");
  105.         }
  107.         return $this->em->getConnection()->quote($this->parameters[$name]['value'], $this->parameters[$name]['type']);
  108.     }
  110.     /**
  111.      * Checks if a parameter was set for the filter.
  112.      *
  113.      * @param string $name Name of the parameter.
  114.      *
  115.      * @return boolean
  116.      */
  117.     final public function hasParameter($name)
  118.     {
  119.         if (!isset($this->parameters[$name])) {
  120.             return false;
  121.         }
  123.         return true;
  124.     }
  126.     /**
  127.      * Returns as string representation of the SQLFilter parameters (the state).
  128.      *
  129.      * @return string String representation of the SQLFilter.
  130.      */
  131.     final public function __toString()
  132.     {
  133.         return serialize($this->parameters);
  134.     }
  136.     /**
  137.      * Returns the database connection used by the entity manager
  138.      *
  139.      * @return \Doctrine\DBAL\Connection
  140.      */
  141.     final protected function getConnection()
  142.     {
  143.         return $this->em->getConnection();
  144.     }
  146.     /**
  147.      * Gets the SQL query part to add to a query.
  148.      *
  149.      * @param ClassMetaData $targetEntity
  150.      * @param string        $targetTableAlias
  151.      *
  152.      * @return string The constraint SQL if there is available, empty string otherwise.
  153.      */
  154.     abstract public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias);
  155. }