A CakePHP plugin for managing SEO

3.1.2 2018-04-20 08:40 UTC

README

Build Status Coverage Status

What is it?

I always need to add meta tags to my pages for SEO purposes and it was getting tedious writing tools to complete this every time. So I created a component which hooks the event system to catch the beforeLayout event to inject SEO data into the view variables.

I found that by containing all the functionality for SEO inside a component it makes it easier to manage.

Requirements

  • CakePHP 3.4+
  • PHP 7.1+

Installation

https://packagist.org/packages/davidyell/seo

composer require davidyell/seo

Setup

Firstly you will need to load the plugin in your /config/bootstrap.php.

Plugin::load('Seo');

Then you will need to attach it to the controller you want it to run on. I tend to attach it to my AppController.

// src/Controller/AppController.php initialize() method
$this->loadComponent('Seo.Seo' => [
	'defaults' => [
		'title' => 'Dave is epic',
		'description' => 'This is an epic plugin for epic people',
		'keywords' => 'epic,plugin'
	]
];

There are a number of configuration settings you will need to change to match your setup. You can find these in the $settings class variable in the component. Primarily you will want to change the $settings['defaults'] to set the default title, description and keywords for your website.

How it works

The idea is that your model will have some fields editable in the CMS for SEO. Once this data is set to the view, the component will catch the data and inject it into your layout for you automatically.

As such your layout will need some things to exist in order for the component to correctly add the data.

// For the page title
echo $this->fetch('title');

// For outputting the meta tags inside <head>
echo $this->fetch('meta');

Database configuration

This is for you to do. How you store your SEO data is outside the scope of this plugin. However I would recommend creating fields either in your Contents table or associated to it, with seo_title VARCHAR(255), seo_description TEXT, and seo_keywords VARCHAR(255).

Tips and Tricks

Got two viewVars set in your controller and you want to change it up depending on which is set?

// ProvidersController::beforeRender()

if (isset($this->viewVars['content'])) {
    $this->components()->get('Seo')->setConfig('viewVar', 'article');
} elseif (isset($this->viewVars['provider'])) {
    $this->components()->get('Seo')->setConfig('viewVar', 'provider');
}

The viewVar access accepts a hash path, so you can use dot notation to access deeply nested data.

$this->Components->load('Seo.Seo', [
    'viewVar' => 'catalog',
    'fields' => [
        'title' => 'assigned_content.content.seo_title'
    ]
]);

Don't forget that you can set the config directly on an instance of the component.

// ExamplesController.php

$this->components()->get('Seo')->setConfig('fields.title', 'My new title');