Upgrade Guide
Suggest EditUpgrading to 8.0 from 7.x
We try to document all possible breaking changes. Some of these changes are internal calls, so only some of these changes may actually affect your application.
Updating dependencies
In your composer.json file, update the orchid/platform dependency to ^8.0
TinyMCE editor
The HTML editor has been removed from the standard distribution. The code has been moved to a separate
repository.
Settings model
The settings model has also been removed. Data stored in the database will not be deleted automatically.
To remove them, you need to execute the following SQL code:
DROP TABLE settings;
DELETE FROM migrations
WHERE migration = '2015_12_02_181214_create_table_settings';
The source code is available for installation as a separate package.
Bread crumbs
Package davejamesmiller/laravel-breadcrumbs is replaced with tabuna/breadcrumbs
and should be installed automatically when the dependencies are updated.
Note: It may be necessary to remove the boot cache files in the
bootstrap/cachedirectory.
The syntax of the new package allows you to display breadcrumbs right in the route definition:
Route::screen('example', ExampleScreen::class)
->name('platform.example')
->breadcrumbs(function (Trail $trail) {
return $trail->parent('platform.index')->push(__('Example screen'));
});
Alternatively, you can continue to use a separate file for them. To do this, you need to download it to the service provider:
namespace App\Providers;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
/**
* Bootstrap the application events.
*
* @return void
*/
public function boot()
{
require base_path('routes/breadcrumbs.php');
}
}
If you used full class names, then you need to replace them with similar ones:
use Tabuna\Breadcrumbs\Breadcrumbs;
use Tabuna\Breadcrumbs\Trail;
Screen changes
Constructor
Passing a Request object and calling the parent class is no longer necessary. Before:
class PublicationScreen extends Screen
{
public function __construct(Request $request, Locator $locator)
{
$this->request = $request;
$this->locator = $locator;
}
}
The definition now looks like this:
class PublicationScreen extends Screen
{
public function __construct(Locator $locator)
{
$this->locator = $locator;
}
}
Route methods
Methods not used have been removed. It is no longer possible to access screens via the PUT|PATCH|DELETE methods, the call must use GET|POSTS to receive/send data.
Method | URI | Name
-----------------+--------------------------------------+--------------
GET|HEAD|POST | dashboard/idea/{method?} | platform.idea
Now, screen methods awaiting a model, if not present, will implement an empty model as well as controllers. Related issue.
Data spoofing (Async)
The {argument?} Expectation has been removed from the address bar.
Now a separate route is used for the call:
$this->router
->post('async/{screen}/{method?}/{template?}', [AsyncController::class, 'load'])
->name('async');
Layouts
Each layer now inherits from the class Orchid\Screen\Layout, rather than from Orchid\Screen\Layouts\Base.
To declare layers via short syntax, the Orchid\Support\Facades\Layout facade should now be used instead of the
Orchid\Screen\Layout class.
It was:
use Orchid\Screen\Layout;
Layout::row([
// ...
]);
Became:
use Orchid\Support\Facades\Layout;
Layout::row([
// ...
]);
Release message
A system message informed users that a new version of the package was released. But they have no way to update
without the help of a developer.
This was more annoying than keeping the software up to date. Therefore, it was removed, if you used it (By default
only on the first screen), then you should remove its call as well as the blade template. Screen call example:
return [
'status' => Dashboard::checkUpdate(),
];
Using a template in the screen:
Layout::view('platform::partials.update');
Icons
The icon display has been changed from font to SVG format.
Now the ->icon methods do not accept the css value to be set, but the file name.
In most cases, you only need to remove the icon- prefix.