rkrx / php-mysql-query-builder

src/Builder/Select.php

<?php

namespace Kir\MySQL\Builder;

use Kir\MySQL\Builder\Expr\OrderBySpecification;
use Kir\MySQL\Builder\Internal\Types;
use Kir\MySQL\Builder\Value\OptionalValue;

/**
 * @phpstan-import-type DBParameterValueType from Types
 * @phpstan-import-type DBTableNameType from Types
 * @phpstan-import-type DBWhereExpressionType from Types
 */
interface Select {
	/**
	 * @param bool $preserveTypes
	 * @return $this
	 */
	public function setPreserveTypes(bool $preserveTypes = true): self;

	/**
	 * @param bool $enabled
	 * @return $this
	 */
	public function forUpdate(bool $enabled = true);

	/**
	 * @param bool $distinct
	 * @return $this
	 */
	public function distinct(bool $distinct = true);

	/**
	 * @return array<int|string, string>
	 */
	public function getFields(): array;

	/**
	 * @param string|Select $expression
	 * @param string|null $alias
	 * @return $this
	 */
	public function field($expression, $alias = null);

	/**
	 * @param array<string, string>|array<int, string> $fields
	 * @return $this
	 */
	public function fields(array $fields);

	/**
	 * @param ($table is null ? DBTableNameType : string) $alias

The type Kir\MySQL\Builder\is was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param null|DBTableNameType $table

The type Kir\MySQL\Builder\DBTableNameType was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @return $this
	 */
	public function from($alias, $table = null);

	/**
	 * @param string $alias
	 * @param DBTableNameType $table
	 * @param string|null $expression
	 * @param DBParameterValueType ...$args

The type Kir\MySQL\Builder\DBParameterValueType was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @return $this
	 */
	public function joinInner(string $alias, $table, ?string $expression = null, ...$args);

	/**
	 * @param string $alias
	 * @param DBTableNameType $table
	 * @param string $expression
	 * @param DBParameterValueType ...$args
	 * @return $this
	 */
	public function joinLeft(string $alias, $table, string $expression, ...$args);

	/**
	 * @param string $alias
	 * @param DBTableNameType $table
	 * @param string $expression
	 * @param DBParameterValueType ...$args
	 * @return $this
	 */
	public function joinRight(string $alias, $table, string $expression, ...$args);

	/**
	 * @param string|Select ...$queries
	 * @return $this
	 */
	public function union(...$queries);

	/**
	 * @param string|Select ...$queries
	 * @return $this
	 */
	public function unionAll(...$queries);

	/**
	 * @param DBWhereExpressionType $expression

The type Kir\MySQL\Builder\DBWhereExpressionType was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param DBParameterValueType ...$args
	 * @return $this
	 */
	public function where($expression, ...$args);

	/**
	 * @param DBWhereExpressionType $expression
	 * @param DBParameterValueType ...$args
	 * @return $this
	 */
	public function having($expression, ...$args);

	/**
	 * @param mixed ...$args
	 * @return $this
	 */
	public function groupBy(...$args);

	/**
	 * @param string|OrderBySpecification $expression
	 * @param string&('ASC'|'DESC') $direction

The doc comment string&('ASC'|'DESC') at position 3 could not be parsed: Unknown type name ''ASC'' at position 3 in string&('ASC'|'DESC').

	 * @return $this
	 */
	public function orderBy($expression, string $direction = 'ASC');

	/**
	 * @param string $fieldName
	 * @param array<int, int|float|string> $values
	 * @return $this
	 */
	public function orderByValues(string $fieldName, array $values);

	/**
	 * @param int|null|OptionalValue $limit
	 * @return $this
	 */
	public function limit($limit);

	/**
	 * @param int|null|OptionalValue $offset
	 * @return $this
	 */
	public function offset($offset = 0);

	/**
	 * @return bool
	 */
	public function getCalcFoundRows(): bool;

	/**
	 * @param bool $calcFoundRows
	 * @return $this
	 */
	public function setCalcFoundRows($calcFoundRows = true);

	/**
	 * @return string
	 */
	public function __toString(): string;
}