2017 © Pedro Peláez
 

cakephp-plugin cake-sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

image

ciricihq/cake-sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

  • Wednesday, July 5, 2017
  • by elboletaire
  • Repository
  • 0 Watchers
  • 0 Stars
  • 7 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 10 Forks
  • 0 Open issues
  • 12 Versions
  • 0 % Grown

The README.md

CakePHP-Sitemap

Latest Version Build Status Coverage Status Software License Total Downloads, (*1)

The Sitemap provides a mechanism for displaying Sitemap style information (the url, change frequency, priority and last modified datetime) for a set of Tables that CakePHP has access to., (*2)

Requirements

  • CakePHP 3.0.0+
  • PHP 5.6+

Installation

$ composer require loadsys/cakephp_sitemap

In your config/bootstrap.php file, add:, (*3)

Plugin::load('Sitemap', ['bootstrap' => false, 'routes' => true]);

OR, (*4)

$ bin/cake plugin load Sitemap

Usage

  • Add list of tables to display Sitemap records via an array at Sitemap.tables 
Configure::write('Sitemap.tables', [
    'Pages',
    'Sites',
    'Camps',
]);
  • Add the Sitemap.Sitemap Behavior to each table as well
$this->addBehavior('Sitemap.Sitemap');

Configuration

  • Default configuration options for the Sitemap Behavior is:
'cacheConfigKey' => 'default',
'lastmod' => 'modified',
'changefreq' => 'daily',
'priority' => '0.9',
'conditions' => [],
'order' => [],
'fields' => [],
'implementedMethods' => [
    'getUrl' => 'returnUrlForEntity',
],
'implementedFinders' => [
    'forSitemap' => 'findSitemapRecords',
],
  • To modify these options for instance to change the changefreq when listing records, update the addBehavior method call for the Table in question like so:
$this->addBehavior('Sitemap.Sitemap', ['changefreq' => 'weekly']);
  • To customize the url generated for each record create a method named getUrl in the matching Table class.
public function getUrl(\Cake\ORM\Entity $entity) {
    return \Cake\Routing\Router::url(
        [
            'prefix' => false,
            'plugin' => false,
            'controller' => $this->registryAlias(),
            'action' => 'display',
            $entity->display_id,
        ],
        true
    );
}
  • To customize the templates used when displaying the Sitemap, the CakePHP Book provides information regarding overriding Plugin Templates.

Contributing

Code of Conduct

This project has adopted the Contributor Covenant as its code of conduct. All contributors are expected to adhere to this code. Translations are available., (*5)

Reporting Issues

Please use GitHub Isuses for listing any known defects or issues., (*6)

Development

When developing this plugin, please fork and issue a PR for any new development., (*7)

Set up a working copy:, (*8)

$ git clone git@github.com:YOUR_USERNAME/CakePHP-Sitemap.git
$ cd CakePHP-Sitemap/
$ composer install
$ vendor/bin/phpcs --config-set installed_paths vendor/loadsys/loadsys_codesniffer,vendor/cakephp/cakephp-codesniffer

Make your changes:, (*9)

$ git checkout -b your-topic-branch
# (Make your changes. Write some tests.)
$ vendor/bin/phpunit
$ vendor/bin/phpcs -p --extensions=php --standard=Loadsys ./src ./tests

Then commit and push your changes to your fork, and open a pull request., (*10)

License

MIT, (*11)

Loadsys Web Strategies 2016, (*12)

The Versions

05/07 2017

dev-b/sitemap-route

dev-b/sitemap-route https://github.com/loadsys/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

  Sources   Download

MIT

The Requires

 

The Development Requires

by Justin Yost

cakephp sitemap

10/11 2016

dev-b/xml-serialization

dev-b/xml-serialization https://github.com/loadsys/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

  Sources   Download

MIT

The Requires

 

The Development Requires

by Justin Yost

cakephp sitemap

10/11 2016

dev-master

9999999-dev https://github.com/ciricihq/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

  Sources   Download

MIT

The Requires

 

The Development Requires

by Òscar Casajuana
by Justin Yost

cakephp sitemap

10/11 2016

dev-dev

dev-dev https://github.com/ciricihq/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

  Sources   Download

MIT

The Requires

 

The Development Requires

by Òscar Casajuana
by Justin Yost

cakephp sitemap

29/05 2016

dev-u/master

dev-u/master https://github.com/loadsys/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

  Sources   Download

MIT

The Requires

 

The Development Requires

by Justin Yost

cakephp sitemap

27/05 2016

dev-u/dev

dev-u/dev https://github.com/loadsys/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

  Sources   Download

MIT

The Requires

 

The Development Requires

by Justin Yost

cakephp sitemap

27/05 2016

3.0.1

3.0.1.0 https://github.com/loadsys/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

  Sources   Download

MIT

The Requires

 

The Development Requires

by Justin Yost

cakephp sitemap

26/05 2016

3.0.0

3.0.0.0 https://github.com/loadsys/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

  Sources   Download

MIT

The Requires

 

The Development Requires

by Justin Yost

cakephp sitemap

01/02 2016

dev-cake-2.x

dev-cake-2.x https://github.com/loadsys/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an app

  Sources   Download

MIT

The Requires

 

by Justin Yost

cakephp model behavior sitemap

10/11 2014

1.0.2

1.0.2.0 https://github.com/loadsys/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an CakePHP application

  Sources   Download

MIT

The Requires

 

by Justin Yost

cakephp model behavior

10/11 2014

1.0.1

1.0.1.0 https://github.com/loadsys/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an CakePHP application

  Sources   Download

MIT

The Requires

 

by Justin Yost

cakephp model behavior

18/02 2014

1.0

1.0.0.0 https://github.com/loadsys/CakePHP-Sitemap

A CakePHP Plugin for adding automatic XML and HTML Sitemaps to an CakePHP application

  Sources   Download

MIT

The Requires

 

by Justin Yost

cakephp model behavior