Welcompose
[ class tree: Welcompose ] [ index: Welcompose ] [ all elements ]

Class: Application_Sitemap

Source Location: /application_classes/sitemap.class.php

Class Overview




Variables

Methods



Class Details

[line 38]


[ Top ]


Class Variables

static $instance =  null

[line 45]

Singleton



Tags:

access:  public

Type:   object


[ Top ]

$base =  null

[line 52]

Reference to base class



Tags:

access:  public

Type:   object


[ Top ]

$_default_gzip_output_file =  '../../tmp/sitemaps/sitemap.xml.gz'

[line 73]

Default gzip flatten sitemap file



Tags:

access:  protected

Type:   string


[ Top ]

$_default_output_file =  '../../tmp/sitemaps/sitemap.xml'

[line 66]

Default xml sitemap file



Tags:

access:  protected

Type:   string


[ Top ]

$_pages = array()

[line 59]

Container to cache the info about all pages.



Tags:

access:  protected

Type:   array


[ Top ]



Class Methods


constructor __construct [line 80]

Application_Sitemap __construct( )

Start instance of base class, load configuration and establish database connection. Please don't call the constructor direcly, use the singleton pattern instead.



Tags:

access:  public


[ Top ]

method generateSitemap [line 107]

void generateSitemap( int $compress)

Generates the sitemap. Write file to file system.

If param compress is set we also write a gunzip compressed sitemap file. At least we apply some system rights to the generated files.




Tags:

throws:  Application_SitemapException
access:  public


Parameters:

int   $compress   Compress true or false

[ Top ]

method writeGzip [line 210]

void writeGzip( string $data)

Writes the gunzip encoded sitemap to the file system



Tags:

throws:  Application_TextConverterException
access:  protected


Parameters:

string   $data   Build sitemap data

[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:52:02 +0100 by phpDocumentor 1.4.3