Configuration¶

After installation, all you need to get started is to let the plugin know which model you want to track. The plugin will automatically attach the the proper behavior, helper and components as follows:

All models provided in the configuration will have the behavior MetaDataBehavior
All controllers correlating to the models provided in the configuration wil have the EntityMetadataComponent
The PagesController will have the PagesMetadataComponent

Adding Models¶

Many assumptions are made by the plugin in favor of CakePHP’s conventions. However, just like CakePHP, those assumptions are configurable. In your app.php config file, add the following:

<?php
// app.php
...
\SeoBakery\SeoBakeryPlugin::NAME => [
    'behaviorModels' => ['Articles']
],
...

With the above config the following assumptions are made about your application:

You have a ArticlesController controller
Your controller has a view action
Your articleId is the first passed argument to the view action

Determining Route¶

There are situations where the assumed routing requires more information to work. You can pass the prefix, plugin and controller like so

<?php
// app.php
...
\SeoBakery\SeoBakeryPlugin::NAME => [
    'behaviorModels' => [
        'Articles' => [
            'prefix' => 'Customers',
            'plugin' => 'Blog',
            'controller' => 'Posts',
        ]
    ]
],
...

Setting Actions¶

If you wish to override the default actions the plugin will track, just add an array of actions in your controller for the behaviorModel like so:

<?php
// app.php
...
\SeoBakery\SeoBakeryPlugin::NAME => [
    'behaviorModels' => [
        'Articles' => [
            'actions' => ['display', 'comments']
        ]
    ]
],
...

Configuring Entity Identifier¶

By default, the plugin assumes that your entity’s primary key is the first passed argument in the action. To override this behavior, you have 2 options:

provide the index of the passed argument variable provided by the CakePHP Request
provide a callable that returns the primary key of the entity. Below is an example of both:

<?php
// app.php
...
\SeoBakery\SeoBakeryPlugin::NAME => [
    'behaviorModels' => [
        'Categories' => [
            'identifierFunc' => 1,
        ],
        'Articles' => [
            'actions' => ['display', 'comments'],
            'identifierFunc' => function(array $passedArgs, string $action, Table $table) {
                if($action === 'display') {
                     $slug = $passedArgs[2];
                     $article = $table->find('slugged', compact('slug'));
                     return $article->id;
                }

                if($action === 'comments') {
                    $id = $passedArgs[0];
                    return $id;
                }
            },
        ]
    ]
],
...

Configuring MetaData Fallbacks Generators¶

The plugin will auto generate fallback metadata (like titles, descriptions, keywords and robots declaration ) for each entity saved based on metadata generators. These metadata-generator functions are referred to as Builder functions. Whenever metadata like title or description is missing for an entity, it will use the fallback for each datum.

Long story short, each entity starts with a null meta title and a fallback meta title. The fallback is configurable and the actual meta title is waiting for you to eventually set it. The same goes for meta description and meta keywords. The main reason for this “double value” approach is to be able to quickly generate metadata for an entity programmatically, while at the same time allow for more SEO optimized values to be given at a later time.

Builders are simple callables that are provided to the behaviorModels config. The plugin comes with Builder functions as classes. Below are some examples on how to override the default Builder functions:

<?php
// app.php
...
$articleTitle = fn(Article $article, string $action) => $action === 'view' ? $article->title : ucfirst($action).' '.$article->title;
...
\SeoBakery\SeoBakeryPlugin::NAME => [
    'behaviorModels' => [
        'Articles' => [
            'buildTitleFunc' => $articleTitle,
            'buildDescriptionFunc' => function(ArticleEntity $article, string $action) {
                switch($action) {
                    case 'view':
                        return $article->snippet
                    case 'edit':
                    case 'create':
                        return  ucfirst($action).' '.$article->title
                    default:
                        return null
                }
            },
            'buildKeywordsFunc' => new \SeoBakery\Builder\Entity\SimpleMetaKeywordsBuilder(),
            'buildShouldIndexFunc' => [Article, 'shouldIndex'],
            'buildShouldFollowFunc' => [Article, 'shouldFollow'],
        ]
    ]
],
...

Configuring MetaData for PagesController¶

The PagesController can be configured to take advantage of the many features of the plugin. To have the plugin track a template used by the pages controller simply add it to the pages key of the configuration like so:

<?php
// app.php
...
\SeoBakery\SeoBakeryPlugin::NAME => [
    'pages' => ['about','contact','home']
],
...

Configuring the Builder functions for pages is similar to behaviorModels.

The signature of the callback is the template path for the page.
instead of a callable you can use a literal value i.e. string or array

Below are examples to illustrate this:

<?php
// app.php
...
\SeoBakery\SeoBakeryPlugin::NAME => [
    'pages' => [
        'home' => [
            'buildTitleFunc' => Configure::read('App.siteName'),
            'buildDescriptionFunc' => 'Welcome to ' . Configure::read('App.siteName'),
        ],
        'sub-dir/some-page' => [
            'buildTitleFunc' => fn(string $template) => ucfirst(str_replace('/', ' ', mb_strtolower($template))),
        ],
        'contact',
    ]
],
...