Skip to content

Latest commit

 

History

History
217 lines (191 loc) · 12.5 KB

UPGRADE.md

File metadata and controls

217 lines (191 loc) · 12.5 KB

Инструкция по обновлению ActivityLogger

Этот файл содержит примечаний которые, может нарушить работу компонента при обновлении из одной версии в другую. Хотя мы стараемся обеспечить обратную совместимость, насколько это возможно, иногда это не возможно, или приводит к существенному снижению производительности. Так же вы сможете следить за всеми критическими изменениями в нашем проекте.

Обновление 2.2

  • Удалены \lav45\activityLogger\Manager::$user
  • Удалены \lav45\activityLogger\Manager::$userNameAttribute
  • Добавлен \lav45\activityLogger\middlewares\UserInterface для User модели 
    Yii::$container->setDefinitions([
    \lav45\activityLogger\middlewares\UserInterface::class => static fn() => Yii::$app->getUser()->getIdentity(),
]);
  • Добавлен \lav45\activityLogger\Manager::$middlewares которые будут заполнять данные для \lav45\activityLogger\MessageData 
    return [
    'components' => [
        'activityLogger' => [
            '__class' => \lav45\activityLogger\Manager::class,
            'middlewares' => [
                [
                    'class' => \lav45\activityLogger\middlewares\UserMiddleware::class,
                ],
                [
                    'class' => \lav45\activityLogger\middlewares\EnvironmentMiddleware::class,
                    '__construct()' => [ 'env' => 'api' ],
                ]
            ],
        ],
    ],
];
  • Удалён \lav45\activityLogger\DummyManager. Вместо него добавлен \lav45\activityLogger\storage\ArrayStorage.
  • Удалён \lav45\activityLogger\ManagerInterface::isEnabled()
  • Переименован namespace \lav45\activityLogger\modules -> \lav45\activityLogger\module

Обновление 2.1

  • Переместил \lav45\activityLogger\DbStorage -> \lav45\activityLogger\storage\DbStorage
  • Переместил \lav45\activityLogger\StorageInterface -> \lav45\activityLogger\storage\StorageInterface
  • Переместил \lav45\activityLogger\DeleteCommand -> \lav45\activityLogger\storage\DeleteCommand
  • Переместил \lav45\activityLogger\MessageData -> \lav45\activityLogger\storage\MessageData
  • Удалён \lav45\activityLogger\ManagerTrait
  • Необходимо настроить DI container 
    Yii::$container->setDefinitions([
    \lav45\activityLogger\ManagerInterface::class => static fn() => Yii::$app->get('activityLogger'),
    \lav45\activityLogger\storage\StorageInterface::class => static fn() => Yii::$app->get('activityLoggerStorage'),
]);
  • Вместо свойства \lav45\activityLogger\Manager::$enabled следует использовать \lav45\activityLogger\Manager::isEnabled()
  • Если необходимо отключить логирование, используйте компонент заглушку \lav45\activityLogger\DummyManager
  • Из консольного контроллера logger/clean был удалён параметр --old-than=1y, который был выставлен по умолчанию!

Обновление 2.0

  • Переименован lav45\activityLogger\LogMessageDTO -> lav45\activityLogger\MessageData
  • Доработан lav45\activityLogger\DeleteCommand
  • lav45\activityLogger\MessageData::$createdAt указывается сразу при инициализации.
  • Удалёно свойство lav45\activityLogger\Manager::$userIdPrefix. Вместо этого можете настроить \lav45\activityLogger\ActiveLogBehavior::$getEntityId
  • php >= 7.4

Обновление 1.8

  • В классе \lav45\activityLogger\modules\models\ActivityLogSearch удалены методы setEntityMap(), getEntityMap(), getEntityNameList()
  • Доработана src/modules/views/default/_item.php
  • Удалён src/modules/views/default/_search.php
  • Доработан \lav45\activityLogger\StorageInterface и \lav45\activityLogger\DbStorage
  • Переименован и доработан класс \lav45\activityLogger\LogMessage => LogMessageDTO
  • Удалено свойство \lav45\activityLogger\Manager::$messageClass настройки можно передать через Yii::$container 
    Yii::$container->set(\lav45\activityLogger\LogMessageDTO::class, [
    'env' => 'console', // Окружение из которого производилось действие
    'userId' => 'console',
    'userName' => 'Droid R2-D2',
]);

Обновление 1.7

  • Удалено свойство \lav45\activityLogger\Manager::$deleteOldThanDays. Вместо него можно использовать параметр --old-than=30d консольного контроллера logger/clean
  • Удалено свойство \lav45\activityLogger\ActiveLogBehavior::$actionLabels. Изменения коснулись только стандартных действий если вы использовали произвольные имена действий то они будут отображаться как есть.

Обновление 1.6

  • Доработан метод \lav45\activityLogger\ActiveLogBehavior::beforeSaveMessage() и событие \lav45\activityLogger\ActiveLogBehavior::EVENT_BEFORE_SAVE_MESSAGE Все данные которые будут сохранены, передаются всем кто подписан на событие чтобы пользователь мог добавить или изменить некоторые данные по своему усмотрению

Обновление 1.5

  • Класс \lav45\activityLogger\ActiveRecordBehavior был переименован в \lav45\activityLogger\ActiveLogBehavior Для поддержки обратной совместимости был добавлен пустой класс \lav45\activityLogger\ActiveRecordBehavior который будет удален с 1.6 версии

  • Немного доработано представление src/modules/views/default/_item.php

  • При записи в лог пустой строки она будет отображаться как Yii::$app->formatter->nullDisplay

  • Значение по умолчанию для \lav45\activityLogger\ActiveRecordBehavior::$identicalAttributes теперь false

  • \lav45\activityLogger\ActiveRecordBehavior не будет писать в лог пустые значения. За проверку наличия непустых данных отвечает метод ActiveRecordBehavior::isEmpty(), работу которого можно скорректировать с помощью свойства ActiveRecordBehavior::$isEmpty передав ему свою функцию.

  • Удалены методы \lav45\activityLogger\LogMessage

    • getEntityName()
    • setEntityName()
    • getEntityId()
    • setEntityId()
    • getCreatedAt()
    • setCreatedAt()
    • getUserId()
    • setUserId()
    • getUserName()
    • setUserName()
    • getAction()
    • setAction()
    • getEnv()
    • setEnv()

    В место этого будут использоваться публичные свойства.

  • Для того чтобы переопределить метод \lav45\activityLogger\ActiveRecordBehavior::getEntityName() используйте параметр \lav45\activityLogger\ActiveRecordBehavior::$getEntityName. Пользовательская функция должна возвращать строку.

  • Для того чтобы переопределить метод \lav45\activityLogger\ActiveRecordBehavior::getEntityId() используйте параметр \lav45\activityLogger\ActiveRecordBehavior::$getEntityId. Пользовательская функция должна возвращать строку или массив.

        public function behaviors()
    {
        return [
            [
                '__class' => 'lav45\activityLogger\ActiveRecordBehavior',
             
                // Если необхадимо изменить стандартное значение `entityName`
                'getEntityName' => function () {
                    return 'global_news';
                },
                // Если необхадимо изменить стандартное значение `entityId`
                'getEntityId' => function () {
                    return $this->global_news_id;
                }
            ]
        ];
    }

  • \lav45\activityLogger\DbStorage

    • Удалён метод clean($date), а также из интерфейса \lav45\activityLogger\StorageInterface::clean($date)
    • Метод delete($entityName, $entityId) теперь принимает delete(\lav45\activityLogger\LogMessage $message)

  • \lav45\activityLogger\Manager

    • Был удален метод createMessage()
    Yii::$app->activityLogger
    ->createMessage($entityName, [
        'entityId' => $entityId,
        'data' => [$messageText],
        'action' => $action,
    ])
    ->save();

    Вместо него был добавлен доработан более простой аналог log()

    Yii::$app->activityLogger->log($entityName, $messageText, $action, $entityId);

Обновление 1.4

  • Данные для \lav45\activityLogger\modules\models\DataModel теперь передаются через метод setData(array $value)
  • Был удален \lav45\activityLogger\StorageTrait, а его код перенесен в \lav45\activityLogger\Manager
  • Для переводов будет использоваться категория lav45/logger в место app 
    Yii::t('lav45/logger', $text);
  • Для таблицы activity_log было добавлено поле 'id' => $this->bigPrimaryKey()

Обновление 1.3

  • \lav45\activityLogger\DbStorage теперь должен быть зарегистрирован в списке компонентов под именем activityLoggerStorage и реализовывать интерфейс \lav45\activityLogger\StorageInterface

Обновление 1.2

  • \lav45\activityLogger\modules\models\ActivityLogViewModel::getUserName() генерирует ссылку для текущей страницы используя метод Url::current()
  • Изменилась фраза The setting <strong>{attribute}</strong> has ben changed на <strong>{attribute}</strong> has ben changed
  • В файле представления src/modules/views/default/_item.php добавлено отображение ссылки для фильтрации по конкретному пользователю $model->getEntityName()
  • Была переименована папка migrates в migrations
  • Метод \lav45\activityLogger\modules\models\ActivityLog::getData() теперь всегда будет возвращать массив
  • \lav45\activityLogger\modules\Module::$createUserUrl был удален. Вместо него будет использоваться ссылка выполняющая роль фильтрации данных по конкретному пользователю.
  • Параметр \lav45\activityLogger\Manager::$user может принимать только имя компонента зарегистрированного в приложении и соответствующего классу \yii\web\User

Обновление 1.1

  • Удалены интерфейсы \lav45\activityLogger\contracts\ManagerInterface и \lav45\activityLogger\contracts\MessageInterface
  • \lav45\activityLogger\contracts\StorageInterface => lav45\activityLogger\StorageInterface