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

Class: BaseW3sContentManagerScript

Source Location: /lib/w3studioCmsCore/content/plugins/BaseW3sContentManagerScript.class.php

Class BaseW3sContentManagerScript

Class Overview

BaseW3sContentManagerScript is the base class to manage a server-side or client-side script content.

Located in /lib/w3studioCmsCore/content/plugins/BaseW3sContentManagerScript.class.php [line 24]

w3sTemplateEngine
   |
   --w3sTemplateEngineEditor
      |
      --w3sContentManager
         |
         --BaseW3sContentManagerScript
Author(s): API Tags:
Abstract:  

Information Tags:

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From w3sContentManager

w3sContentManager::$className
w3sContentManager::$content
w3sContentManager::$defaultInteractiveMenu
w3sContentManager::$defaultParams
w3sContentManager::$errors
w3sContentManager::$exceptionMessage
w3sContentManager::$updateForeigns

Inherited From w3sTemplateEngineEditor

w3sTemplateEngineEditor::$editorEvents
w3sTemplateEngineEditor::$interactiveMenuEvents
w3sTemplateEngineEditor::$interactiveMenus
w3sTemplateEngineEditor::$slotContents
w3sTemplateEngineEditor::$sortables

Inherited From w3sTemplateEngine

w3sTemplateEngine::$idLanguage
w3sTemplateEngine::$idPage
w3sTemplateEngine::$idTemplate
w3sTemplateEngine::$languageName
w3sTemplateEngine::$pageContents
w3sTemplateEngine::$pageName
w3sTemplateEngine::$projectName
w3sTemplateEngine::$templateFileName
w3sTemplateEngine::$templateName

Inherited From w3sContentManager

w3sContentManager::__construct()
Constructor.
w3sContentManager::add()
Adds a content.
w3sContentManager::delete()
Deletes a content. The content will be marked for deletion but it will be really deleted from the database when the pages will be published
w3sContentManager::displayError()
Returns the html error message that corresponds to a predefined error number
w3sContentManager::edit()
Edits a content.
w3sContentManager::formatContent()
The default behaviour of the formatContent function is "Nothing to do", so the content array will be returned untouched .
w3sContentManager::getClassName()
Returns the value of the className variable.
w3sContentManager::getContent()
Returns the value of the content variable.
w3sContentManager::getDefaultInteractiveMenu()
Returns the value of the default interactiveMenu.
w3sContentManager::getDefaultValue()
Returns the default text for the text content
w3sContentManager::getDisplayContentForEditorMode()
Returns the content formatted to be correctly displayed in the editor mode.
w3sContentManager::getDisplayContentForPreviewMode()
Returns the content formatted to be correctly displayed in the preview mode.
w3sContentManager::getDisplayContentForPublishMode()
Returns the content formatted to be correctly displayed in the editor mode.
w3sContentManager::getEditorName()
Returns the name used by the w3sEditorFactory class to render the editor.
w3sContentManager::getExceptionMessage()
Returns the value of the exceptionMessage variable.
w3sContentManager::getInteractiveMenu()
Returns the Interactive Menu used to manage the editor. This gives you a chance to add the reference to javascript editor which manages the content.
w3sContentManager::getRelatedElements()
w3sContentManager::getUpdateForeigns()
Returns the value of the updateForeigns variable.
w3sContentManager::makeSpace()
Makes a space between contents, moving their positions of one unit up or down, according to the op param
w3sContentManager::redraw()
Redraws all the contents that belongs to the current slot.
w3sContentManager::setClassName()
Sets the value of the className variable.
w3sContentManager::setContent()
Sets the value of the content variable.
w3sContentManager::setDefaultInteractiveMenu()
Sets the default interactiveMenu.
w3sContentManager::setDefaultRelatedElements()
w3sContentManager::setExceptionError()
The this->errors' array zero key is reserved for exceptions. Here is filled
w3sContentManager::setExceptionMessage()
Sets the value of the exceptionMessage variable.
w3sContentManager::setMessageErrors()
setMessageErrors. Fills the standard error messages
w3sContentManager::setUpdateForeigns()
Sets the value of the updateForeigns variable.

Inherited From w3sTemplateEngineEditor

w3sTemplateEngineEditor::__construct()
w3sTemplateEngineEditor::drawSlot()
Draws the contents' slot when in editor contents.
w3sTemplateEngineEditor::getEditorEvents()
w3sTemplateEngineEditor::getInteractiveMenuEvents()
w3sTemplateEngineEditor::getInteractiveMenus()
w3sTemplateEngineEditor::getSortables()
w3sTemplateEngineEditor::renderPage()
Overrides the standard function
w3sTemplateEngineEditor::setInteractiveMenu()
w3sTemplateEngineEditor::setInteractiveMenus()
w3sTemplateEngineEditor::setSortables()
Set the sortables for moving contents through the webpage

Inherited From w3sTemplateEngine

w3sTemplateEngine::__construct()
Constructor.
w3sTemplateEngine::drawSlot()
w3sTemplateEngine::findStylesheetClasses()
Returns the available classes for a given slot. Can retrieve only the class name or the full CSS style. This behaviour depend on the mode parameter
w3sTemplateEngine::getIdLanguage()
w3sTemplateEngine::getIdPage()
w3sTemplateEngine::getLanguageName()
w3sTemplateEngine::getPageContents()
w3sTemplateEngine::getPageName()
w3sTemplateEngine::getSlotContents()
Returns the page's contents grouped by slots, retrieved from database
w3sTemplateEngine::getStylesheetsFromContents()
Returns the template's stylesheets
w3sTemplateEngine::getTemplateFile()
Returns the template file path.
w3sTemplateEngine::isPageFree()
Checks if the requested page is not in use from another user, and free the previous page used by current user.
w3sTemplateEngine::removeStylesheetsFromTemplate()
Removes the stylesheets reference from the template
w3sTemplateEngine::renderCopyright()
Renders the W3StudioCMS Copyright button.
w3sTemplateEngine::renderPage()
Renders the page
w3sTemplateEngine::retrieveSiteStylesheets()
Reads all the site's template files and extracts the stylesheets' references.
w3sTemplateEngine::retrieveTemplateAttributesFromPage()
Retrieves from an instance of the page object the informations about the template used in the current page.
w3sTemplateEngine::retrieveTemplateStylesheets()
Retrieves the stylesheets used by the current template. The result string will be uses to change the template's stylesheet.
w3sTemplateEngine::setCurrentTemplate()
Retrieves from the database the template associated to page requested
w3sTemplateEngine::setIdLanguage()
w3sTemplateEngine::setIdPage()
w3sTemplateEngine::setTemplateInfo()

[ Top ]
Method Summary
void   formatContent()   Add backslash character (\) before every character that is among these:
string   getDefaultValue()   Returns the default text for the text content
string   getDisplayContentForEditorMode()   Returns the content formatted to be correctly displayed in the editor mode.
string   getDisplayContentForPreviewMode()   Returns the content formatted to be correctly displayed in the preview mode.
void   getDisplayContentForPublishMode()   Strip slashes before publishing content.
void   getInteractiveMenu()  
void   processPhpScript()  

[ Top ]
Methods
formatContent  [line 89]

  void formatContent( $contentValues  )

Add backslash character (\) before every character that is among these:

. \ + * ? [ ^ ] ( $ )

Parameters:
   $contentValues: 

API Tags:
See:  w3sContentManager::formatContent()
Access:  protected


Redefinition of:
w3sContentManager::formatContent()
The default behaviour of the formatContent function is "Nothing to do", so the content array will be returned untouched .

[ Top ]
getDefaultValue  [line 33]

  string getDefaultValue( )

Returns the default text for the text content


API Tags:
Access:  public


Redefinition of:
w3sContentManager::getDefaultValue()
Returns the default text for the text content

[ Top ]
getDisplayContentForEditorMode  [line 50]

  string getDisplayContentForEditorMode( )

Returns the content formatted to be correctly displayed in the editor mode.


API Tags:
Access:  public


Redefinition of:
w3sContentManager::getDisplayContentForEditorMode()
Returns the content formatted to be correctly displayed in the editor mode.

[ Top ]
getDisplayContentForPreviewMode  [line 61]

  string getDisplayContentForPreviewMode( )

Returns the content formatted to be correctly displayed in the preview mode.


API Tags:
Access:  public


Redefinition of:
w3sContentManager::getDisplayContentForPreviewMode()
Returns the content formatted to be correctly displayed in the preview mode.

[ Top ]
getDisplayContentForPublishMode  [line 77]

  void getDisplayContentForPublishMode( )

Strip slashes before publishing content.


API Tags:
See:  w3sContentManager::getDisplayContentForPublishMode()
Access:  public


Redefinition of:
w3sContentManager::getDisplayContentForPublishMode()
Returns the content formatted to be correctly displayed in the editor mode.

[ Top ]
getInteractiveMenu  [line 38]

  void getInteractiveMenu( )


API Tags:
Access:  public


Redefinition of:
w3sContentManager::getInteractiveMenu()
Returns the Interactive Menu used to manage the editor. This gives you a chance to add the reference to javascript editor which manages the content.

[ Top ]
processPhpScript  [line 96]

  void processPhpScript( $content  )

Parameters:
   $content: 

API Tags:
Access:  protected


[ Top ]

Documentation generated on Tue, 11 Aug 2009 14:52:49 +0200 by phpDocumentor 1.4.0