CoolCMS API

ColumnGate

in package

• Application

Length gate for form fields, measured by the column the field is written to.

ColumnGate::lengths($form, Order::class, ['sellerName', 'sellerStreet', 'sellerCity']);
ColumnGate::taxId($form->getComponent('customerRegNo'), Order::class, 'customerRegNo');

Table of Contents

Constants

ASSET_PATH_MESSAGE  : string = '//admin.general.columnGate.assetPath'

Message for an image path that is not local; global key.

DECIMAL_MESSAGE  : string = '//admin.general.columnGate.decimal'

Message for a number outside the column range; `%s` is the exclusive limit, filled by the caller.

FRONT_DECIMAL_MESSAGE  : string = '//front.general.columnGate.decimal'

Front end variant of {@see DECIMAL_MESSAGE}, see {@see FRONT_MAX_LENGTH_MESSAGE}.

FRONT_MAX_LENGTH_MESSAGE  : string = '//front.general.columnGate.maxLength'

Front end variant of the same message.

FRONT_NEGATIVE_PRICE_MESSAGE  : string = '//front.general.columnGate.negativePrice'

Front end message for a negative price (decimal gate without `$allowNegative`); without its own message a negative value got the range one ("enter a number less than …"), which is misleading.

FRONT_TAX_ID_MESSAGE  : string = '//front.general.columnGate.taxId'

Front end variant of {@see TAX_ID_MESSAGE}, see {@see FRONT_MAX_LENGTH_MESSAGE}.

HEX_COLOR_MESSAGE  : string = '//admin.general.columnGate.hexColor'

Message for a value that is not a hex color; global key.

HEX_COLOR_PATTERN  : string = '#[0-9A-Fa-f]{6}'

Hex color mask `#rrggbb`, exactly what fits the varchar(7) color columns.

INTEGER_MESSAGE  : string = '//admin.general.columnGate.integer'

Message for a whole number outside the column (or business) range; `%s` and `%s` are the inclusive bounds.

MAX_BYTES_MESSAGE  : string = '//admin.general.columnGate.maxBytes'

Message for a text longer than a `TEXT`-like column holds (bytes); `%d` is the byte limit.

MAX_LENGTH_MESSAGE  : string = '//admin.general.columnGate.maxLength'

Message for a value longer than the column holds; global key, `%d` is the column limit.

NEGATIVE_PRICE_MESSAGE  : string = '//admin.general.columnGate.negativePrice'

Admin message for a negative price (decimal gate without `$allowNegative`, passed as `$negativeMessage`); the range one alone ("must be less than …") misled for a negative value (admin walkthrough B5).

TAX_ID_MESSAGE  : string = '//admin.general.columnGate.taxId'

Message for a value that is not a tax id shape; global key.

Methods

assetPath()  : BaseControl

Legacy image path gate (`assetPath` of categories and regions): column length plus a local relative path only ({@see AssetPathPolicy}).

decimal()  : BaseControl

Range gate for decimal fields, measured by the column.

decimals()  : void

Batch variant of {@see decimal()}; see {@see lengths()} for the name matching rules.

guard()  : void

Column gate for a whole form: every text and number control is measured by the column it writes to, found by name in the given entities.

hexColor()  : BaseControl

Color gate: column length plus the `#rrggbb` mask.

integer()  : BaseControl

Range gate for integer fields, measured by the column ({@see ColumnLimits::integerRange()}).

length()  : BaseControl

Limits the control to the column width: client `maxlength` plus server rule `MAX_LENGTH`.

lengths()  : void

Batch variant for field blocks where the control name equals the entity property name.

taxId()  : BaseControl

Tax id gate: column length plus a loose shape mask ({@see TaxIdHelper::PATTERN}) that also lets foreign ids through.

taxIds()  : void

Batch variant of {@see taxId()}; control names equal entity property names.

columnError()  : array{0: string, 1: list}|null

columnFor()  : array{kind: string, length: ?int, min: ?int, max: ?int, precision: ?int, scale: ?int, unsigned: bool}|null

fillPlaceholders()  : string

Fills `%d` / `%s` placeholders in order (Nette does it for rule messages; a manual error has to).

guardedControls()  : array<int, BaseControl, 1: array{kind: string, length: ?int, min: ?int, max: ?int, precision: ?int, scale: ?int, unsigned: bool}}>

mappedLimit()  : array{kind: string, length: ?int, min: ?int, max: ?int, precision: ?int, scale: ?int, unsigned: bool}|null

Limits from the `#[ORM\Column]` mapping, in the {@see ColumnSchema::describe()} shape. A `text` column without `length` is `LONGTEXT` for Doctrine, so it gets no limit here.