Управление данными
Suggest EditЭто руководство представляет минимальный набор для создания и редактирования моделей с помощью платформы. В текущем примере мы создадим страницы администрирования для блога.
На этом этапе желательно, чтобы вы уже познакомились с основами концепции экранов и просмотрели “Быстрый старт для начинающих”.
Для начала нам необходимо создать новую таблицу для этого выполним команду:
php artisan make:migration create_posts_table
В директории database/migrations будет создан новый файл миграции, добавим в него описание требуемых колонок.
// `****_**_**_create_posts_table.php
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
class CreatePostsTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('posts', function (Blueprint $table) {
$table->bigIncrements('id');
$table->string('title');
$table->string('description');
$table->text('body');
$table->bigInteger('author');
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('posts');
}
}
Для применения новой схемы к подключенной базе данных выполним:
php artisan migrate
После успешного создания таблицы, добавим новую Eloquent модель, для этого выполним:
php artisan make:model Post
В директории app будет создан новый файл Post.php, опишем поля как доступные для заполнения:
// app/Post.php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Orchid\Screen\AsSource;
class Post extends Model
{
use AsSource;
/**
* @var array
*/
protected $fillable = [
'title',
'description',
'body',
'author'
];
}
Примечание. Модель имеет трейт
AsSource, для удобного обращения через dot нотацию.
Теперь мы готовы к настоящему использованию платформы.
В предыдущем пособии мы уже создавали наш первый экран для отправки email сообщений, но теперь нам необходимо как отображать записи, так и редактировать их, поэтому добавим два новых экрана на каждое действие, поочередно выполнив команды:
php artisan orchid:screen PostEditScreen
php artisan orchid:screen PostListScreen
Примечание. Создание двух и более экранов для обеспечения CRUD не обязательно, но используется для удобства.
Зарегистрируем новые экраны в маршрутном листе приложения:
// routes/platform.php
use App\Orchid\Screens\PostEditScreen;
use App\Orchid\Screens\PostListScreen;
Route::screen('post/{post?}', PostEditScreen::class)
->name('platform.post.edit');
Route::screen('posts', PostListScreen::class)
->name('platform.post.list');
Теперь экраны доступны для просмотра по адресу /dashboard/post и /dashboard/posts.
Полученные экраны на текущий момент не имеют, ни данных, ни действий. Отредактируем PostEditScreen для просмотра, добавив название, описание и требуемые поля:
namespace App\Orchid\Screens;
use App\Post;
use App\User;
use Illuminate\Http\Request;
use Orchid\Screen\Fields\Input;
use Orchid\Screen\Fields\Quill;
use Orchid\Screen\Fields\Relation;
use Orchid\Screen\Fields\TextArea;
use Orchid\Screen\Fields\Upload;
use Orchid\Screen\Layout;
use Orchid\Screen\Actions\Button;
use Orchid\Screen\Screen;
use Orchid\Support\Facades\Alert;
class PostEditScreen extends Screen
{
/**
* Display header name.
*
* @var string
*/
public $name = 'Creating a new post';
/**
* Display header description.
*
* @var string
*/
public $description = 'Blog posts';
/**
* @var bool
*/
public $exists = false;
/**
* Query data.
*
* @param Post $post
*
* @return array
*/
public function query(Post $post): array
{
$this->exists = $post->exists;
if($this->exists){
$this->name = 'Edit post';
}
return [
'post' => $post
];
}
/**
* Button commands.
*
* @return Link[]
*/
public function commandBar(): array
{
return [
Button::make('Create post')
->icon('icon-pencil')
->method('createOrUpdate')
->canSee(!$this->exists),
Button::make('Update')
->icon('icon-note')
->method('createOrUpdate')
->canSee($this->exists),
Button::make('Remove')
->icon('icon-trash')
->method('remove')
->canSee($this->exists),
];
}
/**
* Views.
*
* @return Layout[]
*/
public function layout(): array
{
return [
Layout::rows([
Input::make('post.title')
->title('Title')
->placeholder('Attractive but mysterious title')
->help('Specify a short descriptive title for this post.'),
TextArea::make('post.description')
->title('Description')
->rows(3)
->maxlength(200)
->placeholder('Brief description for preview'),
Relation::make('post.author')
->title('Author')
->fromModel(User::class, 'name'),
Quill::make('post.body')
->title('Main text'),
])
];
}
/**
* @param Post $post
* @param Request $request
*
* @return \Illuminate\Http\RedirectResponse
*/
public function createOrUpdate(Post $post, Request $request)
{
$post->fill($request->get('post'))->save();
Alert::info('You have successfully created an post.');
return redirect()->route('platform.post.list');
}
/**
* @param Post $post
*
* @return \Illuminate\Http\RedirectResponse
* @throws \Exception
*/
public function remove(Post $post)
{
$post->delete()
? Alert::info('You have successfully deleted the post.')
: Alert::warning('An error has occurred')
;
return redirect()->route('platform.post.list');
}
}
Теперь мы можем создавать, редактировать и удалять записи. Но не просматривать в виде списка, изменим это!
Во всех предыдущих определениях слоёв использовалась только короткая запись вида Layout:rows(), но для
отображения сложной или объемной информации желательно создавать отдельные классы.
Добавим новый класс Layout, выполнив команду:
php artisan orchid:table PostListLayout
Укажем какие данные мы ходим видеть:
namespace App\Orchid\Layouts;
use App\Post;
use Orchid\Screen\TD;
use Orchid\Screen\Actions\Link;
use Orchid\Screen\Layouts\Table;
class PostListLayout extends Table
{
/**
* Data source.
*
* @var string
*/
public $target = 'posts';
/**
* @return TD[]
*/
public function columns(): array
{
return [
TD::set('title', 'Title')
->render(function (Post $post) {
return Link::make($post->title)
->route('platform.post.edit', $post);
}),
TD::set('created_at', 'Created'),
TD::set('updated_at', 'Last edit'),
];
}
}
Свойство target указывает ключ, который будет источником для нашей таблицы на экране.
Примечание. Формирование
HTMLнепосредственно в классе необходимо только для примера и является плохой практикой. Пожалуйста, используйтеBladeшаблоны.
Определив слой таблицы, вернемся к экрану просмотра, изменим его:
namespace App\Orchid\Screens;
use App\Orchid\Layouts\PostListLayout;
use App\Post;
use Orchid\Screen\Actions\Link;
use Orchid\Screen\Screen;
class PostListScreen extends Screen
{
/**
* Display header name.
*
* @var string
*/
public $name = 'Blog post';
/**
* Display header description.
*
* @var string
*/
public $description = 'All blog posts';
/**
* Query data.
*
* @return array
*/
public function query(): array
{
return [
'posts' => Post::paginate()
];
}
/**
* Button commands.
*
* @return Link[]
*/
public function commandBar(): array
{
return [
Link::make('Create new')
->icon('icon-pencil')
->route('platform.post.edit')
];
}
/**
* Views.
*
* @return Layout[]
*/
public function layout(): array
{
return [
PostListLayout::class
];
}
}
Теперь наш набор для управления (создание, просмотр, редактирование и удаление записи) блогом готов. Не забудьте позаботиться об удобстве навигации из предыдущего материала, добавив пункты меню и хлебные крошки.