Konfigurácia

Publikovaný config/contacts.php:

return [
    'model' => RoundlyConsulting\Contacts\Models\Contact::class,
    'table' => 'contacts',
    'key_type' => env('CONTACTS_KEY_TYPE', 'bigint'),

    'auto_primary' => true,
    'require_owner_for_primary' => false,
    'default_country_code' => env('CONTACTS_DEFAULT_COUNTRY_CODE'),

    'verification' => [
        'ttl' => env('CONTACTS_VERIFICATION_TTL', 60),
        'style' => env('CONTACTS_VERIFICATION_STYLE', 'code'),
        'code_length' => env('CONTACTS_VERIFICATION_CODE_LENGTH', 6),
        'token_length' => env('CONTACTS_VERIFICATION_TOKEN_LENGTH', 32),
        'max_attempts' => env('CONTACTS_VERIFICATION_MAX_ATTEMPTS', 5),
    ],

    'types' => [
        // 'whatsapp' => ['label' => 'WhatsApp', 'icon' => 'chat', 'rules' => ['required', 'string']],
    ],

    'relationship_kinds' => [
        // 'works_at' => 'Works at', 'spouse_of' => 'Spouse of',
    ],
];

Všetky kľúče

Oba prepínače akceptujú reťazce v štýle env ('true'/'false', '1'/'0', 'on'/'off', 'yes'/'no') a číselné kľúče akceptujú celé čísla v reťazci ('30'). Nenastavený kľúč (chýbajúci, null alebo prázdny: '' či len medzery, čo dá samotný riadok CONTACTS_VERIFICATION_TTL=) má predvolenú hodnotu. Čokoľvek iné — preklep v prepínači či štýle, TTL, dĺžka alebo počet pokusov, ktoré nie sú celým číslom ('five', '5.5') alebo sú mimo rozsahu, nereťazcová tabuľka, predvoľba, ktorá ňou nie je, chybná položka types alebo relationship_kinds — vyhodí InvalidConfigurationException z balíka package-toolkit s názvom kľúča, namiesto toho, aby sa použila predvolená hodnota alebo sa hodnota potichu orezala.

Prostredie (env)

Kľúče citlivé na nasadenie sa čítajú z env, takže súbor publikujete len zriedka:

CONTACTS_KEY_TYPE=bigint
CONTACTS_DEFAULT_COUNTRY_CODE=421
CONTACTS_VERIFICATION_TTL=60
CONTACTS_VERIFICATION_STYLE=code
CONTACTS_VERIFICATION_CODE_LENGTH=6
CONTACTS_VERIFICATION_TOKEN_LENGTH=32
CONTACTS_VERIFICATION_MAX_ATTEMPTS=5

Vlastný model kontaktu

Model Contact zámerne nie je final. Rozšírte ho a nasmerujte naň contacts.model — trait, akcie, vCard exportér, smerovanie notifikácií aj testové matchery si ho odtiaľ načítajú:

namespace App\Models;

use RoundlyConsulting\Contacts\Models\Contact as BaseContact;

class Contact extends BaseContact
{
    // your own relations, accessors and scopes
}

// config/contacts.php
'model' => App\Models\Contact::class,

Nastavená trieda musí byť Contact z balíka alebo jeho podtrieda; čokoľvek iné — cudzí model, neexistujúca trieda — vyhodí InvalidConfigurationException s názvom contacts.model a nikdy sa potichu nenahradí. Tabuľku meňte cez contacts.table, nie cez vlastnosť $table — metóda getTable() modelu rešpektuje hodnotu z konfigurácie.

Kontrola konfigurácie

Balík hlási svoju konfiguráciu do príkazu about v Laraveli:

php artisan about --only=contacts

Registrované druhy a druhy vzťahov sú slovníkom vašej domény, preto sa hlásia len ako počty — nikdy menom. Predvoľba sa hlási len prítomnosťou, nikdy hodnotou. Chybná hodnota tabuľky, predvoľby, nastavenia overovania, types alebo relationship_kinds sa zobrazí ako INVALID a príkaz nezlyhá.