Псевдонимы для полей таблиц в CakePHP4

На чтение 4 мин Опубликовано 08.10.2024

Содержание

Вопрос или проблема
Ответ или решение
Объяснение:
Альтернативный способ:

Вопрос или проблема

В моей базе данных есть таблица page_content со столбцом, который является зарезервированным словом MySQL 8, row. Из-за ограничений, установленных моей хостинг-системой, мне нужно переименовать столбец в что-то, что не является зарезервированным словом (я планирую переименовать его в sort_row).

Однако это поле row доступно через API, который реализует и предоставляет мое программное обеспечение. Этот API сериализует объекты ORM CakePHP в JSON, чтобы сделать их доступными, что означает, что если я изменю имя поля в своем классе модели, то оно также изменится в выводе JSON моего API. Но я не хочу переименовывать поле в API, потому что это означало бы необходимость проверять и обновлять каждую систему, которая его использует.

Проект реализован с использованием PHP8 и CakePHP 4.4. У меня есть класс сущности для таблицы:

<?php

namespace App\Model\Entity;

class PageContent extends Entity
{
    protected $_accessible = [
        '*' => true,
        'id' => false
    ];

    protected $_virtual = ['content'];

    protected $_hidden = [
        'is_visible',
        'visible_from',
        'visible_to',
        'is_deleted',
        'created',
        'modified',
        'created_user',
        'modified_user',
    ];

    protected function _getContent()
    {
        // логика метода здесь
    }

    // здесь еще код....
}

Есть ли способ указать “псевдоним” или что-то подобное для моей модели CakePHP, чтобы, несмотря на то, что поле MySQL называется sort_row, для CakePHP (в запросах ORM и так далее) это поле по-прежнему называлось row? Документация не упоминает ничего подобного. Могу ли я использовать виртуальное поле, чтобы достичь того, что мне нужно?

Ответ или решение

Для решения вашей проблемы с использованием зарезервированного слова row в CakePHP 4 и вашей базой данных, вы можете использовать механизм виртуальных полей в ваших сущностях. Это позволит вам сохранять название поля как row в API, даже если в базе данных оно называется sort_row.

Вот как вы можете это сделать:

Добавьте виртуальное поле в класс сущности. Виртуальное поле позволяет вам определять дополнительное поле, которого физически не существует в базе данных, и вы можете использовать его в вашем API. Следует изменить ваш класс PageContent, чтобы он содержал виртуальное поле row, которое будет возвращать значение из sort_row.
Измените метод get для виртуального поля. В вашем классе PageContent добавьте метод, который будет предоставлять значение sort_row под именем row.

Вот пример того, как это можно реализовать:

<?php

namespace App\Model\Entity;

use Cake\ORM\Entity;

class PageContent extends Entity
{
    protected $_accessible = [
        '*' => true,
        'id' => false
    ];

    protected $_virtual = ['content', 'row']; // Добавляем 'row' в виртуальные поля

    protected $_hidden = [
        'is_visible',
        'visible_from',
        'visible_to',
        'is_deleted',
        'created',
        'modified',
        'created_user',
        'modified_user',
    ];

    protected function _getContent()
    {
        // логика метода здесь
    }

    protected function _getRow() // Метод для виртуального поля
    {
        return $this->_properties['sort_row']; // Возвращаем значение sort_row
    }

    // другие методы здесь...
}

Объяснение:

Виртуальное поле — вы добавляете row в массив $_virtual. Это информирует CakePHP, что это поле будет обрабатываться, хотя его нет в базе данных.
Метод _getRow() — в этом методе вы возвращаете значение из свойства sort_row. CakePHP автоматически будет вызывать этот метод, когда вы обращаетесь к полю row, что позволяет вам представить пользователю значение sort_row под именем row.

Альтернативный способ:

Если в будущем вы захотите, чтобы поле row также можно было обновлять или сохранять через API, вы можете переопределить метод _setRow():

protected function _setRow($value)
{
    $this->_properties['sort_row'] = $value; // Устанавливаем значение sort_row
    return $value; // Возвращаем значение для использования в других местах
}

Это позволит вашему API правильно обрабатывать как чтение, так и запись значений для поля row, ссылаясь при этом на фактическое поле sort_row в базе данных.

Таким образом, вы сможете использовать любое имя в вашем API, не меняя его в модели, и избежать проблем с зарезервированными словами в MySQL.