CaMykS  1.0-20181201
 All Classes Files Functions Variables Pages
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Plugin Class Reference
Inheritance diagram for Plugin:
Inheritance graph
[legend]

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_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 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

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

Class constructor.

Parameters
string$name
string$plugin_type
string$path_type
Returns
void

Member Function Documentation

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
Plugin::add_headerExtra (   $content = '')

Add extra texts to page header

Parameters
string$content
Returns
void
Plugin::add_JSEngineFile (   $file)

Add an engine Javascript file to the page.

Parameters
string$file
Returns
void
Plugin::add_JSExternFile (   $file)

Add an external javascript file to the page.

Parameters
string$file
Returns
void
Plugin::add_JSFile (   $file)

Add a plugin Javascript file to the page.

Parameters
string$file
Returns
void
Plugin::add_JSLoadScript (   $script,
  $unique = false 
)

Add a Javascript script to the page load event.

Parameters
string$script
boolean$unique
Returns
void
Plugin::add_JSPreScript (   $script,
  $unique = false 
)

Add a Javascript pre script to the page.

Parameters
string$script
boolean$unique
Returns
void
Plugin::add_JSScript (   $script,
  $unique = false 
)

Add a Javascript script to the page.

Parameters
string$script
boolean$unique
Returns
void
Plugin::add_JSUnloadScript (   $script,
  $unique = false 
)

Add a Javascript script to the page unload event.

Parameters
string$script
boolean$unique
Returns
void
Plugin::add_JSWindowEventScript (   $event,
  $script,
  $unique = false 
)

Add a Javascript script to the page events.

Parameters
string$event
string$script
boolean$unique
Returns
void
Plugin::add_meta (   $name,
  $content,
  $method = 'name' 
)
protected

Add a meta tag to the page.

Parameters
string$name
string$content
string$method
Returns
void
Plugin::add_StyleExternFile (   $file,
  $media = '',
  $condition = '' 
)

Add an external javascript file to the page.

Parameters
string$file
string$media
string$condition
Returns
void
Plugin::add_styleFile (   $file,
  $media = '',
  $condition = '' 
)

Add a CSS style file to the page.

Parameters
string$file
string$media
string$condition
Returns
void
Plugin::add_styleIncludedFile (   $file)

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

Parameters
string$file
Returns
void
Plugin::add_styleScript (   $css)

Add a CSS style script to the page.

Parameters
string$css
Returns
void
Plugin::add_toHtaccess (   $content = '')
protected

Add content to .htaccess file

Parameters
string$content
Returns
boolean success
Plugin::add_translation (   $more = '',
  $lg = null 
)

Load language dictionnary file.

Parameters
string$more
string$lg
Returns
void
Plugin::execute_onCaMykSBodyClose ( )

Execute handler on body closing.

Returns
string
Plugin::execute_onCaMykSBodyOpen ( )

Execute handler on body opening.

Returns
string
Plugin::execute_onCaMykSInitialise ( )

Execute handler on CaMykS initialisation.

Returns
void
Plugin::execute_onCaMykSPageLoad ( )

Execute handler on CaMykS page load.

Returns
void
Plugin::execute_onCaMykSTerminate ( )

Execute handler on camyks terminate.

Returns
void
Plugin::execute_request ( )

Execute module in request mode.

Returns
void
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
Plugin::get_filePath (   $file = '')

Return file path.

Parameters
string$file
Returns
string
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
Plugin::get_languages ( )

Load available language files for the plugin

Returns
void
Plugin::get_registeredExtensions ( )
protected

Return registered extensions.

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

Return JavaScript request mode link.

Parameters
array$params
Returns
string
Plugin::get_requestLink (   $params = array())

Return HTML request mode link.

Parameters
array$params
Returns
string
& Plugin::get_sharedObject (   $name)
protected

Return requested shared object.

Parameters
string$name
Returns
Object
Plugin::get_translation (   $value,
  $data = null 
)

Return locale value.

Parameters
string$value
mixed$data
Returns
string
Plugin::get_varFile (   $file)

Alias to get_varFilePath method.

See also
get_varFilePath()
Parameters
string$file
Returns
void
Deprecated:
Use get_varFilePath instead.
Plugin::get_varFilePath (   $file = '')

Return file from var plugin folder.

Parameters
string$file
Returns
string
Plugin::get_varFileURL (   $file = '',
  $path = false,
  $default = '' 
)

Return plugin var file URL.

Parameters
string$file
boolean$path
string$default
Returns
string
Plugin::get_version ( )

Return version value.

Returns
string
Plugin::install ( )

Install plugin.

Returns
boolean
Plugin::is_installed ( )

Check if plugin is installed.

Returns
boolean
Plugin::load_engineFile (   $file = '')

Load a file from engine data folder.

Parameters
string$file
Returns
void
Plugin::load_file (   $file = '')

Load a file from plugin folder.

Parameters
string$file
Returns
boolean success
Plugin::load_library (   $library = '')

Load library file.

Parameters
string$library
Returns
boolean success
Plugin::load_varFile (   $file = '')

Load a file from var plugin folder.

Parameters
string$file
Returns
boolean success
Plugin::register_asCaMykSEventHandler (   $event)
protected

Register plugin as handler for CaMykS event.

Parameters
string$event
Plugin::register_asExtension (   $plugin)
protected

Register plugin as extension to another.

Parameters
string$plugin
Returns
void
Plugin::register_asSharedObject (   $name)
protected

Register this plugin to be accessed by any other.

Parameters
string$name
Returns
boolean success
Plugin::set_dependencies ( )
protected

Build dependencies list

Returns
boolean success
Plugin::set_redirect (   $time,
  $url = '' 
)
protected

Add a redirection to given page URL.

Parameters
integer$timethe timeout in second
string$urlthe url to target
Returns
void
Plugin::set_RSSFeed (   $title,
  $url 
)

Add RSS Feed link.

Parameters
string$title
string$url
Returns
void
Plugin::uninstall ( )

Uninstall plugin.

Returns
boolean
Plugin::update (   $version,
  $more = '' 
)

Update plugin.

Parameters
string$version
string$more
Returns
boolean

Member Data Documentation

boolean Plugin::$active = false

Plugin installation status.

string Plugin::$author_group

Plugin author group.

string Plugin::$author_mail

Plugin author email.

string Plugin::$author_name

Plugin author name.

string Plugin::$name

Plugin name.

string Plugin::$object_type

Plugin type.

string Plugin::$path_type

Plugin path type.

string Plugin::$plugin_dependencies = array()

Plugin dependencies.

string Plugin::$plugin_package = ''

Plugin package.

string Plugin::$plugin_path

Plugin path.

string Plugin::$plugin_site_path

Plugin site path (for element overwriting).

string Plugin::$plugin_site_url

Plugin site URL (for element overwriting).

string Plugin::$plugin_type

Plugin type.

string Plugin::$plugin_url

Plugin URL.

string Plugin::$plugin_var_path

Plugin var path.

string Plugin::$plugin_var_url

Plugin var URL.

string Plugin::$version

Plugin version.


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