Hinweismeldungen

Das Hinzufügen von Hinweisen zu einer Einstellungsseite könnte mehr Details dazu liefern, wie mit den angezeigten Einstellungen umzugehen ist. Dazu könnte gehören, wie man einen API-Schlüssel erhält oder was erforderlich ist, damit die Einstellungen ordnungsgemäß funktionieren. Unabhängig vom Grund bietet NexoPOS eine Möglichkeit, vier Arten von Hinweisen anzuzeigen: Info, Fehler, Warnung und Erfolg.

Der Typ dieser Benachrichtigung definiert ihre Farben. Sie verwenden eine dieser Farben, um den Ausdruck der Schwere der Benachrichtigung abzugleichen.

Um fortzufahren, müssen Sie zuerst Ihre Einstellungen definieren, indem Sie eine Klasse erstellen, die „App\Services\SettingsPage“ erweitert. In dieser Klasse definieren wir unsere Einstellungen wie folgt:

<?php
namespace Modules\YourModule\Settings;

use App\Services\SettingsPage;
use App\Classes\SettingForm;

class MySettings extends SettingsPage 
{
    const IDENTIFIER = 'my-settings';
    const AUTOLOAD = true;
    
    public function __construct()
    {
        $this->form   =   SettingsForm::form(
            title: __m( 'My Settings', 'YourModule' ),
            description: __m( 'Configure your settings', 'YourModule' ),
            tabs: SettingsForm::tabs(
                SettingsForm::tab(
                    identifier: 'general',
                    label: __m( 'General Settings', 'YourModule' ),
                    fields: SettingsForm::fields(
                        // ... fields here
                    )
                )
            )
        )
    }
}

Nun fügen wir der Methode SettingsForm::tab die Hinweise hinzu, die wir anzeigen möchten.

<?php
namespace Modules\YourModule\Settings;

use App\Services\SettingsPage;
use App\Classes\SettingForm;
use App\Classes\Notice;

class MySettings extends SettingsPage 
{
    const IDENTIFIER = 'my-settings';
    const AUTOLOAD = true;
    
    public function __construct()
    {
        $this->form   =   SettingsForm::form(
            title: __m( 'My Settings', 'YourModule' ),
            description: __m( 'Configure your settings', 'YourModule' ),
            tabs: SettingsForm::tabs(
                SettingsForm::tab(
                    identifier: 'general',
                    notices: [
                        Notice::info(
                            title: __m( 'How It Works', 'YourModule' ),
                            description: __m( 'You must retreive the API from your account...', 'YourModule' ),
                        )
                    ],
                    label: __m( 'General Settings', 'YourModule' ),
                    fields: SettingsForm::fields(
                        // ... fields here
                    )
                )
            )
        )
    }
}

Zusätzlich haben wir die Klasse App\Classes\Notice hinzugefügt, die als Methode den vierten Benachrichtigungstyp bereitstellt. Beispielsweise verwenden wir „info“ für eine blaue Benachrichtigung, „error“ für eine rote Benachrichtigung usw.

Nun sollten wir auf unserer Einstellungsseite die folgende Ausgabe haben.

Das Formular hat keine Felder, da wir keine Felder festgelegt haben.