Admin_GenericPetitionManager Class Reference

Admin_GenericPetitionManager Module
Manages petitions. More...

Inheritance diagram for Admin_GenericPetitionManager:

Public Member Functions
	__construct ($path_type)
	install ()
	is_installed ()
	get_rights ()
	get_adminEngineSpecificMenus ()
	get_adminEngineSpecificMenuItems ()
	init_admin ()
	execute_request ()
	get_signatureStatusList ()
	get_signaturesStatusList ($full=false)
	get_signatureList ($params=array())
	get_signatureTitleList ($full=false, $params=array())
	get_petitionStatusList ()
	get_petitionsStatusList ($full=false)
	get_petitionTypeList ()
	get_petitionsTypeList ($full=false)
	get_petitionTitleList ($params=array())
	get_petitionList ($params=array())
	count_petitions ($params=array())
	count_signsByPetitions ($petitions)
Public Member Functions inherited from Module
	__construct ($name, $path_type)
	Module ($name, $path_type)
	get_help ()
	display_help ()
	set_theme ($theme)
	get_translation ($value, $data=array())
	get_adminEditionLanguage ()
	get_contentList ()
	preInit_admin ()
	display_admin ()
	init_parent_admin ()
	get_adminLink ($params=array(), $module=null)
	get_adminJSLink ($params=array(), $module=null)
	init_site ($content=1, $params=array(), $index=null)
	display_site ()
	set_selectedLayout ($layout='', $location='')
	get_adminLayout ($layout='')
	get_siteLayout ()
	get_adminEngineGenericMenus ()
	get_adminEngineGenericMenuItems ()
	get_adminEngineGenericInit ()
	get_adminEngineGenericDisplay ()
	get_adminInternalNotifications ()
	get_adminControlPanelAction ()
	get_adminStatisticsValueTitles ($list, $object=null)
	get_adminStatisticsSpecificOptions ($object=null)
	check_right ($info)
	get_fileInputButtons ($buttons=array(), $delete=true)
	get_dateInputButtons ($update=true, $reset=true)
	init_generic ()
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='')
	uninstall ()
	update ($version, $more='')
	add_translation ($more='', $lg=null)
	get_languages ()
	execute_onCaMykSInitialise ()
	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)

Public Attributes
	$petitionItem
	Petition object. More...
	$petitionList = null
	Petition list. More...
	$signatureItem
	Signature object. More...
	$signatureList = null
	Signature list. More...
Public Attributes inherited from Module
	$type
	Module type, can be admin or content. More...
	$title
	Module title. More...
	$libdesc
	Module library description. More...
	$theme
	Theme applied to the Module. More...
	$languages
	Module available locale files. More...
	$rights = array()
	Module permissions. More...
	$selected_layout = ''
	Module layout to use. More...
	$selected_layout_location = 'module'
	Module layout location, can be module or camyks. More...
	$help = null
	Module help files. More...
	$is_editable = true
	Module has editable content. 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...

Private Member Functions
	init_admin_main ()
	init_admin_edit_petition ()
	init_admin_save_petition ()
	init_admin_delete_petition ()
	init_admin_list_signature ()
	init_admin_edit_signature ()
	init_admin_save_signature ()
	init_admin_delete_signature ()
	execute_request_exportXLS ()

Additional Inherited Members
Protected Member Functions inherited from Module
	init_admin_accessDenied ()
	init_admin_pageAccessDenied ()
	init_admin_actionNotAllowed ()
	init_admin_missingPlugin ($type, $name)
	disable_adminEngineMenus ()
	add_moduleContentToPage ($pageId, $moduleIndex, $contentId)
	get_PHPLibs ()
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)
Protected Attributes inherited from Module
	$libs = array()
	Module libraries to load. More...
	$text = ''
	Module admin message. More...

Detailed Description

Admin_GenericPetitionManager Module
Manages petitions.

Plugin, Module Engine

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.1

Date

Creation: Sep 2010

Modification: Jan 2021

Copyright

2010 - 2021 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Admin_GenericPetitionManager class.

Constructor & Destructor Documentation

__construct()

Admin_GenericPetitionManager::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

install()

Admin_GenericPetitionManager::install

(

)

Install module.

Returns

boolean success

Reimplemented from Plugin.

is_installed()

Admin_GenericPetitionManager::is_installed

(

)

Check module installation.

Returns

boolean result

Reimplemented from Plugin.

get_rights()

Admin_GenericPetitionManager::get_rights

(

)

Define module permission.

Returns

void

Reimplemented from Module.

get_adminEngineSpecificMenus()

Admin_GenericPetitionManager::get_adminEngineSpecificMenus

(

)

Register a menu in admin interface.

Returns

array

Reimplemented from Module.

get_adminEngineSpecificMenuItems()

Admin_GenericPetitionManager::get_adminEngineSpecificMenuItems

(

)

Register menu items in admin interface.

Returns

array

Reimplemented from Module.

init_admin()

Admin_GenericPetitionManager::init_admin

(

)

Initialise module object in admin mode

Returns

void

Reimplemented from Module.

execute_request()

Admin_GenericPetitionManager::execute_request

(

)

Execute module object in request mode.

Returns

void

Reimplemented from Plugin.

init_admin_main()

Admin_GenericPetitionManager::init_admin_main ( )

private

Initialise module object in admin/main mode.

Returns

void

init_admin_edit_petition()

Admin_GenericPetitionManager::init_admin_edit_petition ( )

private

Initialise module object in admin/edit_petition mode.

Returns

void

init_admin_save_petition()

Admin_GenericPetitionManager::init_admin_save_petition ( )

private

Initialise module object in admin/save_petition mode

Returns

void

init_admin_delete_petition()

Admin_GenericPetitionManager::init_admin_delete_petition ( )

private

Initialise module object in admin/delete_petition mode.

Returns

void

init_admin_list_signature()

Admin_GenericPetitionManager::init_admin_list_signature ( )

private

Initialise module object in admin/list_signature mode.

Returns

void

init_admin_edit_signature()

Admin_GenericPetitionManager::init_admin_edit_signature ( )

private

Initialise module object in admin/edit_signature mode.

Returns

void

init_admin_save_signature()

Admin_GenericPetitionManager::init_admin_save_signature ( )

private

Initialise module object in admin/save_signature mode.

Returns

void

init_admin_delete_signature()

Admin_GenericPetitionManager::init_admin_delete_signature ( )

private

Initialise module object in admin/delete_signature mode.

Returns

void

execute_request_exportXLS()

Admin_GenericPetitionManager::execute_request_exportXLS ( )

private

Execute module in execute/export results as XLS mode.

Parameters

string

$where

Returns

void

get_signatureStatusList()

Admin_GenericPetitionManager::get_signatureStatusList

(

)

Return signature status list.

Returns

array

get_signaturesStatusList()

Admin_GenericPetitionManager::get_signaturesStatusList

(

$full = false

)

Return signatures status list.

Parameters

boolean

$full

Returns

array

get_signatureList()

Admin_GenericPetitionManager::get_signatureList

(

$params = array()

)

Return signature list.

Parameters

array

$params

Returns

array

get_signatureTitleList()

Admin_GenericPetitionManager::get_signatureTitleList	(		$full = false,
			$params = array()
	)

Return signature title list.

Parameters

boolean	$full
array	$params

Returns

array

get_petitionStatusList()

Admin_GenericPetitionManager::get_petitionStatusList

(

)

Return petition status list.

Returns

array

get_petitionsStatusList()

Admin_GenericPetitionManager::get_petitionsStatusList

(

$full = false

)

Return petitions status list.

Parameters

boolean

$full

Returns

array

get_petitionTypeList()

Admin_GenericPetitionManager::get_petitionTypeList

(

)

Return petition type list.

Returns

array

get_petitionsTypeList()

Admin_GenericPetitionManager::get_petitionsTypeList

(

$full = false

)

Return petitions type list.

Parameters

boolean

$full

Returns

array

get_petitionTitleList()

Admin_GenericPetitionManager::get_petitionTitleList

(

$params = array()

)

Return petition title list.

Parameters

array

$params

Returns

array

get_petitionList()

Admin_GenericPetitionManager::get_petitionList

(

$params = array()

)

Return petition list.

Parameters

array

$params

Returns

array

count_petitions()

Admin_GenericPetitionManager::count_petitions

(

$params = array()

)

Return petition count.

Parameters

array

$params

Returns

array

count_signsByPetitions()

Admin_GenericPetitionManager::count_signsByPetitions

(

$petitions

)

Return signs count by given petition.

Parameters

array

$petitions

Returns

array

Member Data Documentation

$petitionItem

Admin_GenericPetitionManager::$petitionItem

Petition object.

var Object $petitionItem

$petitionList

Admin_GenericPetitionManager::$petitionList = null

Petition list.

var array $petitionList

$signatureItem

Admin_GenericPetitionManager::$signatureItem

Signature object.

var Object $signatureItem

$signatureList

Admin_GenericPetitionManager::$signatureList = null

Signature list.

var array $signatureList

---

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

• CaMykS/plugin/module/Admin_GenericPetitionManager/Admin_GenericPetitionManager.php.inc