33 users Sign-in to change your status

Adds ability to generate Google sitemap Applications

• Homepage
• Repository
• Download package
• Browse source

Adds ability to generate Google sitemap. Supports both Propel and Doctrine (requires DbFinder plugin for Doctrine project).

Developers

Name	Status	Email
Sid BACHTIAR	lead	moc.liamg <<ta>> raithcab.dis

License

Copyright (c) 2009 - 2012 Sidharta Bachtiar

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Releases for sf 1.4

Version	License	API	Released
1.0.2stable	MIT license	1.0.2stable	07/06/2010
1.0.1stable	MIT license	1.0.1stable	07/06/2010
1.0.0stable	MIT license	1.0.0stable	10/04/2009
0.0.9alpha	MIT license	0.0.9alpha	14/03/2009
0.0.8alpha	MIT license	0.0.8alpha	14/03/2009
0.0.7alpha	MIT license	0.0.7alpha	12/03/2009
0.0.6alpha	MIT license	0.0.6alpha	12/03/2009
0.0.5alpha	MIT license	0.0.5alpha	12/03/2009
0.0.4alpha	MIT license	0.0.4alpha	12/03/2009
0.0.3alpha	MIT license	0.0.3alpha	12/03/2009
0.0.2alpha	MIT license	0.0.2alpha	12/03/2009

Releases for sf 1.3

Version	License	API	Released
1.0.2stable	MIT license	1.0.2stable	07/06/2010
1.0.1stable	MIT license	1.0.1stable	07/06/2010
1.0.0stable	MIT license	1.0.0stable	10/04/2009
0.0.9alpha	MIT license	0.0.9alpha	14/03/2009
0.0.8alpha	MIT license	0.0.8alpha	14/03/2009
0.0.7alpha	MIT license	0.0.7alpha	12/03/2009
0.0.6alpha	MIT license	0.0.6alpha	12/03/2009
0.0.5alpha	MIT license	0.0.5alpha	12/03/2009
0.0.4alpha	MIT license	0.0.4alpha	12/03/2009
0.0.3alpha	MIT license	0.0.3alpha	12/03/2009
0.0.2alpha	MIT license	0.0.2alpha	12/03/2009

Releases for sf 1.2

Version	License	API	Released
1.0.2stable	MIT license	1.0.2stable	07/06/2010
1.0.1stable	MIT license	1.0.1stable	07/06/2010
1.0.0stable	MIT license	1.0.0stable	10/04/2009
0.0.9alpha	MIT license	0.0.9alpha	14/03/2009
0.0.8alpha	MIT license	0.0.8alpha	14/03/2009
0.0.7alpha	MIT license	0.0.7alpha	12/03/2009
0.0.6alpha	MIT license	0.0.6alpha	12/03/2009
0.0.5alpha	MIT license	0.0.5alpha	12/03/2009
0.0.4alpha	MIT license	0.0.4alpha	12/03/2009
0.0.3alpha	MIT license	0.0.3alpha	12/03/2009
0.0.2alpha	MIT license	0.0.2alpha	12/03/2009
0.0.1alpha	MIT license	0.0.1alpha	11/03/2009

Releases for sf 1.1

Version	License	API	Released
1.0.2stable	MIT license	1.0.2stable	07/06/2010
1.0.1stable	MIT license	1.0.1stable	07/06/2010
1.0.0stable	MIT license	1.0.0stable	10/04/2009
0.0.9alpha	MIT license	0.0.9alpha	14/03/2009
0.0.8alpha	MIT license	0.0.8alpha	14/03/2009

Releases for sf 1.0

Version	License	API	Released
1.0.2stable	MIT license	1.0.2stable	07/06/2010
1.0.1stable	MIT license	1.0.1stable	07/06/2010
1.0.0stable	MIT license	1.0.0stable	10/04/2009
0.0.9alpha	MIT license	0.0.9alpha	14/03/2009
0.0.8alpha	MIT license	0.0.8alpha	14/03/2009

Join this plugin team

Other releases

Release 1.0.2 - 07/06/2010

Release 1.0.1 - 07/06/2010

Release 1.0.0 - 10/04/2009

Release 0.0.9 - 14/03/2009

Release 0.0.8 - 14/03/2009

Release 0.0.7 - 12/03/2009

Release 0.0.6 - 12/03/2009

Release 0.0.5 - 12/03/2009

Release 0.0.4 - 12/03/2009

Release 0.0.3 - 12/03/2009

Release 0.0.2 - 12/03/2009

Release 0.0.1 - 11/03/2009

sfSimpleGoogleSitemap plugin

The sfSimpleGoogleSitemapPlugin adds ability for a Symfony website to generate Google XML Sitemap.

Originally was built to go together with sfSimpleBlogPlugin, but it is configurable through app.yml, and so should be usable for other plugins.

This plugin supports Propel and DbFinder. By default it tries to detect if DbFinderPlugin exists and use it, but you can force it to use Propel or DbFinder from app.yml.

Visit sfSimpleGoogleSitemapPlugin blog to leave comment, suggestion, etc.

Contents

It contains one module that you can activate in whatever application you need them:

• sfSimpleGoogleSitemap

Installation

To install the plugin for a symfony project, the usual process is to use the symfony command line:

For Symfony 1.2:

$ php symfony plugin:install -s "alpha" sfSimpleGoogleSitemapPlugin

Alternatively, if you don't have PEAR installed, you can download the latest package attached to this plugin's wiki page and extract it under your project's plugins/ directory.

For symfony 1.2, enable the plugin in the project's configuration.

// in config/app/ProjectConfiguration.class.php
class ProjectConfiguration extends sfProjectConfiguration
{
  public function setup()
  {
    $this->enablePlugins(array('sfPropelPlugin', 'sfSimpleGoogleSitemapPlugin'));
  }
}

Enable the module in your applications, via the settings.yml file.

// in myproject/apps/frontend/config/settings.yml
all:
  .settings:
    enabled_modules:        [default, sfSimpleGoogleSitemap]

Add the following to your routing.yml.

gsitemap:
  url: /gsitemap
  param: { module: sfSimpleGoogleSitemap, action: index }

or, if you want, you could route it to /sitemap.xml:

in apps/yourapp/config/routing.yml

sitemap_xml:
  url: /sitemap.xml
  param: { module: sfSimpleGoogleSitemap, action: index }

and modify your web/.htaccess:

# we skip all files with .something
# comment the following 3 lines to allow periods in routes
RewriteCond %{REQUEST_URI} \..+$
RewriteCond %{REQUEST_URI} !\.html$
# add this for sitemap.xml:
RewriteCond %{REQUEST_URI} !sitemap\.xml$
RewriteRule .* - [L]

Clear cache.

symfony cc

Start using the plugin by browsing to the frontend module's default page:

http://myproject/frontend_dev.php/gsitemap

or, if you enabled sitemap.xml in routing:

http://myproject/frontend_dev.php/sitemap.xml

Visit sfSimpleGoogleSitemapPlugin blog to leave comment, suggestion, etc.

Configuration

The app.yml file

The plugin is highly configurable and should be easy to integrate to an existing project. Here is the default plugin configuration, taken from myproject/plugins/sfSimpleGoogleSitemapPlugin/config/app.yml.sample:

Note: the provided sample is for serving sitemap for sfSimpleBlogPlugin.

all:
  sfSimpleGoogleSitemap:
    orm:                  auto                   # possible values: auto, Propel, DbFinder. 'auto' is auto detection. Note: case sensitive!
    urls:                                        # define multiple static urls here
      homepage:                                  # just a name
        url:              http://yoursite.com    # full URL, e.g.: with http:// prefix
        freq:             daily                  # must be either: always, hourly, daily, weekly, monthly, yearly, never
        priority:         1.0                    # 1.0 is top priority (100%) compared to 0.2 which is less priority (20%)
    models:                                      # define multiple models to generate sitemap from
      model_posts:                               # just a name
        model:            sfSimpleBlogPost       # model class name
        module:           sfSimpleBlog           # name of module for the url to make up the url
        action:           show                   # name of action for the url to make up the url
        params:                                  # parameters for the url
          stripped_title: getStrippedTitle       # name : method to get the parameter value
        date:             getCreatedAt           # method to get date last updated for the url
        criteria:                                # criterias to filter the records to include in the sitemap
          - { column: is_published, method: IsPublished, operator: = , value: 1 }
        order_by: { column: id, method: Id, sort: desc }
        limit:            10                     # limit to the first x number of records
        freq:             daily                  # must be either: always, hourly, daily, weekly, monthly, yearly, never
        priority:         0.5                    # 1.0 is top priority (100%) compared to 0.5 which is less priority (50%)
      model_tags:                                # just a name
        model:            sfSimpleBlogTag        # model class name
        module:           sfSimpleBlog           # name of module for the url to make up the url
        action:           showByTag              # name of action for the url to make up the url
        params:                                  # parameters for the url
          tag:            getTag                 # name : method to get the parameter value
        group_by: { column: tag, method: Tag }   # group by the specified column/method
        freq:             weekly                 # must be either: always, hourly, daily, weekly, monthly, yearly, never
        priority:         0.2                    # 1.0 is top priority (100%) compared to 0.2 which is less priority (20%)

You can customize these settings in myproject/apps/myapp/config/app.yml

CHANGELOG

• Detects DbFinder and use it if it exists or else use Propel, but this is configurable from app.yml
• Bug fix, added module.yml to prevent sfGoogleAnalyticsPlugin adding script tag to the sitemap
• Added support for order_by, group_by, and limit

TODO

• Support for Symfony 1.0 and 1.1
• Make it write to a physical sitemap.xml file instead of generating it on the fly (but may be using Symfony cache is sufficient?)
• Add option to serve compressed sitemap, for large website?
• Support more complex criteria (perhaps even make another plugin that parses yml criteria?)
• Support more advanced way to add urls, e.g.: through a class