CaMykS  1.0-20231201
Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | Private Attributes | List of all members
GenericMediaPopup Class Reference

GenericMediaPopup Input
Inline popup creator automatically managing content to display. More...

Inheritance diagram for GenericMediaPopup:
Input Plugin

Public Member Functions

 __construct ($path_type)
 
 initialise ($params=array())
 
 execute_onCaMykSPageLoad ()
 
 add_pictureToDiaporama ($url, $title)
 
 get_tinyMCEPluginParams ()
 
 initialise_configDisplay ()
 
 display_configDisplay ()
 
 initialise_configEdition ($form)
 
 display_configEdition ()
 
 save_configuration ()
 
 get_cookieInformationData ()
 
- 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_onCaMykSInitialise ()
 
 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

 $params
 Input parameters. More...
 
- 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 Attributes

 $config
 Input configuration. More...
 

Private Member Functions

 is_cookieAccepted ()
 

Private Attributes

 $loaded
 Is Input loaded. More...
 
 $diaporamaPictures
 Store diaporama picture URLs before sending them to client side. More...
 

Additional Inherited Members

- 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

GenericMediaPopup Input
Inline popup creator automatically managing content to display.

Plugin / Input 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.2
Date
Creation: Oct 2011
Modification: Mar 2021
Copyright
2011 - 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.

Supported format :
- Picture : Gif, Jpg, PNG
- Video : FLV
- Animation : SWF
- HTML page : htm, html
- Youtube video ( http://youtu.be/xxxxxxxxxxxx ) GenericMediaPopup Input 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()

GenericMediaPopup::__construct (   $path_type)

Class constructor.

Parameters
string$path_type
Returns
void

Member Function Documentation

◆ initialise()

GenericMediaPopup::initialise (   $params = array())

Initialise input

Parameters
array$params
Returns
void

Reimplemented from Input.

◆ execute_onCaMykSPageLoad()

GenericMediaPopup::execute_onCaMykSPageLoad ( )

Execute handler on page loading.

Returns
void

Reimplemented from Plugin.

◆ add_pictureToDiaporama()

GenericMediaPopup::add_pictureToDiaporama (   $url,
  $title 
)

Add picture to diaporama.

Parameters
string$url
string$title
Returns
void

◆ get_tinyMCEPluginParams()

GenericMediaPopup::get_tinyMCEPluginParams ( )

Return TinyMCE plugin params.

Returns
array

◆ initialise_configDisplay()

GenericMediaPopup::initialise_configDisplay ( )

Initialise object in Admin_Site / view configuration mode.

Returns
void

◆ display_configDisplay()

GenericMediaPopup::display_configDisplay ( )

Display object in Admin_Site / view configuration mode.

Returns
void

◆ initialise_configEdition()

GenericMediaPopup::initialise_configEdition (   $form)

Initialise object in Admin_Site / edit configuration mode.

Parameters
Object$form
Returns
void

◆ display_configEdition()

GenericMediaPopup::display_configEdition ( )

Display object in Admin_Site / edit configuration mode.

Returns
void

◆ save_configuration()

GenericMediaPopup::save_configuration ( )

Execute object in Admin_Site / save configuration mode.

Returns
void

◆ get_cookieInformationData()

GenericMediaPopup::get_cookieInformationData ( )

Return plugin information related to cookies.

Returns
void

◆ is_cookieAccepted()

GenericMediaPopup::is_cookieAccepted ( )
private

Check if plugin is cookie accepted.

Returns
boolean

Member Data Documentation

◆ $config

GenericMediaPopup::$config
protected

Input configuration.

var Object $config

◆ $params

GenericMediaPopup::$params
Initial value:
= array(
'objectName' => 'mp',
'styleSource' => 'plugin',
'styleFile' => '',
'clickBkgdToClose' => 1,
'enableKeyboard' => 1,
'enableFlash' => 1,
'enableCloseButton' => 1,
'flvControlerColor' => '1F1F1F',
'flvControlerAlpha' => 0.85,
'flvControlerHeight' => 20,
'enableDiaporama' => 1,
'diaporamaButtonsShift' => 0,
'maxWidth' => 0,
'directOpenOnMobile' => 0,
'isMobile' => -1,
'buttonPictures' => array(),
)

Input parameters.

var array $params

◆ $loaded

GenericMediaPopup::$loaded
private

Is Input loaded.

var boolean $loaded

◆ $diaporamaPictures

GenericMediaPopup::$diaporamaPictures
private

Store diaporama picture URLs before sending them to client side.

var array $diaporamaPictures

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1