method public

BaseObject::getModifyDdl()

Сигнатура

public getModifyDdl(BaseObject $target[, string $dbType = '' ]) : array<string|int, mixed>|string

Описание

Возвращает DDL или комментарий для изменения объекта.

Параметры

$target BaseObject

Целевой объект.

$dbType string = ''

Тип базы данных.

Возвращаемое значение

array<string|int, mixed>|string

Как применяется в BaseObject

BaseObject::getModifyDdl() — метод класса \Bitrix\Perfmon\Sql\BaseObject модуля «Монитор производительности». BaseObject: Класс BaseObject Базовый класс для всех объектов схемы, таких как таблицы, столбцы, индексы и т.д.

Метод объекта: сначала нужен экземпляр BaseObject.

use Bitrix\Main\Loader;
use Bitrix\Perfmon\Sql\BaseObject;

Loader::includeModule('perfmon');

/** @var BaseObject $object */
$target = null; // BaseObject
$result = $object->getModifyDdl($target);
// $result: array<string|int, mixed>|string

Другие методы BaseObject

compareName() Сравнивает имя таблицы с заданным.
getCompareName() Возвращает «нормализованное» имя таблицы.
getCreateDdl() Возвращает DDL или комментарий для создания объекта.
getDropDdl() Возвращает DDL или комментарий для уничтожения объекта.
getLowercasedName() Возвращает имя объекта в нижнем регистре.
getUnquotedName() Возвращает имя объекта без кавычек.
setBody() Задаёт исходный код для объекта.
setParent() Задаёт родителя для объекта.

getModifyDdl() есть и у других классов модуля «Монитор производительности»: Column, Constraint, Index, Procedure, Sequence, Table, Trigger.

Исходный файл: source/perfmon/lib/sql/base_object.php:197