Download the PHP package mrzlanx532/laravel-basic-components without Composer

On this page you can find all versions of the php package mrzlanx532/laravel-basic-components. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package laravel-basic-components

Оглавление

Установка

  1. Устанавливаем пакет: composer require mrzlanx532/laravel-basic-components
  2. Публикуем настройки: php artisan vendor:publish --tag="laravel-basic-components-config"
  3. Публикуем миграции: php artisan vendor:publish --tag="laravel-basic-components-migrations"
  4. Если в проекте не используется browser (компонент, который используется в админке), удаляем миграцию create_duotek_browser_filters_presets.
  5. Выполняем команду: php artisan migrate

Важно

  1. При установке пакета устанавливается middleware для группы api Mrzlanx532\LaravelBasicComponents\Middleware\ReplaceNullValuesInFormData
  2. Приложение должно работать в UTC (00:00), соответственно, в конфиге config.app должно быть:
    timezone => 'UTC'
  3. Все даты для datetime и timestamp при сохранении должны приводится к UTC (00:00)

Компоненты и как их использовать

Трейт UploadImages (Mrzlanx532\LaravelBasicComponents\Traits\Model\UploadImages\UploadImages)

Зачем нужен?

1) Сохранение\Обновление изображений из параметров Request с учетом конфигурации в модели
( в модели определяется нарезать ли картинки и как нарезать ) 2) При обновлении также удаляются предыдущие файлы с сервера

Как использовать?

  1. Трейт вставляется в модель, которая имеет изображения в свойствах.
    Для правильной конфигурации необходимо в свойство модели $filePropertiesWithSettings поместить конфиг по примеру ниже:

  2. Для корректного вывода в ресурсах делаем так:

  3. Если нужно чтобы файлы отдавались с абсолютным путем через метод getFileLinksBySettings можно:

    • Глобально добавить UPLOAD_FILE_DOMAIN=http://api.example.ru в .env файл в корне проекта
    • Локально добавить ->getFileLinksBySettings('photo', 'http://api.example.ru')
  4. Если нужно в обособленном ресурсе, не привязываясь к классу, вывести изображения по конфигу модели:

Трейт UploadFile (Mrzlanx532\LaravelBasicComponents\Traits\Model\UploadFile\UploadFile)

Зачем нужен?

Трейт применяется к смежным таблицам. (например: таблица user_files, где есть колонка user_id и file_id)
Позволяет удобно сохранять, обновлять, удалять файлы взаимодействуя с таблицей files.
Также позволяет удобно настраивать конфигурацию сохранения (см. ниже)

При обновление модели удаляет предыдущий файл и заменяет новым.
При удаление модели удаляет файл (если нету трейта SoftDeletes).
При удалении через forceDelete файл тоже физически удаляется.

Как использовать?

  1. Создаем модель для промежуточной таблицы файлов (например: user_files)

  2. Применяем в сервисе.

  3. Итог У нас сохранились файлы в storage/app/private/files/<год>/<месяц>/<день>/<хэш_от_файла>.<расширение_файла>.
    Добавились в таблицу files и создалась связь в таблице user_files

Класс Service (Mrzlanx532\LaravelBasicComponents\Service)

Зачем нужен?

Сервис является обязательным для использования при POST-действиях.
Например: Создание клиента, Изменение статуса заказа, Обновления данных клиента, Удаления клиента

Как использовать?

  1. Создаем сервис

  2. Применяем в контроллере

Важные нюансы

  1. params в методе getRules доступны в чистом виде (всё что приходит с Request или array)
  2. params в методе handle очищены от полей, которые отсутствуют в getRules

    Класс Definition (Mrzlanx532\LaravelBasicComponents\Definition\Definition)

    Зачем нужен?

    Используется для хранения констант в определенном формате.
    Имеет множество методов для удобной работы с ними.

    Как использовать?

Как локализовать title?

Как заполнить локализацию?

Как вызвать все константы с учётом локализации?
Как вызвать одну константу с учётом локализации?

Класс PanelForm (Mrzlanx532\LaravelBasicComponents\PanelForm\PanelForm)

Зачем нужен?

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

Используется исключительно в админках.

Как использовать?

  1. Создаем PanelForm
  1. Применяем в контроллере

Класс QueryBuilder (Mrzlanx532\LaravelBasicComponents\QueryBuilder)

Зачем нужен?

Нужен для построения сложных запросов с участнием Illuminate\Http\Request и соответственно инкапсуляции логики

Как использовать?

  1. Создаем QueryBuilder

  2. Используем в контроллере

Важные нюансы

  1. params в методе getRules доступны в чистом виде (всё что приходит с Request или array)
  2. params в методе handle очищены от полей, которые отсутствуют в getRules

Класс PanelSet (Mrzlanx532\LaravelBasicComponents\PanelSet\PanelSet)

Зачем нужен?

Используется в качестве соглашения с библиотекой на фронтенде для определения интерфейса на фронтенде через бэкенд.

Используется исключительно в админках.

Как использовать?

  1. Создаем PanelSet
  1. Используем в контроллере

Дополнительно:

Пример из POSTMAN как управляться с фильтрами:

Класс PanelSetSortable (Mrzlanx532\LaravelBasicComponents\PanelSetSortable\PanelSetSortable)

Зачем нужен?

Используется в качестве соглашения с библиотекой на фронтенде для определения интерфейса на фронтенде через бэкенд.

Нужен для компонента на фронте, который имеет Drag'n'Drop

Компонент определяет порядок записей
и может вкладывать одну запись в другую (опционально)

Как использовать?

  1. Создаем PanelSetSortable
  1. Используем в контроллере

  2. Добавляем метод обновления сортировки\вложенности в контроллер

Класс BrowserFilterPresetController (Mrzlanx532\LaravelBasicComponents\Controllers\BrowserFilterPresetController)

Зачем нужен?

Используется в качестве соглашения между фронтендом и бэкэндом.
Содержит в себе контроллер с методами для сохранения\изменения\удаления пользовательских пресетов.

Как использовать?

Вставляем машруты в файл с роутами (там где необходимо).

Используется исключительно в админках, вместе с компонентом PanelSet


All versions of laravel-basic-components with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
laravel/framework Version ^8.3|^9.11|^11.0|^12.0
intervention/image Version ^2.5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package mrzlanx532/laravel-basic-components contains the following files

Loading the files please wait ...