GenericSitemapGenerator Class Reference

Inheritance diagram for GenericSitemapGenerator:

Public Member Functions
	__construct ($path_type)
	initialise ($params=array())
	execute_request ()
	execute_onCaMykSInitialise ()
	initialise_configDisplay ()
	display_configDisplay ()
	initialise_configEdition ($form)
	display_configEdition ()
	save_configuration ()
Public Member Functions inherited from Input
	__construct ($name, $path_type)
	Input ($name, $path_type)
	display ()
	get_translation ($value, $data=null)
	set_selectedLayout ($layout='')
Public Member Functions inherited from Plugin
	__construct ($name, $plugin_type, $path_type)
	get_version ()
	load_library ($library='')
	load_file ($file='')
	load_varFile ($file='')
	load_engineFile ($file='')
	get_engineFileURL ($file='', $path=false)
	get_fileURL ($file='', $path=null, $default='')
	get_varFileURL ($file='', $path=false, $default='')
	get_filePath ($file='')
	get_varFilePath ($file='')
	add_JSFile ($file)
	add_JSEngineFile ($file)
	add_JSExternFile ($file)
	add_JSScript ($script, $unique=false)
	add_JSPreScript ($script, $unique=false)
	add_JSWindowEventScript ($event, $script, $unique=false)
	add_JSLoadScript ($script, $unique=false)
	add_JSUnloadScript ($script, $unique=false)
	add_styleFile ($file, $media='', $condition='')
	add_styleScript ($css)
	add_styleIncludedFile ($file)
	add_StyleExternFile ($file, $media='', $condition='')
	set_RSSFeed ($title, $url)
	add_headerExtra ($content='')
	install ()
	uninstall ()
	is_installed ()
	update ($version, $more='')
	add_translation ($more='', $lg=null)
	get_languages ()
	execute_onCaMykSPageLoad ()
	execute_onCaMykSBodyOpen ()
	execute_onCaMykSBodyClose ()
	execute_onCaMykSAdminPageLoad ()
	execute_onCaMykSAdminBodyOpen ()
	execute_onCaMykSAdminBodyClose ()
	execute_onCaMykSTerminate ()
	get_requestLink ($params=array())
	get_requestJSLink ($params=array())
	get_varFile ($file)

Private Member Functions
	execute_request_writeSitemap ()
	execute_request_sendSitemap ()
	load_configuration ()
	write_file ($content)
	get_sitemapContent ()
	get_sitemapContentFromModules ()

Additional Inherited Members
Public Attributes inherited from Input
	$title
	Input title. More...
	$params = array()
	Input parameters. More...
	$selected_layout = 'input.html.inc'
	Input layout to use. More...
Public Attributes inherited from Plugin
	$name
	Plugin name. More...
	$version
	Plugin version. More...
	$active = false
	Plugin installation status. More...
	$plugin_package = ''
	Plugin package. More...
	$plugin_type
	Plugin type. More...
	$object_type
	Plugin type. More...
	$plugin_path
	Plugin path. More...
	$plugin_site_path
	Plugin site path (for element overwriting). More...
	$plugin_var_path
	Plugin var path. More...
	$plugin_url
	Plugin URL. More...
	$plugin_site_url
	Plugin site URL (for element overwriting). More...
	$plugin_var_url
	Plugin var URL. More...
	$path_type
	Plugin path type. More...
	$author_name
	Plugin author name. More...
	$author_mail
	Plugin author email. More...
	$author_group
	Plugin author group. More...
	$plugin_dependencies = array()
	Plugin dependencies. More...
Protected Member Functions inherited from Plugin
	set_redirect ($time, $url='')
	add_meta ($name, $content, $method='name')
	add_toHtaccess ($content='')
	add_dependency ($plugin, $type, $version='1.0', $mandatory=false)
	set_dependencies ()
	register_asSharedObject ($name)
&	get_sharedObject ($name)
	register_asExtension ($plugin)
	get_registeredExtensions ()
	register_asCaMykSEventHandler ($event)

Detailed Description

GenericSitemapGenerator Input class.

Constructor & Destructor Documentation

__construct()

GenericSitemapGenerator::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

initialise()

GenericSitemapGenerator::initialise

(

$params = array()

)

Initialise input.

Parameters

array

$params

Returns

void

Reimplemented from Input.

execute_request()

GenericSitemapGenerator::execute_request

(

)

Execute Input object in request mode.

Returns

void

Reimplemented from Plugin.

execute_onCaMykSInitialise()

GenericSitemapGenerator::execute_onCaMykSInitialise

(

)

Execute handler on CaMykS initialisation.

Returns

void

Reimplemented from Plugin.

execute_request_writeSitemap()

GenericSitemapGenerator::execute_request_writeSitemap ( )

private

Execute Input object in request / write sitemap mode.

Returns

void

execute_request_sendSitemap()

GenericSitemapGenerator::execute_request_sendSitemap ( )

private

Execute Input object in request / send sitemap mode.

Returns

void

load_configuration()

GenericSitemapGenerator::load_configuration ( )

private

Load configuration.

Returns

void

write_file()

GenericSitemapGenerator::write_file (   $content )

private

Write sitemap file.

Parameters

string

$content

Returns

boolean sucess

get_sitemapContent()

GenericSitemapGenerator::get_sitemapContent ( )

private

Build sitemap content.

Returns

string

get_sitemapContentFromModules()

GenericSitemapGenerator::get_sitemapContentFromModules ( )

private

Build sitemap content from modules.

Returns

void

initialise_configDisplay()

GenericSitemapGenerator::initialise_configDisplay

(

)

Initialise object in Admin_Site / view configuration mode.

Returns

void

display_configDisplay()

GenericSitemapGenerator::display_configDisplay

(

)

Display object in Admin_Site / view configuration mode.

Returns

void

initialise_configEdition()

GenericSitemapGenerator::initialise_configEdition

(

$form

)

Initialise object in Admin_Site / edit configuration mode.

Parameters

Object

$form

Returns

void

display_configEdition()

GenericSitemapGenerator::display_configEdition

(

)

Display object in Admin_Site / edit configuration mode.

Returns

void

save_configuration()

GenericSitemapGenerator::save_configuration

(

)

Execute object in Admin_Site / save configuration mode.

Returns

void

---

The documentation for this class was generated from the following file:

• CaMykS/plugin/input/GenericSitemapGenerator/GenericSitemapGenerator.php.inc