2. Once the repository has been added to the composer.json file, they can install Filament CMS Website Plugin like any other composer package using the composer require command:
3. You will be prompted to provide their username and password. The username will be your email address and the password will be equal to their license key. For example, let's say we have the following licensee and license activation:
Contact email: philo@anystack.sh
License key: 8c21df8f-6273-4932-b4ba-8bcc723ef500
This will require your licensee to enter the following information when prompted for their credentials:
Loading composer repositories with package information
Authentication required (filament-cms-website-plugin.composer.sh):
Username: philo@anystack.sh
Password: 8c21df8f-6273-4932-b4ba-8bcc723ef500:anystack.sh
To clarify, the license key and fingerprint should be separated by a colon (:).
4. To publish the configuration files, migrations, and layout files for this plugin, as well as automatically create page data, enter the following command:
5. By default, the index page of the website has a slug of home. If you wish to customize this slug, you can update the models.cms_page parameter in the config/filament-cms.php file and modify your CmsPage model accordingly. Specifically, you will need to change the value of the HOME_SLUG constant property to your desired slug. Once you have made these changes, run the php artisan optimize:clear command to clear the cache.
To update the Filament CMS website plugin, you can use the command php artisan filament-cms:update. This command will check for any updates to the package and install them if necessary.
If the update includes any new migration files, they will be automatically published to your application's database/migrations directory. You will then be prompted to confirm whether you want to run the migrations or not. If you confirm, the migrations will be run automatically, applying any necessary changes to your database schema.
It's important to note that before running any updates, you should always backup your code and database to ensure that you can easily revert to a previous state if any issues arise. Additionally, you should review the release notes for the updated package to understand any potential breaking changes or new features that may impact your application.
The form schema for the page data is based on the work of Dennis Koch. To learn more about this concept, you can refer to his Filament Trick, which provides detailed information on the general idea.
Create Template
To create a template and its view file, run following command:
php artisan filament-cms:page-template MyTemplate
<?php
namespace App\CmsPages\Templates;
use Filament\Forms;
use SolutionForest\FilamentCms\CmsPages\Contracts\CmsPageTemplate;
use SolutionForest\FilamentCms\CmsPages\Renderer\AtomicDesignPageRenderer;
final class MyTemplate implements CmsPageTemplate
{
protected static ?string $view = null;
public static function title(): string
{
return 'MyTemplate';
}
public static function schema(): array
{
return [
Forms\Components\Card::make()
->schema([
Forms\Components\TextInput::make('content')
->label(__('filament-cms::filament-cms.fields.cms_page.block-template.content'))
]),
];
}
public static function getRenderer(): ?string
{
return static::$view ?? AtomicDesignPageRenderer::class;
}
public static function hiddenOnTemplateOptions(): bool
{
return false;
}
}
Create Template Renderer
You have the option to modify the renderer as a view or implement a custom SolutionForest\FilamentCms\CmsPages\Contracts\Renderer.
To create a Template renderer, you can run the following command:
php artisan filament-cms:page-template-renderer
Once you have created the template renderer, you can insert it into your Template class.
The SEO functionality in this package is based on ralphjsmit/laravel-seo. To set up SEO for your website, you can configure the settings in the config/seo.php file.
To change the theme, you can modify the theme parameter in the config/filament-cms.php file. After that, you will need to clone all of the layout files located in views/cms/theme/default and rename the default folder to your new theme name. Additionally, you will need to publish and clone the default template render files under your new theme name as well.
3. To modify the default template render files, you can publish vendor files and clone files located in resources/views/vendor/filament-cms/components/default. Then, rename the default folder to new theme name:
The data-type page is a resource that doesn't have an associated route.
For instance, if you create a 'link' data-type that includes information such as URLs and titles, you can retrieve this information from any page.
To create a new data-type, you can use the following command, which will automatically generate the necessary page data, template and Filament resource:
php artisan filament-cms:data-type-page Link
Filament Resource:
<?php
namespace App\Filament\Resources\DataType;
use App\Filament\Resources\DataType\LinkResource\Pages;
use App\CmsPages\Templates\DataType\Link as Template;
use Filament\Forms;
use Illuminate\Database\Eloquent\Builder;
use SolutionForest\FilamentCms\Enums\PageType;
use SolutionForest\FilamentCms\Filament\Resources\DataTypePageBaseResource as BaseResource;
class LinkResource extends BaseResource
{
protected static ?int $navigationSort = null;
protected static $parentPageKey = '5';
protected static string $subSlug = 'link';
public static function getModelLabel(): string
{
return 'Link';
}
public static function getPages(): array
{
return [
'index' => Pages\ListLinks::route('/'),
'edit' => Pages\EditLink::route('/{record:id}/edit'),
'create' => Pages\CreateLink::route('/create'),
];
}
public static function getTemplate(): string
{
return Template::class;
}
}
Template:
<?php
namespace App\CmsPages\Templates\DataType;
use Filament\Forms;
use SolutionForest\FilamentCms\CmsPages\Contracts\CmsPageTemplate;
use SolutionForest\FilamentCms\CmsPages\Templates\DataTypeTemplate as BaseTemplate;
class Link extends BaseTemplate implements CmsPageTemplate
{
public static function schema(): array
{
return [];
}
public static function title(): string
{
return 'Link';
}
}
To retrieve records under the data-type page, you can use the following code:
The content-type page is a resource that is associated with routing, similar to a general page that has child pages.
For instance, you can create a 'Product' content-type page with a slug ('products'), which can edit the detail view for the child pages under 'Product'. Additionally, you can retrieve all records under the 'Product' page from any page.
To create a new content-type page, you can use the following command, which will automatically generate the necessary page data, template, views, and Filament resource:
<?php
namespace App\Filament\Resources\ContentType;
use App\Filament\Resources\ContentType\ProductResource\Pages;
use App\CmsPages\Templates\ContentType\Product as Template;
use Filament\Forms;
use Illuminate\Database\Eloquent\Builder;
use SolutionForest\FilamentCms\Enums\PageType;
use SolutionForest\FilamentCms\Filament\Resources\ContentTypePageBaseResource as BaseResource;
class ProductResource extends BaseResource
{
protected static ?int $navigationSort = null;
protected static $parentPageKey = '13';
protected static string $subSlug = 'products';
public static function getModelLabel(): string
{
return 'Product';
}
public static function getPages(): array
{
return [
'index' => Pages\ListProducts::route('/'),
'edit' => Pages\EditProduct::route('/{record:id}/edit'),
'create' => Pages\CreateProduct::route('/create'),
];
}
public static function getTemplate(): string
{
return Template::class;
}
}
Template:
<?php
namespace App\CmsPages\Templates\ContentType;
use Filament\Forms;
use SolutionForest\FilamentCms\CmsPages\Contracts\CmsPageTemplate;
use SolutionForest\FilamentCms\CmsPages\Templates\ContentTypeTemplate as BaseTemplate;
class Product extends BaseTemplate implements CmsPageTemplate
{
public static function schema(): array
{
return [];
}
public static function title(): string
{
return 'Product';
}
}
View:
@props(['layout', 'page' => null])
@php
use SolutionForest\FilamentCms\Facades\FilamentCms;
/** @var array $layout */
/** @var ?\SolutionForest\FilamentCms\Dto\CmsPageData $page */
$theme = FilamentCms::getCurrentTheme();
@endphp
<x-dynamic-component
component="filament-cms::{{$theme}}.page"
:layout="$layout">
<!-- Let all your things have their places; let each part of your business have its time. - Benjamin Franklin -->
</x-dynamic-component>
To retrieve records under the content-type page, you can use the following code:
2. Next, you need to prepare your resource classes and model, and update the settings in the config/filament-cms.php file. Here's an example configuration:
3. Then, you need to add the necessary trait to your model:
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use SolutionForest\FilamentCms\Models\CmsPage as BaseModel;
use Spatie\Translatable\HasTranslations;
class CmsPage extends BaseModel
{
use HasTranslations;
public $translatable = [
'title',
'data',
];
}
4. You also need to add the necessary trait to your Filament resource, to prepare for resource pages:
namespace App\Filament\Resources;
use App\Filament\Resources\CmsPageResource\Pages;
class CmsPageResource extends \SolutionForest\FilamentCms\Filament\Resources\CmsPageResource
{
use \Filament\Resources\Concerns\Translatable;
public static function getPages(): array
{
return [
'index' => Pages\ListCmsPages::route('/'),
'create' => Pages\CreateCmsPage::route('/create'),
'edit' => Pages\EditCmsPage::route('/{record}/edit'),
];
}
}
5. Finally, you need to add the necessary trait to your Filament resource pages, to making resources page translatable after resource class added necessary trait. For all resource pages, you must apply the corresponding `Translatable` trait to it, and install a `LocaleSwitcher` header action. Also, you need to install the original actions of the cms resource pages, such as preview page action and view published page action inside `\SolutionForest\FilamentCms\Concern\CanPublishPage` trait:
use App\Filament\Resources\CmsPageResource;
class ListCmsPages extends \SolutionForest\FilamentCms\Filament\Resources\CmsPageResource\Pages\ListCmsPages
{
use \Filament\Resources\Pages\ListRecords\Concerns\Translatable;
protected static string $resource = CmsPageResource::class;
protected function getHeaderActions(): array
{
return [
\Filament\Actions\LocaleSwitcher::make(),
\Filament\Actions\CreateAction::make(),
];
}
}
namespace App\Filament\Resources\CmsPageResource\Pages;
use App\Filament\Resources\CmsPageResource;
class EditCmsPage extends \SolutionForest\FilamentCms\Filament\Resources\CmsPageResource\Pages\EditCmsPage
{
use \Filament\Resources\Pages\EditRecord\Concerns\Translatable;
protected static string $resource = CmsPageResource::class;
protected function getHeaderActions(): array
{
return [
\Filament\Actions\LocaleSwitcher::make(),
...parent::getActions(),
];
}
}
namespace App\Filament\Resources\CmsPageResource\Pages;
use App\Filament\Resources\CmsPageResource;
class CreateCmsPage extends \SolutionForest\FilamentCms\Filament\Resources\CmsPageResource\Pages\CreateCmsPage
{
use \Filament\Resources\Pages\CreateRecord\Concerns\Translatable;
protected static string $resource = CmsPageResource::class;
protected function getHeaderActions(): array
{
return [
\Filament\Actions\LocaleSwitcher::make(),
];
}
}
6. Setting the translatable locales for a particular resource
By default, the translatable locales can be set globally for all resources in the plugin configuration. Alternatively, you can customize the translatable locales for a particular resource by overriding the getTranslatableLocales() method in your resource class:
class CmsPageResource extends \SolutionForest\FilamentCms\Filament\Resources\CmsPageResource
{
use \Filament\Resources\Concerns\Translatable;
// ...
public static function getTranslatableLocales(): array
{
return ['en', 'fr'];
}
}
7. If you need to make `CmsTagResouce` and `CmsPageNavigationCategoryResource`, follow the same steps as mentioned above for `CmsPageResource`. Add the use `\Filament\Resources\Concerns\Translatable` trait to the respective resource classes and apply the necessary changes to the resource pages.
Special case for EditCmsPageNavigation page:
The `EditCmsPageNavigation` page is not a Filament preset resource page, but it already applies the `SolutionForest\FilamentTree\Concern\TreeRecords\Translatable` trait.
If you want to make any adjustments, you just need to add the `getTranslatableLocales` method to the `CmsPageNavigationCategoryResource` class or override the `getTranslatableLocales` method in the `EditCmsPageNavigation` page.
By default, the tagging of cms page is disable. If you wish to enable it, you can update the enable_page_tags as true in the config/filament-cms.php file.
By default, the audit log of cms page is disable. If you wish to enable it, you can update the enable_audit_log as true in the config/filament-cms.php file.
The following abilities are set to true by default. You can define them in the AuthServiceProvider or use the registerCmsAuthenticationUsing method of SolutionForest\FilamentCms\FilamentCmsPanel.
Abilities
publish - Determine whether the user can publish the page.
unpublish - Determine whether the user can unpublish the page.
schedulePublish - Determine whether the user can schedule publish the page.
audit - Determine whether the user can view the audit logs the page.
rollbackAudit - Determine whether the user can rollback the audit logs the page.
Here are some of the features and improvements we plan to implement in future releases of this project:
[OK] Scheduled Publish Page
[ ] Asset Manager
[OK] Tag Manager
[ ] Versioning
Please note that this roadmap is subject to change and may be updated as we receive feedback and new feature requests from our users. We appreciate any suggestions or ideas you may have for improving this project!
