Class: GoogleSitemap

Source Location: sitemap.class.php

Class GoogleSitemap

Class Overview

Google Sitemap Base Class

The MySQL_Database class provides abstraction so the databaes can be accessed

Located in sitemap.class.php [line 218]

Author(s):

Bobby Easland

Information Tags:

Copyright:	Copyright 2005, Bobby Easland
Link:	About Google Sitemap
Link:	osCommerce-Freelancers
Version:	1.0
License:	GNU Public License

Properties

Methods

[ Top ]

Property Summary

string	$base_url	$base_url is the URL for the catalog
object	$DB	$DB is the database object
string	$filename	$filename is the base name of the feeds (i.e. - 'sitemap')
string	$savepath	$savepath is the path where the feeds will be saved - store root

[ Top ]

Method Summary

GoogleSitemap	GoogleSitemap()	GoogleSitemap class constructor
boolean	CompressFile()	Function to compress a normal file
boolean	GenerateCategorySitemap()	Funciton to generate category sitemap data
boolean	GenerateProductSitemap()	Function to generate product sitemap data
boolean	GenerateSitemap()	Function to generate sitemap file from data
boolean	GenerateSitemapIndex()	Function to generate sitemap index file
string	GenerateSubmitURL()	Utility function to generate the submit URL
string	ReadGZ()	Utility function to read and return the contents of a GZ formatted file
boolean	SaveFile()	Function to save the sitemap data to file as either XML or XML.GZ format

[ Top ]

Properties

string $base_url [line 238]

$base_url is the URL for the catalog

[ Top ]

object $DB [line 223]

$DB is the database object

[ Top ]

string $filename [line 228]

$filename is the base name of the feeds (i.e. - 'sitemap')

[ Top ]

string $savepath [line 233]

$savepath is the path where the feeds will be saved - store root

[ Top ]

Methods

Constructor GoogleSitemap [line 250]

GoogleSitemap GoogleSitemap(
string
$host, string
$user, string
$db, string
$pass 
)

GoogleSitemap class constructor

Parameters:

string	$host:	Database host setting (i.e. - localhost)
string	$user:	Database user
string	$db:	Database name
string	$pass:	Database password

Information Tags:

Version:	1.0
Author:	Bobby Easland

[ Top ]

CompressFile [line 300]

boolean CompressFile(
string
$file 
)

Function to compress a normal file

Parameters:

string

$file:

Information Tags:

Version:	1.0
Author:	Bobby Easland

[ Top ]

GenerateCategorySitemap [line 417]

boolean GenerateCategorySitemap(
)

Funciton to generate category sitemap data

Information Tags:

Version:	1.0
Author:	Bobby Easland

[ Top ]

GenerateProductSitemap [line 377]

boolean GenerateProductSitemap(
)

Function to generate product sitemap data

Information Tags:

Version:	1.0
Author:	Bobby Easland

[ Top ]

GenerateSitemap [line 331]

boolean GenerateSitemap(
array
$data, string
$file 
)

Function to generate sitemap file from data

Parameters:

array	$data:
string	$file:

Information Tags:

Version:	1.0
Author:	Bobby Easland

[ Top ]

GenerateSitemapIndex [line 352]

boolean GenerateSitemapIndex(
)

Function to generate sitemap index file

Information Tags:

Version:	1.0
Author:	Bobby Easland

[ Top ]

GenerateSubmitURL [line 467]

string GenerateSubmitURL(
)

Utility function to generate the submit URL

Information Tags:

Version:	1.0
Author:	Bobby Easland

[ Top ]

ReadGZ [line 455]

string ReadGZ(
string
$file 
)

Utility function to read and return the contents of a GZ formatted file

Parameters:

string

$file:

File to open

Information Tags:

Version:	1.0
Author:	Bobby Easland

[ Top ]

SaveFile [line 265]

boolean SaveFile(
string
$data, string
$type 
)

Function to save the sitemap data to file as either XML or XML.GZ format

Parameters:

string	$data:	XML data
string	$type:	Feed type (index, products, categories)

Information Tags:

Version:	1.0
Author:	Bobby Easland

[ Top ]

Documentation generated on Sat, 4 Jun 2005 23:45:59 -0400 by phpDocumentor 1.3.0RC3

	Google-XML-Sitemap-Feed

[ class tree: Google-XML-Sitemap-Feed ] [ index: Google-XML-Sitemap-Feed ] [ all elements ]