README

Laravel pages is a package for laravel that allows you to represent your views with a PHP class

This package offers 2 type of class :

Static (like home page)
Dynamic (eloquent model)

Works with joedixon/laravel-translation & spatie/laravel-translatable

Installation

composer require sideapps/laravel-pages

"require": {
    "sideapps/laravel-pages": "^1.0.4"
},

Usage

Static page

php artisan page:static TestStaticPage

namespace App\Pages;

use Sideapps\LaravelPages\Breadcrumb\Breadcrumb;
use Sideapps\LaravelPages\Pages\StaticPage;
use Sideapps\LaravelPages\Pages\Page;

class TestStaticPage extends StaticPage implements Page {

    protected static string $translation_key = 'test_page';

    protected static string $route = 'test';

    protected static string $view = 'static.test';

    public function getBreadcrumb():?Breadcrumb {
        return new Breadcrumb([
            $this->getBreadcrumbItem(false) // set false for not clickable anchor
        ]);
    }

}

class StaticPageController extends Controller {

    private CreatePageFactory $createPageFactory;

    public function __construct(CreatePageFactory $createPageFactory) {
        $this->createPageFactory = $createPageFactory;
    }

    public function test() {
        $page = $this->createPageFactory->getPage(TestStaticPage::class);
        return $page->render();
    }

    ...

}

You must be create translation file for your page and set up these attributes (editable in the config or for each class page):

meta_title
meta_description
fil_ariane
titre_h1

Dynamic page

php artisan page:dynamic PostPage

namespace App\Pages;

use Sideapps\LaravelPages\Breadcrumb\Breadcrumb;
use Sideapps\LaravelPages\Pages\DynamicPage;
use Sideapps\LaravelPages\Pages\Page;

class PostPage extends DynamicPage implements Page {

    protected static string $translation_key = 'post_page';

    protected static string $route = 'posts.show';

    protected static string $view = 'posts.show';

    public function routeParams():array {
        return [
            'slug' // Same as 'slug' => 'slug' (get $this->model->slug value)
            'slugBis' => 'slug' // (get $this->model->slug value) for slubBis route parameter
            'slugBisBis' => function() {return $this->model->slug;} // Specify value with closure
        ];
    }

    public function getBreadcrumb():?Breadcrumb {
        return new Breadcrumb([
            $this->createPageFactory->getPage(HomePage::class)->getBreadcrumbItem(),
            $this->getBreadcrumbItem(false) // set false for not clickable anchor
        ]);
    }

}

class Post extends Model implements Pageable {

    use HasTranslations;

    public array $translatable = [
        'meta_title', 'meta_description', 'title', 'html_content', 'slug'
    ];
 
    public function getPage():Page {
        return CreatePageFactory::make()->getPage(PostPage::class, $this);
    }

}

class PostController extends Controller {
    
    ...

    public function show(string $locale, string $slug) {
        $post = $this->postRepository->findBySlug($slug);
        $page = $post->getPage();
        return $page->render(compact($post));
    }

}

Your eloquent model must implements Pageable Interface & had these attributes :

meta_title
meta_description
breadcrumb
title

Global

You now have a $page variable in all your blade views. You can also use it in layout, for example :

<!doctype html>
<html lang="{{ $page->getLangAttribute() }}">

<head>
    <title>{{ $page->getMetaTitle() }} - Site Name</title>
    <meta name="description" content="{{ $page->getMetaDescription() }}">
    {!! $page->generateMetaIndex() !!}
    {!! $page->generateAlternateLinks() !!}
</head>

<body>
    {!! $page->generateSwitchLanguageLinks() !!}
    {!! $page->generateBreadcrumb() !!}
    @yield('content')
</body>

</html>

Options

no index, no follow

protected static bool $metaIndex = false;

Add this line to your page class

Methods available in views

Get translation :

{{ $page->trans('paragraph1') }}

Get lang attribute :

{{ $page->getLangAttribute() }}

get meta-title :

{{ $page->getMetaTitle() }}

get meta-description :

{{ $page->getMetaDescription() }}

Generate no index meta (generate meta noindex, nofollow if page is noindex) :

{{ $page->generateMetaIndex() }}

Generate alternate links :

{{ $page->generateAlternateLinks() }}

Generate switch languages links :

{{ $page->generateSwitchLanguageLinks() }}

Generate breadcrumb :

{{ $page->generateBreadcrumb() }}

Publish config & views files

php artisan vendor:publish --provider="Sideapps\LaravelPages\LaravelPagesServiceProvider"

sideapps / laravel-pages

Maintainers

Details