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

Public Member Functions

 __construct ($path_type)
 
 initialise ($name='sg')
 
 set_themeValues ($theme='itunes')
 
 set_URLsValues ($image, $thumb)
 
 set_thumbValues ($width=80, $height=60, $count=6)
 
 set_imageValues ($width=0, $height=0, $hasTitle=true, $hasDesc=true)
 
 set_slidingValues ($method='page', $accel=1, $speed=30, $interval=25)
 
 add_item ($id, $type, $thumb, $image, $title='', $desc='')
 
- 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

 $name
 Instance name. More...
 
 $theme = 'itunes'
 Instance theme. More...
 
 $items = array()
 Item list. More...
 
 $sliding = false
 Is sliding enabled. 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...
 

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

SmartGallery Input class.

Constructor & Destructor Documentation

SmartGallery::__construct (   $path_type)

Class constructor.

Parameters
sting$path_type
Returns
void

Member Function Documentation

SmartGallery::add_item (   $id,
  $type,
  $thumb,
  $image,
  $title = '',
  $desc = '' 
)

insert a new item in item list

Parameters
mixed$id
string$type
string$thumb
string$image
string$title
string$desc
Returns
void
SmartGallery::initialise (   $name = 'sg')

Initialise input.

Parameters
string$name
Returns
void
SmartGallery::set_imageValues (   $width = 0,
  $height = 0,
  $hasTitle = true,
  $hasDesc = true 
)

Set main images info.

Parameters
int$width
int$height
bool$hasTitle
bool$hasDesc
Returns
void
SmartGallery::set_slidingValues (   $method = 'page',
  $accel = 1,
  $speed = 30,
  $interval = 25 
)

Set sliding config.

Parameters
string$method
int$accel
int$speed
int$interval
Returns
void
SmartGallery::set_themeValues (   $theme = 'itunes')

Set theme value.

Parameters
string$theme
Returns
void
SmartGallery::set_thumbValues (   $width = 80,
  $height = 60,
  $count = 6 
)

Set thumb images info.

Parameters
int$width
int$height
int$count
Returns
void
SmartGallery::set_URLsValues (   $image,
  $thumb 
)

Set images urls.

Parameters
string$image
string$thumb
Returns
void

Member Data Documentation

array SmartGallery::$items = array()

Item list.

string SmartGallery::$name

Instance name.

boolean SmartGallery::$sliding = false

Is sliding enabled.

string SmartGallery::$theme = 'itunes'

Instance theme.


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