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

Public Member Functions

 __construct ($name, $path_type)
 
 Theme ($name, $path_type)
 
 initialise ()
 
 initialise_adminMode ()
 
 get_parts ()
 
 get_included_parts ()
 
 get_main_css ()
 
 get_included_main_css ()
 
 get_editor_css ()
 
 get_editorCSSURL ()
 
 get_part ($part, $data=array())
 
 get_pictURL ($item, $size=12, $position='std')
 
 get_pictURLWithName ($pict)
 
 get_pictHTMLTag ($params=array())
 
 get_bar ($params='', $style='')
 
 get_barComplete ($params='', $style='')
 
 get_barLeft ($params='')
 
 get_barRight ()
 
 get_barButton ($params='', $url='', $id='', $style='')
 
 get_barItem ($params, $id='', $style='')
 
 get_boxHeader ($params='')
 
 get_boxTitleBar ($title='')
 
 get_boxTabsBar ($tabs, $params, $mover='', $mout='', $selected='')
 
 get_boxButtonsBar ($buttons=array())
 
 get_boxContent1Header ($more='')
 
 get_boxContent2Header ($more='')
 
 get_boxContent1Footer ()
 
 get_boxContent2Footer ()
 
 get_boxContentHeader ($more='')
 
 get_boxContentFooter ()
 
 get_boxFooter ()
 
 get_lightBoxHeader ($style='')
 
 get_lightBoxFooter ()
 
 get_button ($params, $url='', $style='')
 
 get_layeredMenu ($name, $objectname, $content)
 
 get_layeredMenuHeader ($name, $objectname)
 
 get_layeredMenuSeparator ()
 
 get_layeredMenuNoLinkItem ($item=array())
 
 get_layeredMenuLinkItem ($item=array())
 
 get_layeredMenuFooter ()
 
- 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

 $partsLoaded = false
 Are parts loaded. More...
 
 $parts = array()
 Are parts loaded. More...
 
 $responsiveStyles = array()
 Define responsiveness of theme. More...
 
 $touchIcons = array()
 Define available touch icons. More...
 
 $useEnhancedSelectInputs = false
 Set useEnhancedSelectInputs to default value. 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...
 

Private Attributes

 $autoBoxContent = 'Close'
 
 $isAdminResponsive = false
 Set isAdminResponsive to default value. 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

Theme 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

Theme::__construct (   $name,
  $path_type 
)

Class constructor.

Parameters
string$name
string$path_type
Returns
void

Member Function Documentation

Theme::get_bar (   $params = '',
  $style = '' 
)

Alias to get_barComplete

See also
get_barComplete()
Parameters
array$params
string$style
Returns
string
Theme::get_barButton (   $params = '',
  $url = '',
  $id = '',
  $style = '' 
)

Display bar button item.

Parameters
mixed$params(string button title or whole button data struct array)
string$url
string$id
string$style
Returns
string
Theme::get_barComplete (   $params = '',
  $style = '' 
)

Display full bar.

Parameters
array$params
string$style
Returns
string
Theme::get_barItem (   $params,
  $id = '',
  $style = '' 
)

Display bar item.

Parameters
mixed$params(string item title or whole item data struct array)
string$id
string$style
Returns
string
Theme::get_barLeft (   $params = '')

Display left part of the bar.

Parameters
array$params
Returns
string
Theme::get_barRight ( )

Display right part of the bar

Returns
string
Theme::get_boxButtonsBar (   $buttons = array())

Display box buttons bar.

Parameters
array$buttons
Returns
string
Theme::get_boxContent1Footer ( )

Display box content 1 footer.

Returns
string
Theme::get_boxContent1Header (   $more = '')

Display box content 1 header.

Parameters
string$more
Returns
string
Theme::get_boxContent2Footer ( )

Display box content 2 footer.

Returns
string
Theme::get_boxContent2Header (   $more = '')

Display box content 2 header.

Parameters
string$more
Returns
string
Theme::get_boxContentFooter ( )

Display box generic content footer, alias to get_boxContent1Footer().

Returns
string
Theme::get_boxContentHeader (   $more = '')

Display box generic content header, alias to get_boxContent1Header().

Parameters
string$more
Returns
string
Theme::get_boxFooter ( )

Display box footer.

Returns
string
Theme::get_boxHeader (   $params = '')

Display box header.

Parameters
mixed$params(string item style or whole item data struct array)
Returns
string
Theme::get_boxTabsBar (   $tabs,
  $params,
  $mover = '',
  $mout = '',
  $selected = '' 
)

Display box tabs bar.

Parameters
array$tabs
array$params
string$mover
string$mout
string$selected
Returns
string
Theme::get_boxTitleBar (   $title = '')

Display box title bar.

Parameters
string$title
Returns
string
Theme::get_button (   $params,
  $url = '',
  $style = '' 
)

Display button.

Parameters
array$params
string$url
string$style
Returns
string
Theme::get_editor_css ( )

Send editor CSS file to CaMykS.

Returns
void
Theme::get_editorCSSURL ( )

Return editor CSS file URL .

Returns
string
Theme::get_included_main_css ( )

Send main CSS files to CaMykS as included files

Returns
void
Theme::get_included_parts ( )

load theme parts as included file

Returns
void
Theme::get_layeredMenu (   $name,
  $objectname,
  $content 
)

Display layered menu.

Parameters
string$name
string$objectname
array$content
Returns
string
Theme::get_layeredMenuFooter ( )

Display layered menu footer.

Returns
string
Theme::get_layeredMenuHeader (   $name,
  $objectname 
)

Display layered menu header.

Parameters
string$name
string$objectname
Returns
string
Theme::get_layeredMenuLinkItem (   $item = array())

Display layered menu item with link.

Parameters
array$item
Returns
string
Theme::get_layeredMenuNoLinkItem (   $item = array())

Display layered menu item without link.

Parameters
array$item
Returns
string
Theme::get_layeredMenuSeparator ( )

Display layered menu separator.

Returns
string
Theme::get_lightBoxFooter ( )

Display light box footer.

Returns
string
Theme::get_lightBoxHeader (   $style = '')

Display light box header.

Parameters
string$style
Returns
string
Theme::get_main_css ( )

Send main CSS files to CaMykS.

Returns
void
Theme::get_part (   $part,
  $data = array() 
)

Generic part display.

Parameters
string$part
array$data
Returns
string
Theme::get_parts ( )

Load theme parts.

Returns
void
Theme::get_pictHTMLTag (   $params = array())

Return img full tag related to pict.

Parameters
array$params
Returns
string
Theme::get_pictURL (   $item,
  $size = 12,
  $position = 'std' 
)

Return pict URL.

Parameters
string$item
integer$size
string$position
Returns
string
Theme::get_pictURLWithName (   $pict)

Return pict url from full file name.

Parameters
string$pict
Returns
string
Theme::initialise ( )

Initialise theme object.

Returns
void
Theme::initialise_adminMode ( )

Initialise theme object in admin mode.

Returns
void
Theme::Theme (   $name,
  $path_type 
)

Member Data Documentation

string Theme::$autoBoxContent = 'Close'
private
boolean Theme::$isAdminResponsive = false
private

Set isAdminResponsive to default value.

array Theme::$parts = array()

Are parts loaded.

boolean Theme::$partsLoaded = false

Are parts loaded.

array Theme::$responsiveStyles = array()

Define responsiveness of theme.

array Theme::$touchIcons = array()

Define available touch icons.

boolean Theme::$useEnhancedSelectInputs = false

Set useEnhancedSelectInputs to default value.


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