Концепция экранов
Suggest EditОсновным элементом платформы являются экраны, описанные иерархией компоновки, в соответствии с которой каждый элемент имеет свойства, которые влияют на его внешний вид и поведение.
Проще говоря, то, что пользователь видит на странице и какие действия совершает, описывается в одном классе под
названием “Экран”. Он не знает откуда берутся данные, это может быть: база данных, API или любые другие внешние
источники. Построение внешнего вида основано на предоставленных шаблонах (Layouts) и всё, что вам нужно сделать, это лишь определить какие данные будут показаны в том или ином шаблоне.

Создание
Вы можете создать новый экран, выполнив Artisan команду:
php artisan orchid:screen Idea
В директории app/Orchid/Screens будет создан файл Idea со следующим содержанием:
namespace App\Http\Controllers\Screens;
use Illuminate\Http\Request;
use Orchid\Platform\Screen\Screen;
class Idea extends Screen
{
/**
* Display header name
*
* @var string
*/
public $name = 'Idea Screen';
/**
* Display header description
*
* @var string
*/
public $description = 'Idea Screen';
/**
* Query data
*
* @return array
*/
public function query() : array
{
return [];
}
/**
* Button commands
*
* @return array
*/
public function commandBar() : array
{
return [];
}
/**
* Views
*
* @return array
*/
public function layout() : array
{
return [];
}
}
Регистрация в маршрутах
Прежде чем быть доступными по прямому URL адресу, экраны, так же как и контроллеры, необходимо зарегистрировать в
файле маршрутов /routes/platform.php. Записанные в него маршруты будут проходить через 'middleware’, указанные в
private конфигурации. Зарегистрировать каждый экран можно с помощью метода screen у
Route:
use App\Orchid\Screens\Idea;
Route::screen('/idea', Idea::class)->name('platform.idea');
Добавление экрана немного отличаться от привычной регистрации, например, GET запроса, тем, что вместо одного
адреса, регистрируется целая группа. Для наглядности можно выполнить Artisan команду route:list:
Method | URI | Name
---------+--------------------------+--------------
GET|POST | dashboard/idea/{method?} | platform.idea
Если вы регистрируете несколько маршрутов:
use App\Orchid\Screens\Idea;
use App\Orchid\Screens\IdeaEdit;
Route::screen('/idea/edit', IdeaEdit::class)->name('platform.idea.edit');
Route::screen('/idea', Idea::class)->name('platform.idea');
Обратите внимание, Routing Laravel выбирает первый подходящий маршрут.
Написав такие маршруты:
Route::screen('/idea', ...
Route::screen('/idea/edit',...
Мы получаем:
URI | Name
------------------------------+----------------------
dashboard/idea/{method?} | platform.idea
dashboard/idea/edit/{method?} | platform.idea.edit
{method?} – означает необязательный аргумент, который может идти далее.
Соотвественно под него попадает имя “edit” в адресе.
В итоге будет редирект на “dashboard/idea/”
Получение данных
Данные для показа на экране определяются в методе query, где должны происходить выборки или формирование
информации.
Передача осуществляется в виде массива, ключи будут доступны в макетах, для их управления.
public function query() : array
{
return [
'name' => 'Alexandr Chernyaev',
];
}
В качестве источника может выступать модель Eloquent, для этого необходимо добавить трейт AsSource :
namespace App;
use Illuminate\Database\Eloquent\Model;
use Orchid\Screen\AsSource;
class Order extends Model
{
use AsSource
}
Пример, при котором в Layouts будут доступны ключи order и orders:
public function query() : array
{
return [
'order' => Order::find(1),
'orders' => Order::paginate(),
];
}
Использование именно моделей Eloquent не обязательно, возможно использование массивов с помощью обёртки
Repository:
//...
use Orchid\Screen\Repository;
//...
public function query() : array
{
return [
'order' => new Repository([
'product_id' => 'prod-100',
'name' => 'Desk',
'price' => 10.24,
'created_at' => '01.01.2020',
]),
];
}
Обработка
В экранах предусмотрены встроенные команды, позволяющие пользователям выполнять различные пользовательские
сценарии.
За это отвечает метод commandBar, в котором описываются требуемые кнопки управления.
Например:
public function commandBar() : array
{
return [
Button::make('Вывести на печать')->method('print'),
];
}
Класс Button отвечает за то, что будет происходить по нажатию на кнопку. В примере выше, при нажатии на кнопку
Вывести на печать,
будет вызван метод экрана print, в Request будут доступны все данные, которые пользователь видел на экране.
// По нажатию будет вызван метод 'create'
use Orchid\Screen\Actions\Button;
Button::make('Новая функция')
->method('create');
// По нажатию будете перенаправлены на указанный адрес
use Orchid\Screen\Actions\Link;
Link::make('Внешняя ссылка')
->href('http://orchid.software');
// По нажатию будет показано модальное окно (CreateUserModal),
// в котором можно выполнить метод "save"
use Orchid\Screen\Actions\ModalToggle;
ModalToggle::make('Модальное окно')
->modal('CreateUserModal')
->method('save');
Макеты
Макеты отвечают за внешний вид экрана, то есть, как и в каком виде данные будут показаны.
Каждый макет может включать в себя другой макет, то есть возможна вложенность. Например, экран делится двумя колонками, в левой поля для заполнения, справа справочная таблица и график. Вы можете придумать свои примеры вложения.
public function layout() : array
{
return [
Layout::columns([
'Левая колонка' => [
FirstRows::class,
],
'Правая колонка' => [
SecondRows::class,
],
]),
// Модальное окно
Layout::modal('Appointments', [
ThirdRows::class,
]),
];
}
Иногда вы захотите использовать один и тот же макет для разных целей, чтобы уменьшить дублирование кода, вы можете создать макет и передавать собственные параметры в конструктор класса:
namespace App\Orchid\Layouts;
use Orchid\Screen\Field;
use Orchid\Screen\Fields\Input;
use Orchid\Screen\Fields\Label;
use Orchid\Screen\Layouts\Rows;
class ReusableEditLayout extends Rows
{
/**
* @var string
*/
private $title;
/**
* @var string
*/
private $prefix;
/**
* ReusableEditLayout constructor.
*
* @param string $prefix
* @param string $title
*/
public function __construct(string $prefix, string $title)
{
$this->prefix = $prefix;
$this->title = $title;
}
/**
* Views.
*
* @return Field[]
*/
protected function fields(): array
{
return [
Label::make('label')
->title($this->title),
Input::make($this->prefix . '.address')
->required()
->title('Address')
->placeholder('177A Bleecker Street'),
];
}
}
Экземпляры могут быть использованы таким же образом, принимая параметры
public function layout(): array
{
return [
Layout::columns([
new ReusableEditLayout('order.shipping_address', 'Shipping Address'),
new ReusableEditLayout('order.invoice_address', 'Invoice Address'),
]),
];
}
Более подробно можно прочитать в разделе Макеты.