content to display a navigation menu used to move though languages on a multi-languages web site. It already extends the w3sContentManager, so if a new object to manage this kind of content is required, it should inherit from this class.

Located in /lib/w3studioCmsCore/content/w3sContentManagerLanguagesMenu.class.php [line 27]

w3sTemplateEngine
   |
   --w3sTemplateEngineEditor
      |
      --w3sContentManager
         |
         --w3sContentManagerLanguagesMenu

Author(s):

Giansimon Diblas <giansimon.diblas@w3studiocms.com>

API Tags:

Abstract:

Information Tags:

Methods

[ Top ]

Descendants

Child Class	Description
BaseW3sContentManagerLanguagesMenuImages	BaseW3sContentManagerLanguagesMenuImages is the base class to manage an imaged navigation menu to move through languages on multi-languages sites.
BaseW3sContentManagerLanguagesMenuTextual	BaseW3sContentManagerLanguagesMenuTextual is the base class to manage a textual navigation menu to move through languages on multi-languages sites.

[ 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	drawMenu()
array	formatContent()	Format the content to display the navigation menu on the web page.
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	getInteractiveMenu()	Returns the interactive menu for this content
array	setParamsToArray()	Format the content to display the navigation menu on the web page.

[ Top ]

Properties

Methods

drawMenu [line 30]

void drawMenu(

$contentValues 
)

Parameters:

$contentValues:

API Tags:

Abstract:

Redefined in descendants as:

BaseW3sContentManagerLanguagesMenuImages::drawMenu() : Draws the languages' table as a horizontal toolbar. This function assumes that every image that represents a language has the same name of the language. Override this function if you want to change this behaviour
BaseW3sContentManagerLanguagesMenuTextual::drawMenu() : Draws the languages' table as a horizontal toolbar. This function assumes that every image that represents a language has the same name of the language. Override this function if you want to change this behaviour

[ Top ]

formatContent [line 74]

array formatContent(
array
$contentValues 
)

Format the content to display the navigation menu on the web page.

Parameters:

array

$contentValues:

The array with contents.

API Tags:

Return:	The array with contents formatted.
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 38]

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 49]

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 ]

getInteractiveMenu [line 60]

string getInteractiveMenu(
)

Returns the interactive menu for this content

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 ]

setParamsToArray [line 88]

array setParamsToArray(
array
$params 
)

Format the content to display the navigation menu on the web page.

Parameters:

array

$params:

The array with contents.

API Tags:

Return:	The array with contents formatted.
Access:	protected

[ Top ]

Documentation generated on Tue, 11 Aug 2009 14:54:01 +0200 by phpDocumentor 1.4.0

	sfW3studioCMSPlugin w3sContentManagerLanguagesMenu

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