Upgrade tutorial

Suggest Edit

Notice. We are doing all we can to document all the changes that may cause problems. But we highly recommend to not perform any changes without a backup.

Upgrade from 2.0 to 2.1

Changes

Field definition

With this update ORCHID introduces the new field notation and table formatting. More information about it may be found in issue #391

Old notation

'body' => 'tag:tag|wysiwyg|name:body|max:255|required|rows:10',

New notation

Field::tag('wysiwyg')
    ->name('body')
    ->max(255)
    ->required()
    ->rows(10),

Deprecated notation will be supported for some time but the best solution for a long-term support is to wrap an old notation the following way:

'body' => Field::make('tag:tag|wysiwyg|name:body|max:255|required|rows:10'),

Table rows have also changed and now havw the following notation:

TD::name('appointment_type')
->title('Type')

// Extended variant
TD::name('appointment_time')
    ->title('Time')
    ->width('200px')
    ->setRender(function ($appointment){
    return $appointment->appointment_time->toDateString();
}),

Behaviors

Many behaviors now don’t have a default property:

/**
 * HTTP data filters
 *
 * @var array
 */
public $filters = [
    SearchFilter::class,
    StatusFilter::class,
    CreatedFilter::class,
];

For standardization it was replaced with the following method:

/**
 * HTTP data filters
 *
 * @return array
 */
public function filters() : array
{
    return [
        SearchFilter::class,
        StatusFilter::class,
        CreatedFilter::class,
    ];
}

Deleted functions

Fields

Impractical features that were previously declined deprecated are now deleted:

  • robot field
  • Widget for Google Analytics

The more functionat alternative to robot field is:

Field::tag('select')
    ->options([
        'index' => 'Index',
        'noindex' => 'No index',
    ])
    ->name('robot')
    ->title('Indexing')
    ->help('Allow search bots to index page'),

Field section in configuration now must look like that:

'fields' => [
    'textarea'     => Orchid\Platform\Fields\Types\TextAreaField::class,
    'input'        => Orchid\Platform\Fields\Types\InputField::class,
    'list'         => Orchid\Platform\Fields\Types\ListField::class,
    'tags'         => Orchid\Platform\Fields\Types\TagsField::class,
    'select'       => Orchid\Platform\Fields\Types\SelectField::class,
    'relationship' => Orchid\Platform\Fields\Types\RelationshipField::class,
    'place'        => Orchid\Platform\Fields\Types\PlaceField::class,
    'picture'      => Orchid\Platform\Fields\Types\PictureField::class,
    'datetime'     => Orchid\Platform\Fields\Types\DateTimerField::class,
    'checkbox'     => Orchid\Platform\Fields\Types\CheckBoxField::class,
    'code'         => Orchid\Platform\Fields\Types\CodeField::class,
    'wysiwyg'      => Orchid\Platform\Fields\Types\TinyMCEField::class,
    'password'     => Orchid\Platform\Fields\Types\PasswordField::class,
    'markdown'     => Orchid\Platform\Fields\Types\SimpleMDEField::class,
],