Класс StringType
Конвертер типа строка.
Используется для преобразования строковых данных между PHP и типами баз данных.
Краткое описание свойств
- $_name protected
string|nullИмя идентификатора для этого типа
Краткое описание методов
-
__construct() public
Конструктор
-
getBaseType() public
Возвращает имя базового типа, от которого наследуется этот класс.
-
getName() public
Возвращает имя идентификатора типа для этого объекта.
-
marshal() public
Преобразует данные запроса в строки PHP.
-
newId() public
Генерирует новое значение первичного ключа для заданного типа.
-
requiresToPhpCast() public
Возвращает, требуется ли преобразование в PHP, так как это не тождественная функция.
-
toDatabase() public
Преобразует строковые данные в формат базы данных.
-
toPHP() public
Преобразует строковые значения в строки PHP.
-
toStatement() public
Получает правильный тип привязки PDO для строковых данных.
Подробное описание методов
__construct() public
__construct(string|null $name = null)
Конструктор
Параметры
-
string|null$name optional Имя, идентифицирующее этот тип
getBaseType() public
getBaseType(): string|null
Возвращает имя базового типа, от которого наследуется этот класс.
Это полезно при расширении базового типа для добавления дополнительной функциональности, но всё ещё хотите, чтобы остальная часть фреймворка использовала те же предположения о базовом типе, от которого он унаследован.
Возвращаемое значение
string|nullgetName() public
getName(): string|null
Возвращает имя идентификатора типа для этого объекта.
Возвращаемое значение
string|nullmarshal() public
marshal(mixed $value): string|null
Преобразует данные запроса в строки PHP.
Наиболее полезно для преобразования данных запроса в объекты PHP, которые имеют смысл для остальных слоёв ORM/базы данных.
Параметры
-
mixed$value Значение для преобразования.
Возвращаемое значение
string|nullnewId() public
newId(): mixed
Генерирует новое значение первичного ключа для заданного типа.
Этот метод может использоваться типами для создания новых значений первичного ключа при вставке сущностей.
Возвращаемое значение
mixedrequiresToPhpCast() public
requiresToPhpCast(): bool
Возвращает, требуется ли преобразование в PHP, так как это не тождественная функция.
Возвращаемое значение
booltoDatabase() public
toDatabase(mixed $value, Cake\Database\DriverInterface $driver): string|null
Преобразует строковые данные в формат базы данных.
Параметры
-
mixed$value Значение для преобразования.
-
Cake\Database\DriverInterface$driver Экземпляр драйвера для преобразования.
Возвращаемое значение
string|nulltoPHP() public
toPHP(mixed $value, Cake\Database\DriverInterface $driver): string|null
Преобразует строковые значения в строки PHP.
Параметры
-
mixed$value Значение для преобразования.
-
Cake\Database\DriverInterface$driver Экземпляр драйвера для преобразования.
Возвращаемое значение
string|nulltoStatement() public
toStatement(mixed $value, Cake\Database\DriverInterface $driver): int
Получает правильный тип привязки PDO для строковых данных.
Параметры
-
mixed$value Связываемое значение.
-
Cake\Database\DriverInterface$driver Драйвер.
Возвращаемое значение
intПодробное описание свойств
$_name protected
Имя идентификатора для этого типа
Тип
string|null
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Database.Type.StringType.html