Class Atk4\Data\Persistence\Sql\Expression

`abstract`
`implements`	`Expressionable, ArrayAccess<int\|string, mixed>`
`uses`	`DiContainerTrait`

Atk4\Data\Persistence\Sql\Expression implements Expressionable, ArrayAccess<int|string, mixed> uses DiContainerTrait

Located at data/src/Persistence/Sql/Expression.php

Methods
`public`	`__construct(string\|array<string, mixed> $template = [], array<int\|string, mixed> $arguments = [])` Specifying options to constructors will override default attribute values of this class. Specifying options to constructors will override default attribute values of this class.	#
`public`	`getDsqlExpression(self $expression): $this` Implements `Atk4\Data\Persistence\Sql\Expressionable::getDsqlExpression()`	#
`public`	`offsetExists($offset): bool` Implements `ArrayAccess::offsetExists()`	#
`public`	`offsetGet($offset)` Actually this should be return by ref but atm cannot be. Actually this should be return by ref but atm cannot be. Implements `ArrayAccess::offsetGet()`	#
`public`	`offsetSet($offset, $value): void` Implements `ArrayAccess::offsetSet()`	#
`public`	`offsetUnset($offset): void` Implements `ArrayAccess::offsetUnset()`	#
`public`	`expr(string\|array<string, mixed> $template = [], array<int\|string, mixed> $arguments = []): self` Create Expression object with the same connection. Create Expression object with the same connection. Overriden by `Atk4\Data\Persistence\Sql\Query::expr()`	#
`public`	`reset(string $tag = null): $this` Resets arguments. Resets arguments.	#
`protected`	`consume(string\|Expressionable $expr, self::ESCAPE_* $escapeMode): string` Recursively renders sub-query or expression, combining parameters. Recursively renders sub-query or expression, combining parameters. Returns Quoted expression	#
`protected`	`escapeParam(string\|int\|float $value): string` Converts value into parameter and returns reference. Use only during query rendering. Consider using `consume()`… Converts value into parameter and returns reference. Use only during query rendering. Consider using `consume()` instead, which will also handle nested expressions properly. Returns Name of parameter	#
`protected`	`escapeStringLiteral(string $value): string` This method should be used only when string value cannot be bound. This method should be used only when string value cannot be bound.	#
`protected`	`escapeIdentifier(string $value): string` Escapes identifier from argument. This will allow you to use reserved SQL words as table or field names such as "table"… Escapes identifier from argument. This will allow you to use reserved SQL words as table or field names such as "table" as well as other characters that SQL permits in the identifiers (e.g. spaces or equation signs).	#
`protected`	`escapeIdentifierSoft(string $value): string` Soft-escaping SQL identifier. This method will attempt to put escaping char around the identifier, however will not do… Soft-escaping SQL identifier. This method will attempt to put escaping char around the identifier, however will not do so if you are using special characters like ".", "(" or escaping char. It will smartly escape table.field type of strings resulting in "table"."field".	#
`protected`	`isUnescapableIdentifier(string $value): bool` Given the string parameter, it will detect some "deal-breaker" for our soft escaping, such as "" or "(". Given the string parameter, it will detect some "deal-breaker" for our soft escaping, such as "" or "(".	#
`private`	`_render(): array{string, array<string, mixed>}`	#
`public`	`render(): array{string, array<string, mixed>}` Render expression to an array with SQL string and its params. Render expression to an array with SQL string and its params. Overriden by `Atk4\Data\Persistence\Sql\Query::render()`	#
`protected`	`renderNested(): array{string, array<string, mixed>}` Overriden by `Atk4\Data\Persistence\Sql\Query::renderNested()`	#
`public`	`getDebugQuery(): string` Return formatted debug SQL query. Return formatted debug SQL query.	#
`public`	`__debugInfo(): array<string, mixed>` Overriden by `Atk4\Data\Persistence\Sql\Query::__debugInfo()`	#
`protected`	`hasNativeNamedParamSupport(): bool`	#
`protected`	`updateRenderBeforeExecute(array{string, array<string, mixed>} $render): array{string, array<string, mixed>}`	#
`protected`	`_executeStatement( Statement $statement, bool $fromExecuteStatement, ): ($fromExecuteStatement is true ? int<0, max> : Result)`	#
`protected`	`_execute( Connection\|Connection $connection, bool $fromExecuteStatement, ): ($fromExecuteStatement is true ? int<0, max> : Result)`	#
`public`	`executeQuery(Connection\|Connection $connection = null): Result`	#
`public`	`executeStatement(Connection\|Connection $connection = null): int<0, max>`	#
`final public static`	`castFloatToString(float $value): string` Cast float to string with lossless precision. Cast float to string with lossless precision.	#
`private`	`castGetValue(string\|int\|float\|bool\|null $v): ?string`	#
`public`	`getRowsIterator(): Traversable<array<string, mixed>>`	#
`public`	`getRows(): array<int, array<string, string\|null>>` Executes expression and return whole result-set in form of array of hashes. Executes expression and return whole result-set in form of array of hashes.	#
`public`	`getRow(): array<string, string\|null>\|null` Executes expression and returns first row of data from result-set as a hash. Executes expression and returns first row of data from result-set as a hash.	#
`public`	`getOne(): ?string` Executes expression and return first value of first row of data from result-set. Executes expression and return first value of first row of data from result-set.	#

Methods used from Atk4\Core\DiContainerTrait
`setDefaults(), setMissingProperty(), assertInstanceOf(), _fromSeedPrecheck(), fromSeed(), fromSeedUnsafe()`

Constants
`protected`	`ESCAPE_PARAM = 'param'` "[]" in template, escape as parameter "[]" in template, escape as parameter	#
`protected`	`ESCAPE_IDENTIFIER = 'identifier'` "{}" in template, escape as identifier "{}" in template, escape as identifier	#
`protected`	`ESCAPE_IDENTIFIER_SOFT = 'identifier-soft'` "{{}}" in template, escape as identifier, but keep input with special characters like "." or "(" unescaped "{{}}" in template, escape as identifier, but keep input with special characters like "." or "(" unescaped	#
`protected`	`ESCAPE_NONE = 'none'` Keep input as is Keep input as is	#
`public`	QUOTED_TOKEN_REGEX = "(?:(?sx)\n '(?:[^'\\\\]+\|\\\\.\|'')+'\n \|\"(?:[^\"\\\\]+\|\\\\.\|\"\")+\"\n \|`(?:[^`\\\\]+\|\\\\.\|``)+`\n \|\\[(?:[^\\]\\\\]+\|\\\\.\|\\]\\])+\\]\n \|(?:--\|\\#)[^\\r\\n]+\n \|/\\(?:[^]+\|\\(?!/))+\\/\n)"	#

Properties
`protected`	`?string`	`$template = null`	#
`public`	`array<array<mixed>>`	`$args = ['custom' => []]`	#
`protected`	`string`	`$paramBase = 'a'` As per PDO, escapeParam() will convert value into :a, :b, :c .. :aa .. etc. As per PDO, escapeParam() will convert value into :a, :b, :c .. :aa .. etc.	#
`protected`	"\""\|'`'\|']'	`$identifierEscapeChar` Identifier (table, column, ...) escaping symbol. Identifier (table, column, ...) escaping symbol.	#
`private`	`?string`	`$renderParamBase = null`	#
`private`	`array<string, mixed>`	`$renderParams = null`	#
`public`	`Connection`	`$connection`	#
`public`	`bool`	`$wrapInParentheses = false` Wrap the expression in parentheses when consumed by another expression or not. Wrap the expression in parentheses when consumed by another expression or not.	#

Namespaces

Classes

Interfaces

Traits

Exceptions

Class Atk4\Data\Persistence\Sql\Expression

Implements

Implements

Implements

Implements

Implements

Overriden by

Returns

Returns

Overriden by

Overriden by

Overriden by