TheCodingMachine\TDBM\UncheckedOrderBy

Complexity

Total Complexity

3

Size/Duplication

Total Lines	23
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getOrderBy()	0	3	1
A	__construct()	0	3	1
A	__toString()	0	3	1

<?php
declare(strict_types=1);

namespace TheCodingMachine\TDBM;

/**
 * Use this object to inject any SQL string in an order by clause in $dao->find methods.
 *
 * By default, TDBM is conservative and prevents an ORDERBY clause to be anything other than a sort on columns.
 * This is done to prevent SQL injections.
 *
 * If you need to order on an expression, you can wrap your ORDERBY clause in this class.
 *
 * For instance:
 *
 * $this->find(null, null, new UncheckedOrderBy('RAND()'));
 *
 * Note: you understand that arguments passed inside the `UncheckedOrderBy` constructor are NOT protected and
 * can be used for an SQL injection based attack. Therefore, you understand that you MUST NOT put input from the user
 * in this constructor.
 */
class UncheckedOrderBy
{
    /**
     * @var string
     */
    private $orderBy;

    public function __construct(string $orderBy)
    {
        $this->orderBy = $orderBy;
    }

    public function getOrderBy() : string
    {
        return $this->orderBy;
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return 'UncheckedOrderBy_'.$this->orderBy;
    }
}