Filament Settings Hub

https://github.com/tomatophp/filament-settings-hub
Admin
Filament Settings Hub is a Laravel Filament plugin that adds admin panel pages for managing app...
Tokens:1,074
Snippets:15
Trust Score:10
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run Filament Settings Hub Installation Command (Bash)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Executes the post-installation Artisan command for Filament Settings Hub. This command typically publishes assets, runs migrations, or performs other setup tasks after the Composer installation.

```bash
php artisan filament-settings-hub:install
```

--------------------------------

### Install Filament Settings Hub via Composer (Bash)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Installs the Filament Settings Hub package using Composer. This is the first step in adding the package to your Laravel/Filament project.

```bash
composer require tomatophp/filament-settings-hub
```

--------------------------------

### Publish Filament Settings Hub Views (Bash)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Publishes the view files for Filament Settings Hub using the Artisan vendor:publish command. This allows customization of the package's UI.

```bash
php artisan vendor:publish --tag="filament-settings-hub-views"
```

--------------------------------

### Publish Filament Settings Hub Migrations (Bash)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Publishes the database migration files for Filament Settings Hub using the Artisan vendor:publish command. This is necessary before running migrations to create the settings table.

```bash
php artisan vendor:publish --tag="filament-settings-hub-migrations"
```

--------------------------------

### Publish Filament Settings Hub Languages (Bash)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Publishes the language files for Filament Settings Hub using the Artisan vendor:publish command. This allows customization or translation of package strings.

```bash
php artisan vendor:publish --tag="filament-settings-hub-lang"
```

--------------------------------

### Publish Filament Settings Hub Config (Bash)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Publishes the configuration file for Filament Settings Hub using the Artisan vendor:publish command. This allows customization of package settings.

```bash
php artisan vendor:publish --tag="filament-settings-hub-config"
```

--------------------------------

### Use Filament Settings Hub Helper Function (PHP)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Demonstrates how to use the `setting()` helper function provided by the package. This function allows easy retrieval of setting values, with an optional default value if the key is not found.

```php
setting($key, 'default value');
```

--------------------------------

### Run PEST Tests (Bash)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Executes the PEST test suite for the package using the Composer test script.

```bash
composer test
```

--------------------------------

### Configure Upload File System (PHP)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Shows the configuration array structure in `filament-settings-hub.php` for changing the file system and path used for uploading files like logos or profile images.

```php
'upload' => [
    'disk' => 's3',
    'path' => 'settings',
],
```

--------------------------------

### Register New Setting to Hub (PHP)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Shows how to register a new custom setting page or group to the Settings Hub using the `FilamentSettingsHub` Facade. It uses the `SettingHold` service contract to define the setting's properties like order, label, icon, route, page, description, and group.

```php
use TomatoPHP\FilamentSettingsHub\Facades\FilamentSettingsHub;
use TomatoPHP\FilamentSettingsHub\Services\Contracts\SettingHold;

FilamentSettingsHub::register([
    SettingHold::make()
        ->order(2)
        ->label('Site Settings') // to translate label just use direct translation path like `messages.text.name`
        ->icon('heroicon-o-globe-alt')
        ->route('filament.admin.pages.site-settings') // use page / route
        ->page(\TomatoPHP\FilamentSettingsHub\Pages\SiteSettings::class) // use page / route 
        ->description('Name, Logo, Site Profile') // to translate label just use direct translation path like `messages.text.name`
        ->group('General') // to translate label just use direct translation path like `messages.text.name`,
]);
```

--------------------------------

### Enable Filament Shield Integration (PHP)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Configures the Filament Settings Hub plugin to integrate with Filament Shield. This allows applying Shield permissions to the settings pages managed by the hub.

```php
->plugin(
    \TomatoPHP\FilamentSettingsHub\FilamentSettingsHubPlugin::make()
        ->allowShield()
)
```

--------------------------------

### Run PHPStan Analysis (Bash)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Executes the PHPStan static analysis tool using the Composer analyse script to check for potential code errors and style violations.

```bash
composer analyse
```

--------------------------------

### Fix PHP Code Style (Bash)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Runs the code formatter script defined in composer.json to automatically fix PHP code style issues.

```bash
composer format
```

--------------------------------

### Register Filament Settings Hub Plugin (PHP)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Registers the Filament Settings Hub plugin within the Filament Admin Panel Provider. This enables the plugin's features and allows configuration options like enabling site or social menu settings.

```php
->plugin(
    \TomatoPHP\FilamentSettingsHub\FilamentSettingsHubPlugin::make()
        ->allowSiteSettings()
        ->allowSocialMenuSettings()
)
```

--------------------------------

### Use Shield Trait for Secure Settings Page (PHP)

Source: https://github.com/tomatophp/filament-settings-hub/blob/master/README.md

Specifies the PHP trait `UseShield` provided by the package. This trait can be added to a custom settings page class to enforce Filament Shield permissions on that specific page.

```php
use TomatoPHP\FilamentSettingsHub\Traits\UseShield;
```
Tokens:
Raw