mikl/mikl-seo

Seo module for ZF2

MiklSeo

This is a simple ZF2 module that optimize your "On-page" SEO based on a Zend\Navigation\Navigation instance., _(*1)

Configuration

The module use by default the DefaultNavigationFactory of Zend\Navigation but you can use your own Navigation., _(*2)

To do this, add the navigation key in the configuration, and specify your classname., _(*3)

Also, MiklSeo use strategies to optimize your html for search engine., _(*4)

MiklSeo\config\module.config.php :, _(*5)

return array(
    'miklSeo' => array(
        'strategies' => array(
            'title' => array(
                'placement' => 'prepend'
            ),
            'meta' => array(),
        ),
    ),
    'service_manager' => array(
        'factories' => array(
            'MiklSeoNavigation' => 'Zend\Navigation\Service\DefaultNavigationFactory', // feel free to change the factory
        ),
    ),
);

Define strategies in module.config.php under strategies key :, _(*6)

• key : string, Strategy classname
• value : array, Parameters

By default, 2 strategies are available:, _(*7)

Title :

Title strategy add title tag of your current html page if active page is found. prepend or append to the root title by specify placement key parameter., _(*8)

return array(
    'miklSeo' => array(         
        'strategies' => array(  
            'title' => array(
                //'tag'             => 'myCustomTag',
                //'placement'       => 'appendOrPrepend',
                //'ignoreTag'       => 'ignoreSeoTag'
            ),
        ),
    ),
);

Default parameters:, _(*9)

• tag : title
• placement : null
• ignoreTag : ignoreTitleSeo

ignoreTag ignore strategy on the current node, _(*10)

Meta :

Meta strategy add meta tag of your current html page if active page is found., _(*11)

return array(
    'miklSeo' => array(         
        'strategies' => array(
            'meta' => array(
                //'tag'             => 'myCustomTag',
                //'ignoreTag'       => 'ignoreSeoTag'           
            ),

        ),
    ),
);

Default parameters:, _(*12)

• tag : meta
• ignoreTag : noMetaSeo

ignoreTag bypass strategy on the current node., _(*13)

Exemple :

From xml navigation file :, _(*14)

<?xml version="1.0" encoding="UTF-8"?>
<configdata>
    <navigation>
        <default>
            <home>
                <label>Home</label>
                <title>Home</title>
                <uri>/</uri>
                <controller>index</controller>
                <action>index</action>  
                <route>home</route>
                <noTitleSeo>true</noTitleSeo>
                <meta>
                    <description>i am the description</description>
                    <keywords>my, keywords, list</keywords>
                    <google-site-verification>xxxx---x---x---x--xxxxxx-xx</google-site-verification>
                </meta>
                <pages>
                    <create>                
                        <label>create a disk list</label>
                        <title>create a disk list/title>
                        <route>create-disk</route>
                        <meta>
                            <description>another description.</description>
                            <keywords>another,keywords, here</keywords>                
                        </meta>
                    </create>
                </pages>
            </home>
        </default>           
    </navigation>   
</configdata>

Form this module.config.php file:, _(*15)

return array(
    'miklSeo' => array(
        'strategies' => array(
            'title' => array(
                'placement' => 'prepend'
            ),
            'meta' => array(),
        ),
    ),
    'service_manager' => array(
        'factories' => array(
            'MiklSeoNavigation' => 'Zend\Navigation\Service\DefaultNavigationFactory', // feel free to change the factory
        ),
    ),
);

Result :, _(*16)

( Title have already defined before and value is : My Beauty Website ), _(*17)

In home page :, _(*18)

<title>My Beauty Website</title>
<meta>
    <description>i am the description</description>
    <keywords>my, keywords, list</keywords>
    <google-site-verification>xxxx---x---x---x--xxxxxx-xx</google-site-verification>
</meta>

In create page:, _(*19)

<title>create a disk list - My Beauty Website</title>
<meta>
    <description>another description.</description>
    <keywords>another,keywords, here</keywords>
</meta>

Add your custom strategies :

You can create your custom seo strategy and add it in module.config.php To add a custom strategy your class must implement MiklSeo\Strategy\StrategyInterface, _(*20)

interface StrategyInterface{

    public function run();

}

You can also herit MiklSeo\Strategy\AbstractStrategy to use default comportement:, _(*21)

public function setTag($tag);
public function getTag();   
public function setIgnoreTag($ignoreTag);
public function getIgnoreTag();

And add it in module.config.php file, under strategy_plugins key :, _(*22)

return array(
    'miklSeo' => array(
        'strategies' => array(
            'title' => array(
                'placement' => 'prepend'
            ),
            'meta' => array(),
        ),
         'strategy_plugins' => array(
            'My\Custom\Strategy\Implement\StrategyInterface' => array(
            )
        ),
    ),
    'service_manager' => array(
        'factories' => array(
            'MiklSeoNavigation' => 'Zend\Navigation\Service\DefaultNavigationFactory', // feel free to change the factory
        ),
    ),
);