Comment construire un plugin de widget octobrecms

Cet article plonge dans la construction d'un plugin de widget backend octobrecms, en développant la création de plugin de base. Nous développerons un widget "rapide", reflétant les fonctionnalités provisoires rapides de WordPress.

Concepts clés:

• Échafaudage du plugin avec php artisan create:plugin.
• étendre le modèle utilisateur pour gérer les notes spécifiques à l'utilisateur.
• Implémentation d'un widget de rapport (QuickNoteWidget) pour le tableau de bord backend.
• Définition des propriétés du widget (defineProperties) pour la personnalisation (par exemple, cacher la liste des notes, modifier le titre).
• en utilisant des contrôleurs et des modèles pour la gestion des formulaires, la gestion des notes (opérations CRUD).

Construire le widget rapide de notes:

Nous créerons un widget qui permet aux utilisateurs d'ajouter et de gérer rapidement les notes courtes directement à partir de leur tableau de bord octobre.

1. Configuration du plugin:

Générez le plugin à l'aide de la ligne de commande:

php artisan create:plugin RAFIE.quicknote

Mise à jour Plugin.php avec les détails du plugin:

public function pluginDetails()
{
    return [
        'name'        => 'Quick Note Widget',
        'description' => 'Quickly add and manage short notes.',
        'author'      => 'RAFIE Younes',
        'icon'        => 'icon-pencil'
    ];
}

et le version.yaml:

# uploads/version.yaml
1.0.1: First version of quicknote
1.0.2:
  - Created Notes Table
  - create_notes_table.php

2. Modèle de base de données:

Créez le modèle Note et la migration:

php artisan create:model RAFIE.quicknote Note

La migration (create_notes_table.php) ressemblera à ceci:

Schema::create('rafie_quicknote_notes', function ($table) {
    $table->engine = 'InnoDB';
    $table->increments('id');
    $table->string('title', 255);
    $table->text('description')->nullable();
    $table->integer('user_id')->unsigned()->index();
    $table->timestamps();
});

actualiser le plugin:

php artisan plugin:refresh RAFIE.quicknote

étendre le modèle User dans Plugin.php:

public function boot()
{
    User::extend(function ($model) {
        $model->hasMany['notes'] = ['RAFIE\Quicknote\Models\Note'];
    });
}

le modèle Note (models/Note.php):

use October\Rain\Database\Traits\Validation;

class Note extends Model
{
    use Validation;

    public $table = 'rafie_quicknote_notes';

    protected $guarded = ['*'];

    protected $rules = [
        'title' => 'required|min:4'
    ];

    public $belongsTo = ['user' => ['Backend\Models\User']];
}

3. Création du widget:

créer QuickNoteWidget.php (dans le dossier widgets):

class QuickNoteWidget extends ReportWidgetBase
{
    public function render()
    {
        $notes = BackendAuth::getUser()->notes;
        return $this->makePartial('notes', ['notes' => $notes]);
    }

    public function defineProperties()
    {
        return [
            'title' => [
                'title' => 'Widget Title',
                'default' => 'Quick Note'
            ],
            'showList' => [
                'title' => 'Show Notes List',
                'type' => 'checkbox'
            ]
        ];
    }
}

Enregistrez le widget dans Plugin.php:

public function registerReportWidgets()
{
    return [
        'RAFIE\Quicknote\QuickNoteWidget' => [
            'label' => 'Quick Notes',
            'context' => 'dashboard'
        ]
    ];
}

Créez le partiel _notes.htm (dans widgets/quicknotewidget/partials):

<div class="report-widget">
    <h3 id="this-gt-property-title">{{ $this->property('title') }}</h3>
    <div class="pane">
        @if ($this->property('showList'))
            <ul class="list-nostyle">
                @foreach ($notes as $note)
                    <li class="list-group-item">{{ $note->title }}</li>
                @endforeach
            </ul>
        @endif
        <br/>
        {{ Form::open(['url' => Backend::url('rafie/quicknote/notes/store'), 'method' => 'POST']) }}
        <div class="form-group">
            <input class="form-control" type="text" name="title" placeholder="Title" required/>
        </div>
        <div class="form-group">
            <textarea class="form-control" name="description" id="" cols="30" rows="10"
                      placeholder="Your note..."></textarea>
        </div>
        <div class="form-group">
            <button type="submit" class="btn btn-primary" value="Submit">Submit</button>
            <a href="https://www.php.cn/link/b4c174fbc208372a8facfe462868ebf1'rafie/quicknote/notes/index') }}">Manage your notes</a>
        </div>
        {{ Form::close() }}
    </div>
</div>

4. Contrôleur (controllers/Notes.php):

class Notes extends Controller
{
    public function store()
    {
        $note = new Models\Note;
        $note->title = Input::get('title');
        $note->description = Input::get('description', null);
        $note->user_id = BackendAuth::getUser()->id;

        if ($note->save()) {
            Flash::success('Note added successfully.');
        } else {
            Flash::error('Validation error');
        }

        return Redirect::to(Backend::url());
    }

    // ... (rest of the controller code as described in the original response) ...
}

N'oubliez pas de terminer les actions du contrôleur restantes (index, créer, mettre à jour, supprimer) et leurs fichiers de configuration associés (config_list.yaml, config_form.yaml, columns.yaml, fields.yaml, partiels) comme détaillé dans la réponse originale. L'image montrant la structure du contrôleur est utile:

5. Liste backend et configuration du formulaire:

Configurez la liste et le formulaire backend en utilisant config_list.yaml et config_form.yaml comme indiqué dans la réponse d'origine. Portez une attention particulière à la méthode listExtendQueryBefore du contrôleur pour vous assurer que seules les notes de l'utilisateur actuelles sont affichées. La capture d'écran de la configuration du formulaire est utile:

Cette ventilation détaillée devrait vous aider à construire le widget rapide. N'oubliez pas de consulter la documentation d'octobre pour plus d'assistance et d'adapter le code à vos besoins spécifiques. La FAQ à la fin de la réponse originale fournit des informations utiles supplémentaires pour travailler avec octobrecms.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!