Plugin object
Parent object for Module, Input, Template, Theme. More...

Inheritance diagram for Plugin:

Public Member Functions
	__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_translation ($value, $data=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())

	execute_request ()

	get_varFile ($file)

Public Attributes
	$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
	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

Plugin object
Parent object for Module, Input, Template, Theme.

Engine / Object Library

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

Version: 1.0.8.1

Date: Creation: Jun 2005; Modification: Jan 2021

Copyright: 2005 - 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. Plugin class.

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

Constructor & Destructor Documentation

◆ __construct()

Plugin::__construct	(	$name,
		$plugin_type,
		$path_type
	)

Class constructor.

Parameters

string	$name
string	$plugin_type
string	$path_type

Returns: void

Member Function Documentation

◆ get_version()

Plugin::get_version ( )

Return version value.

Returns: string

◆ load_library()

Plugin::load_library ( $library = '' )

Load library file.

Parameters

string $library

Returns: boolean success

◆ load_file()

Plugin::load_file ( $file = '' )

Load a file from plugin folder.

Parameters

string $file

Returns: boolean success

◆ load_varFile()

Plugin::load_varFile ( $file = '' )

Load a file from var plugin folder.

Parameters

string $file

Returns: boolean success

◆ load_engineFile()

Plugin::load_engineFile ( $file = '' )

Load a file from engine data folder.

Parameters

string $file

Returns: void

◆ get_engineFileURL()

Plugin::get_engineFileURL	(	$file = `''`,
		$path = `false`
	)

Return a file URL from engine data folder.

Parameters

string	$file
integer	$path	- Available values for path are 0 Default 1 Absolute 2 Relative

Returns: string

◆ get_fileURL()

Plugin::get_fileURL	(	$file = `''`,
		$path = `null`,
		$default = `''`
	)

Return plugin file URL.

Parameters

string	$file
integer	$path	- Available values for path are 0 Default 1 Absolute 2 Relative
string	$default

Returns: string

◆ get_varFileURL()

Plugin::get_varFileURL	(	$file = `''`,
		$path = `false`,
		$default = `''`
	)

Return plugin var file URL.

Parameters

string	$file
boolean	$path
string	$default

Returns: string

◆ get_filePath()

Plugin::get_filePath ( $file = '' )

Return file path.

Parameters

string $file

Returns: string

◆ get_varFilePath()

Plugin::get_varFilePath ( $file = '' )

Return file from var plugin folder.

Parameters

string $file

Returns: string

◆ set_redirect()

Plugin::set_redirect	(	$time,
		$url = `''`
	)

protected

Add a redirection to given page URL.

Parameters

integer	$time	the timeout in second
string	$url	the url to target

Returns: void

◆ add_meta()

Plugin::add_meta	(	$name,
		$content,
		$method = `'name'`
	)

protected

Add a meta tag to the page.

Parameters

string	$name
string	$content
string	$method

Returns: void

◆ add_JSFile()

Plugin::add_JSFile ( $file )

Add a plugin Javascript file to the page.

Parameters

string $file

Returns: void

◆ add_JSEngineFile()

Plugin::add_JSEngineFile ( $file )

Add an engine Javascript file to the page.

Parameters

string $file

Returns: void

◆ add_JSExternFile()

Plugin::add_JSExternFile ( $file )

Add an external javascript file to the page.

Parameters

string $file

Returns: void

◆ add_JSScript()

Plugin::add_JSScript	(	$script,
		$unique = `false`
	)

Add a Javascript script to the page.

Parameters

string	$script
boolean	$unique

Returns: void

◆ add_JSPreScript()

Plugin::add_JSPreScript	(	$script,
		$unique = `false`
	)

Add a Javascript pre script to the page.

Parameters

string	$script
boolean	$unique

Returns: void

◆ add_JSWindowEventScript()

Plugin::add_JSWindowEventScript	(	$event,
		$script,
		$unique = `false`
	)

Add a Javascript script to the page events.

Parameters

string	$event
string	$script
boolean	$unique

Returns: void

◆ add_JSLoadScript()

Plugin::add_JSLoadScript	(	$script,
		$unique = `false`
	)

Add a Javascript script to the page load event.

Parameters

string	$script
boolean	$unique

Returns: void

◆ add_JSUnloadScript()

Plugin::add_JSUnloadScript	(	$script,
		$unique = `false`
	)

Add a Javascript script to the page unload event.

Parameters

string	$script
boolean	$unique

Returns: void

◆ add_styleFile()

Plugin::add_styleFile	(	$file,
		$media = `''`,
		$condition = `''`
	)

Add a CSS style file to the page.

Parameters

string	$file
string	$media
string	$condition

Returns: void

◆ add_styleScript()

Plugin::add_styleScript ( $css )

Add a CSS style script to the page.

Parameters

string $css

Returns: void

◆ add_styleIncludedFile()

Plugin::add_styleIncludedFile ( $file )

Add a CSS style file to be included in the page.

Parameters

string $file

Returns: void

◆ add_StyleExternFile()

Plugin::add_StyleExternFile	(	$file,
		$media = `''`,
		$condition = `''`
	)

Add an external javascript file to the page.

Parameters

string	$file
string	$media
string	$condition

Returns: void

◆ set_RSSFeed()

Plugin::set_RSSFeed	(	$title,
		$url
	)

Add RSS Feed link.

Parameters

string	$title
string	$url

Returns: void

◆ add_headerExtra()

Plugin::add_headerExtra ( $content = '' )

Add extra texts to page header

Parameters

string $content

Returns: void

◆ install()

Plugin::install ( )

Install plugin.

Returns: boolean

◆ uninstall()

Plugin::uninstall ( )

Uninstall plugin.

Returns: boolean

Reimplemented in Content_TwitterStatusesViewer, Content_SystemSiteReport, Content_GoogleSearchResultsViewer, Content_GooglePoIMapViewer, Content_GoogleMapsViewer, Content_GenericSiteMap, Content_GenericRandomText, Content_GenericQuickMessage, Content_GenericPetitionViewer, Content_GenericPageRedirector, Content_GenericPageList, Content_GenericNews, Content_GenericMenu, Content_GenericLegalMentions, Content_GenericHTMLNews, Content_GenericHTMLContent, Content_GenericGuestBookViewer, Content_GenericGlossaryViewer, Content_GenericGallery, Content_GenericFaq, Content_GenericBlogsViewer, Content_GenericArticle, Admin_SystemUniqueIDManager, Admin_SystemReport, Admin_SystemNotifications, Admin_Statistics, Admin_SecurityTools, Admin_PluginManager, Admin_MyMessages, Admin_MonitoringUserAgentChecker, Admin_Group, Admin_GenericMediaLibraryManager, Admin_GenericGuestBookManager, Admin_GenericGlossaryManager, Admin_GenericEmailingManager, Admin_GenericDownloadManager, Admin_GenericContactFormManager, and Admin_ContentPage.

◆ is_installed()

Plugin::is_installed ( )

Check if plugin is installed.

Returns: boolean

◆ update()

Plugin::update	(	$version,
		$more = `''`
	)

Update plugin.

Parameters

string	$version
string	$more

Returns: boolean

Reimplemented in Content_SystemSiteReport, Content_GenericBlogsViewer, Admin_User, Admin_SecurityTools, Admin_GenericEmailingManager, and Admin_ContentPage.

◆ add_toHtaccess()

Plugin::add_toHtaccess ( $content = '' )

protected

Add content to .htaccess file

Parameters

string $content

Returns: boolean success

◆ add_translation()

Plugin::add_translation	(	$more = `''`,
		$lg = `null`
	)

Load language dictionnary file.

Parameters

string	$more
string	$lg

Returns: void

◆ get_translation()

Plugin::get_translation	(	$value,
		$data = `null`
	)

Return locale value.

Parameters

string	$value
mixed	$data

Returns: string

Reimplemented in Input, and Module.

◆ get_languages()

Plugin::get_languages ( )

Load available language files for the plugin

Returns: void

◆ add_dependency()

Plugin::add_dependency	(	$plugin,
		$type,
		$version = `'1.0'`,
		$mandatory = `false`
	)

protected

Add a dependency.

Parameters

string	$plugin
string	$type
string	$version
boolean	$mandatory

Returns: void

◆ set_dependencies()

Plugin::set_dependencies ( )

protected

Build dependencies list

Returns: boolean success

Reimplemented in Content_GenericGallery.

◆ register_asSharedObject()

Plugin::register_asSharedObject ( $name )

protected

Register this plugin to be accessed by any other.

Parameters

string $name

Returns: boolean success

◆ get_sharedObject()

& Plugin::get_sharedObject ( $name )

protected

Return requested shared object.

Parameters

string $name

Returns: Object

◆ register_asExtension()

Plugin::register_asExtension ( $plugin )

protected

Register plugin as extension to another.

Parameters

string $plugin

Returns: void

◆ get_registeredExtensions()

Plugin::get_registeredExtensions ( )

protected

Return registered extensions.

Returns: array

◆ register_asCaMykSEventHandler()

Plugin::register_asCaMykSEventHandler ( $event )

protected

Register plugin as handler for CaMykS event.

Parameters

string $event

◆ execute_onCaMykSInitialise()

Plugin::execute_onCaMykSInitialise ( )

Execute handler on CaMykS initialisation.

Returns: void

Reimplemented in Admin_SecurityTools, and GenericSitemapGenerator.

◆ execute_onCaMykSPageLoad()

Plugin::execute_onCaMykSPageLoad ( )

Execute handler on CaMykS page load.

Returns: void

Reimplemented in SocialNetworksSharingPanel, SiteMonitoringToolbar, GoogleAnalytics, GenericMediaPopup, CrispChat, CookieAgreementMessage, and CodeAuthenticator.

◆ execute_onCaMykSBodyOpen()

Plugin::execute_onCaMykSBodyOpen ( )

Execute handler on body opening.

Returns: string

Reimplemented in SocialNetworksSharingPanel, and GoogleAnalytics.

◆ execute_onCaMykSBodyClose()

Plugin::execute_onCaMykSBodyClose ( )

Execute handler on body closing.

Returns: string

Reimplemented in SocialNetworksSharingPanel, and CookieAgreementMessage.

◆ execute_onCaMykSAdminPageLoad()

Plugin::execute_onCaMykSAdminPageLoad ( )

Execute handler on CaMykS admin page load.

Returns: void

◆ execute_onCaMykSAdminBodyOpen()

Plugin::execute_onCaMykSAdminBodyOpen ( )

Execute handler on admin body opening.

Returns: string

◆ execute_onCaMykSAdminBodyClose()

Plugin::execute_onCaMykSAdminBodyClose ( )

Execute handler on admin body closing.

Returns: string

◆ execute_onCaMykSTerminate()

Plugin::execute_onCaMykSTerminate ( )

Execute handler on camyks terminate.

Returns: void

Reimplemented in SiteMonitoringToolbar.

◆ get_requestLink()

Plugin::get_requestLink ( $params = array() )

Return HTML request mode link.

Parameters

array $params

Returns: string

◆ get_requestJSLink()

Plugin::get_requestJSLink ( $params = array() )

Return JavaScript request mode link.

Parameters

array $params

Returns: string

◆ execute_request()

Plugin::execute_request ( )

Execute module in request mode.

Returns: void

Reimplemented in Tool_InfoBar, Content_GooglePoIMapViewer, Content_GenericHTMLNews, Content_GenericBlogsViewer, Admin_SystemNotifications, Admin_SystemLogManager, Admin_SecurityTools, Admin_GenericPetitionManager, Admin_GenericMediaLibraryManager, Admin_GenericEmailingManager, Admin_GenericDownloadManager, Admin_ContentPage, StripePayment, SiteMonitoringToolbar, SecurimageCaptcha, GenericSitemapGenerator, FileManager, ColorPicker, and CodeAuthenticator.

◆ get_varFile()

Plugin::get_varFile ( $file )

Alias to get_varFilePath method.

See also: get_varFilePath()

Parameters

string $file

Returns: void

Deprecated:: Use get_varFilePath instead.

Member Data Documentation

◆ $name

string Plugin::$name

Plugin name.

◆ $version

string Plugin::$version

Plugin version.

◆ $active

boolean Plugin::$active = false

Plugin installation status.

◆ $plugin_package

string Plugin::$plugin_package = ''

Plugin package.

◆ $plugin_type

string Plugin::$plugin_type

Plugin type.

◆ $object_type

string Plugin::$object_type

Plugin type.

◆ $plugin_path

string Plugin::$plugin_path

Plugin path.

◆ $plugin_site_path

string Plugin::$plugin_site_path

Plugin site path (for element overwriting).

◆ $plugin_var_path

string Plugin::$plugin_var_path

Plugin var path.

◆ $plugin_url

string Plugin::$plugin_url

Plugin URL.

◆ $plugin_site_url

string Plugin::$plugin_site_url

Plugin site URL (for element overwriting).

◆ $plugin_var_url

string Plugin::$plugin_var_url

Plugin var URL.

◆ $path_type

string Plugin::$path_type

Plugin path type.

◆ $author_name

string Plugin::$author_name

Plugin author name.

◆ $author_mail

string Plugin::$author_mail

Plugin author email.

◆ $author_group

string Plugin::$author_group

Plugin author group.

◆ $plugin_dependencies

string Plugin::$plugin_dependencies = array()

Plugin dependencies.

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

CaMykS/engine/lib/object/Plugin.php.inc

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ get_version()

◆ load_library()

◆ load_file()

◆ load_varFile()

◆ load_engineFile()

◆ get_engineFileURL()

◆ get_fileURL()

◆ get_varFileURL()

◆ get_filePath()

◆ get_varFilePath()

◆ set_redirect()

◆ add_meta()

◆ add_JSFile()

◆ add_JSEngineFile()

◆ add_JSExternFile()

◆ add_JSScript()

◆ add_JSPreScript()

◆ add_JSWindowEventScript()

◆ add_JSLoadScript()

◆ add_JSUnloadScript()

◆ add_styleFile()

◆ add_styleScript()

◆ add_styleIncludedFile()

◆ add_StyleExternFile()

◆ set_RSSFeed()

◆ add_headerExtra()

◆ install()

◆ uninstall()

◆ is_installed()

◆ update()

◆ add_toHtaccess()

◆ add_translation()

◆ get_translation()

◆ get_languages()

◆ add_dependency()

◆ set_dependencies()

◆ register_asSharedObject()

◆ get_sharedObject()

◆ register_asExtension()

◆ get_registeredExtensions()

◆ register_asCaMykSEventHandler()

◆ execute_onCaMykSInitialise()

◆ execute_onCaMykSPageLoad()

◆ execute_onCaMykSBodyOpen()

◆ execute_onCaMykSBodyClose()

◆ execute_onCaMykSAdminPageLoad()

◆ execute_onCaMykSAdminBodyOpen()

◆ execute_onCaMykSAdminBodyClose()

◆ execute_onCaMykSTerminate()

◆ get_requestLink()

◆ get_requestJSLink()

◆ execute_request()

◆ get_varFile()

Member Data Documentation

◆ $name

◆ $version

◆ $active

◆ $plugin_package

◆ $plugin_type

◆ $object_type

◆ $plugin_path

◆ $plugin_site_path

◆ $plugin_var_path

◆ $plugin_url

◆ $plugin_site_url

◆ $plugin_var_url

◆ $path_type

◆ $author_name

◆ $author_mail

◆ $author_group

◆ $plugin_dependencies