Как создать сущность D7?

Question

[alisiy]

Делаю все как описано тут: https://dev.1c-bitrix.ru/learning/course/index.php...
Но когда пытаюсь использовать класс получаю Class not found.

Эту тему прочитала - https://dev.1c-bitrix.ru/support/forum/forum6/topi...

Не поняла следующее - почему я должна подключать модуль, если в уроке ясно написано:

Осталось только зафиксировать код сущности в проекте. Согласно общим правилам именования файлов в D7, код сущности нужно сохранить в файле: local/modules/somepartner.mybookscatalog/lib/book.php

После чего система автоматически будет подключать файл при нахождении вызовов класса BookTable.

Так после того как я просто размещу код в файле класса или все же надо подключить модуль?
Модуль подключаю - \Bitrix\Main\Loader::includeModule('my.foo') - возвращается false. Почему? Создала файл local/modules/my.foo/include.php - все равно возвращается false.

Как это должно работать? Почему ничего об этом нет в уроке?

Comments

[Trionik]

Та же хрень, эта сучность не создаётся.

Answer 1

[Роман Грицук]

Сущность D7 это обычный класс. Для того чтобы все работало надо этот класс подключить.
Если класс вне модуля то через autoload или обычным include (или require).

У вас же судя по всему модуль. Для того чтобы все работало, надо чтобы модуль имел как минимум обязательные файлы и был установлен через меню системы. Именно установлен, а не просто скопирован в папку modules.

Далее класс который описывает вашу таблицу в БД, нужно разместить в папке lib модуля. Название файла должно быть в нижнем регистре и не должно содержать слова Table.
Например для класса BooksTable, имя файла должно быть books.php

Comments

[alisiy]

> Сущность D7 это обычный класс. Для того чтобы все работало надо этот класс подключить.
Это я понимаю. Я с D7 впервые столкнулась.

Я разместила класс в модуле, потому что так написано в уроке. И там написано, что класс будет загружен автоматически и мне не нужно заботится о его подключении, или регистрации в автолойдере.
Выходит это не так и фраза "После чего система автоматически будет подключать файл при нахождении вызовов класса BookTable." полностью неправда? Или что-то необходимо сделать чтобы оно заработало?

[Роман Грицук]

А вы дочитали мой комментарий? Я же описал два варианта. В первом это описание класса в отдельном файле вне модуля, второй вариант в модуле.

[alisiy]

Но хорошо - если не модуль (решение не предполагает распространение и будет использоваться в одном проекте), то как лучше всего подключать классы сущностей? Каковы best practice?

[Роман Грицук]

В обоих вариантах идет речь о подключении файла с классом. Если все что вам нужно - это описать таблицу с помощью ORM класса, то модуль городить не стоит.

[alisiy]

Роман Грицук, т.е. имеется ввиду, что класс будет загружен автоматически только в случае если модуль установлен и подключен?
Понятно. Вопрос про наилучшее расположение и способ загрузки остается открытым.

[Роман Грицук]

Вопрос про наилучшее расположение и способ загрузки остается открытым.

все зависит от задачи. И тот и другой способ "правильные". Модуль пишут не для того, чтобы описать 1 таблицу в БД, а для того чтобы решить какую то задачу. Если в рамках выполняемой задачи Вам нужен модуль, то делайте его. Если нет, то подключайте класс отдельно в init.php с помощью require.

[alisiy]

Роман Грицук, сделала пока так в init.php - \Bitrix\Main\Loader::registerAutoLoadClasses(null, ['\My\Foo\BarTable' => '/local/lib/my/foo/bar.php']);

Работает. Спасибо.

Далее встает вопрос - а как создавать таблицы? Я честно говоря в тайне надеялась, что таблица будет создана тоже автоматически, в случае если не будет обнаружена, но оказалось что нет. Мне ее создать вручную или есть какой-то общепринятый способ?

[Роман Грицук]

Можно написать SQL запрос вручную и выполнить его. Либо можно написать вот такие методы внутри класса:

public static function createTable()
    {
        $connection = \Bitrix\Main\Application::getInstance()->getConnection();

        if (!$connection->isTableExists(static::getTableName())) {
            static::getEntity()->createDbTable();
            return true;
        } else {
            return false;
        }
    }

    public static function dropTable()
    {
        $connection = \Bitrix\Main\Application::getInstance()->getConnection();

        $connection->dropTable(static::getTableName());
        return true;
    }

Метод надо будет один раз вызвать для того чтобы создать таблицу (или удалить ее)

[alisiy]

Роман Грицук, т.е. все равно не автоматически или самой придется прикручивать автоматизацию...
Спасибо.

[alisiy]

Роман Грицук, в этом контексте static::getTableName() не возвращает имя таблицы :(

[Роман Грицук]

Быть такого не может. getTableName один из основных методов, который в первую очередь переопределяется в классе.

Если у вас в ORM D7 нет такого метода, то что то пошло не так. Данный метод используется для того чтобы получить имя таблицы в БД, которую описывает данный класс.

[alisiy]

Роман Грицук, метод createTable прекрасно создате таблицу и все работает. Проблемы начались когда я попыталась удалить таблицу методом dropTable. Тут-то и выяснилось что static::getTableName() возвращает пустую строку. Если в классе определить getTableName, он конечно работает. Но если сделать так:

public static function getTableName()
        {
            return parent::getTableName();
        }

Тоже закономерно пустая строка.

При этом static::getEntity()->createDbTable(); - создает таблицу какую надо.
Я посмотрела - он вызывает compileDbTableStructureDump где для получения имени таблицы использует getDBTableName, который возвращает свойство dbTableName.

Я посмотрела реализацию getTableName:

public static function getTableName()
    {
        return null;
    }

Так что ничего удивительного что он возвращает '';

[ragnar_ok]

alisiy, от себя добавлю, что в случае, если потребуется использование ManyToMany связей, то для создания линкующей таблицы придется в любом случае использовать SQL: Bitrix D7 ORM: как организвать отношение многие-ко-многим (ManyToMany/N:M)?

[Trionik]

Роман Грицук, а почему нельзя класс в компоненте подключить?

[Роман Грицук]

Trionik, да я и не говорил что его нельзя подключать в компоненте.

ИМХО
Просто смысла в этом нет. Я предпочитаю классы подключать либо в модулях либо через composer autoload. Тогда классы и методы доступны везде без лишних include.

Answer 2

[Trionik]

Сущность D7 это обычный класс.

Судя из того, что написано у битриксов https://dev.1c-bitrix.ru/learning/course/index.php...

Сучность - это таблица, конкретно у битриксов реализованная как класс, если есть необходимость динамического создания таблицы.