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

Public Member Functions

 __construct ($path_type)
 
 initialise ($params=array(), $mode='share')
 
 display ($params=array(), $mode='share')
 
 execute_onCaMykSPageLoad ()
 
 execute_onCaMykSBodyOpen ()
 
 execute_onCaMykSBodyClose ()
 
 get_networkIconURL ($network='', $mode='')
 
 initialise_configDisplay ()
 
 display_configDisplay ()
 
 initialise_configEdition ($form)
 
 display_configEdition ()
 
 save_configuration ()
 
- Public Member Functions inherited from Input
 Input ($name, $path_type)
 
 initialise ($params=array())
 
 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_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

 $currentIndex
 Network list current index. 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 Member Functions

 get_networkHrefLink ($network)
 
 get_networkOnclickLink ($network)
 
 get_networkURL ($network, $mode)
 
- 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

 $iparams = array()
 Plugin's internal parameters list. More...
 
 $dparams
 Plugin's display parameters list. More...
 

Private Member Functions

 initialise_sharePanel ($params)
 
 initialise_followPanel ($params)
 
 display_sharePanel ($params=array())
 
 display_followPanel ($params=array())
 
 count_displayedNetworks ()
 
 initialise_networkList ()
 
 get_configValue ($item)
 

Detailed Description

SocialNetworksSharingPanel Input class.

Constructor & Destructor Documentation

SocialNetworksSharingPanel::__construct (   $path_type)

Class constructor.

Parameters
string$path_type
Returns
void

Member Function Documentation

SocialNetworksSharingPanel::count_displayedNetworks ( )
private

Count enabled networks.

Returns
void
SocialNetworksSharingPanel::display (   $params = array(),
  $mode = 'share' 
)

Display input.

Parameters
array$params
string$mode
Returns
void
SocialNetworksSharingPanel::display_configDisplay ( )

Display object in Admin_Site / view configuration mode.

Returns
void
SocialNetworksSharingPanel::display_configEdition ( )

Display object in Admin_Site / edit configuration mode.

Returns
void
SocialNetworksSharingPanel::display_followPanel (   $params = array())
private

Display input in share mode.

Parameters
array$params
Returns
void
SocialNetworksSharingPanel::display_sharePanel (   $params = array())
private

Display input in share mode.

Parameters
array$params
Returns
void
SocialNetworksSharingPanel::execute_onCaMykSBodyClose ( )

Execute handler on body closing.

Returns
string
SocialNetworksSharingPanel::execute_onCaMykSBodyOpen ( )

Execute handler on body opening.

Returns
string
SocialNetworksSharingPanel::execute_onCaMykSPageLoad ( )

Execute handler on body closing.

Returns
string
SocialNetworksSharingPanel::get_configValue (   $item)
private

Return configuration value

Parameters
string$item
Returns
mixed
SocialNetworksSharingPanel::get_networkHrefLink (   $network)
protected

Return given network href link.

Parameters
string$network
Returns
string
SocialNetworksSharingPanel::get_networkIconURL (   $network = '',
  $mode = '' 
)

Return given network icon url.

Parameters
string$network
string$mode
Returns
string
SocialNetworksSharingPanel::get_networkOnclickLink (   $network)
protected

Return given network href link.

Parameters
string$network
Returns
string
SocialNetworksSharingPanel::get_networkURL (   $network,
  $mode 
)
protected

Return given network URL.

Parameters
string$network
string$mode
Returns
string
SocialNetworksSharingPanel::initialise (   $params = array(),
  $mode = 'share' 
)

Initialise input.

Parameters
array$params
string$mode
Returns
void
SocialNetworksSharingPanel::initialise_configDisplay ( )

Initialise object in Admin_Site / view configuration mode.

Returns
void
SocialNetworksSharingPanel::initialise_configEdition (   $form)

Initialise object in Admin_Site / edit configuration mode.

Parameters
Object$form
Returns
void
SocialNetworksSharingPanel::initialise_followPanel (   $params)
private

Initialise input in follow mode

Parameters
array$params
Returns
void
SocialNetworksSharingPanel::initialise_networkList ( )
private

Initialise network list

Returns
void
SocialNetworksSharingPanel::initialise_sharePanel (   $params)
private

Initialise input in share mode.

Parameters
array$params
Returns
void
SocialNetworksSharingPanel::save_configuration ( )

Execute object in Admin_Site / save configuration mode.

Returns
void

Member Data Documentation

SocialNetworksSharingPanel::$currentIndex

Network list current index.

var integer $currentIndex

SocialNetworksSharingPanel::$dparams
protected

Plugin's display parameters list.

var array $dparams

SocialNetworksSharingPanel::$iparams = array()
protected

Plugin's internal parameters list.

var array $iparams


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