mikl/mikl-seo

There is no license information available for the latest version (dev-master) of this package.

Seo module for ZF2

dev-master 2012-10-22 08:33 UTC

Requires

• php: >=5.3
• zendframework/zendframework: >=2.0.0

Unknown License

• Mickaël COLLET

• zf2
• seo
• mikl

README

MiklSeo

This is a simple ZF2 module that optimize your "On-page" SEO based on a Zend\Navigation\Navigation instance.

Configuration

The module use by default the DefaultNavigationFactory of Zend\Navigation but you can use your own Navigation.

To do this, add the navigation key in the configuration, and specify your classname.

Also, MiklSeo use strategies to optimize your html for search engine.

MiklSeo\config\module.config.php :

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 :

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

By default, 2 strategies are available:

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.

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

Default parameters:

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

ignoreTag ignore strategy on the current node

Meta :

Meta strategy add meta tag of your current html page if active page is found.

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

Default parameters:

• tag : meta
• ignoreTag : noMetaSeo

ignoreTag bypass strategy on the current node.

Exemple :

From xml navigation file :

<?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:

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 :

( Title have already defined before and value is : My Beauty Website )

In home page :

<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:

<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

interface StrategyInterface{

	public function run();
	
}

You can also herit MiklSeo\Strategy\AbstractStrategy to use default comportement:

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 :

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
        ),
    ),
);