phpDocumentor sfW3studioCMSPlugin
BaseW3sThemeManager
[ class tree: sfW3studioCMSPlugin ] [ index: sfW3studioCMSPlugin ] [ all elements ]

Class: BaseW3sThemeManager

Source Location: /lib/w3studioCmsCore/editor/plugins/BaseW3sThemeManager.php

Class BaseW3sThemeManager

Class Overview

Implements interfaces:

BaseW3sThemeManager is the base class that renders the interface to manage website's themes.

Located in /lib/w3studioCmsCore/editor/plugins/BaseW3sThemeManager.php [line 24]



		
				Author(s):
		
		
		API Tags:
Abstract:  

Information Tags:

Properties

Methods

[ Top ]
Property Summary
mixed   $defaultInfo  
mixed   $interfaceSkeleton  
mixed   $themes  

[ Top ]
Method Summary
Bool   add()   Adds the theme to database after it has been loaded and makes it available to be used.
void   drawThemeRow()  
String   drawThemes()   Draws all the loaded themes readed from the themes folder
void   drawToolbar()  
void   getSlotsFromTemplate()  
Array   publishAssets()   Publishes Web Assets for third party themes. Originally written to be used in tasks only, readapted to be used in whole application
void   remove()  
string   render()   Renders the editor
void   scanTheme()  
void   setDefaultInfo()   Sets the related theme info.
string   unpublishAsset()   Publishes Web Assets for third party themes. Originally written to be used in tasks only, readapted to be used in whole application

[ Top ]
Properties
mixed   $defaultInfo = array("Author" => '', "License" => '') [line 36]
API Tags:
Access:  protected


[ Top ]
mixed   $interfaceSkeleton =
'<div id="%s">
<table style="width:100%%">
<tr><td><div class="w3s_toolbar"><table>%s</table></div></td></tr>
<tr><td id="w3s_template_import_contents" valign="top">%s</td></tr>
<input type="submit" id="w3s_uploader_support" onclick="W3sThemeManager.extract(); return false;" />
</table>
</div>'
[line 27]
API Tags:
Access:  protected


[ Top ]
mixed   $themes = array() [line 35]
API Tags:
Access:  protected


[ Top ]
Methods
add  [line 180]

  Bool add( $themeName  )

Adds the theme to database after it has been loaded and makes it available to be used.

Parameters:
   $themeName: 

API Tags:
Return:  - 0: Failure 1: Success 2: Template folder does not exists
Access:  public


[ Top ]
drawThemeRow  [line 272]

  void drawThemeRow( $themeName, $exists  )

Parameters:
   $themeName: 
   $exists: 

API Tags:
Access:  protected


[ Top ]
drawThemes  [line 150]

  String drawThemes( )

Draws all the loaded themes readed from the themes folder


API Tags:
Return:  - The html table with drawed themes
Access:  public

Information Tags:
Author:  Giansimon Diblas <giansimon.diblas@w3studiocms.com>

[ Top ]
drawToolbar  [line 262]

  void drawToolbar( )


API Tags:
Access:  protected


[ Top ]
getSlotsFromTemplate  [line 338]

  void getSlotsFromTemplate( $themeName, $templateName  )

Parameters:
   $themeName: 
   $templateName: 

API Tags:
Access:  protected


[ Top ]
publishAssets  [line 83]

  Array publishAssets( [Array $arguments = array()], [Array $options = array()]  )

Publishes Web Assets for third party themes. Originally written to be used in tasks only, readapted to be used in whole application

Parameters:
Array   $arguments: 
Array   $options: 

API Tags:
Return:  - Contains the description of the generated assets publishing events
Access:  public

Information Tags:
Author:  Yevgeniy Viktorov <wik@osmonitoring.com> Giansimon Diblas <giansimon.diblas@w3studiocms.com>

[ Top ]
remove  [line 249]

  void remove( $themeName  )

Parameters:
   $themeName: 

API Tags:
Access:  public


[ Top ]
render  [line 44]

  string render( )

Renders the editor


API Tags:
Access:  public


Implementation of:
w3sEditor::render()

[ Top ]
scanTheme  [line 313]

  void scanTheme( $themeName  )

Parameters:
   $themeName: 

API Tags:
Access:  protected


[ Top ]
setDefaultInfo  [line 57]

  void setDefaultInfo( [string $param = null]  )

Sets the related theme info.

Parameters:
string   $param: 

API Tags:
Access:  public


[ Top ]
unpublishAsset  [line 127]

  string unpublishAsset( String $param, [Object $filesystem = null]  )

Publishes Web Assets for third party themes. Originally written to be used in tasks only, readapted to be used in whole application

Parameters:
String   $param:  - Theme name
Object   $filesystem:  - A filesystem object

API Tags:
Return:  - Contain the description of the generated assets publishing events
Access:  public

Information Tags:
Author:  Yevgeniy Viktorov <wik@osmonitoring.com> Giansimon Diblas <giansimon.diblas@w3studiocms.com>

[ Top ]

Documentation generated on Tue, 11 Aug 2009 14:53:36 +0200 by phpDocumentor 1.4.0