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

Class: BaseW3sLanguageManager

Source Location: /lib/w3studioCmsCore/language/BaseW3sLanguageManager.class.php

Class BaseW3sLanguageManager

Class Overview

w3sLanguageManager extends the functionality of a w3sLanguage object, givin it the ability to add, edit, delete a language.

Located in /lib/w3studioCmsCore/language/BaseW3sLanguageManager.class.php [line 24]



		
				Author(s):
		
		
		API Tags:
Abstract:  

Information Tags:

Properties

Methods

[ Top ]
Property Summary
mixed   $language  

[ Top ]
Method Summary
BaseW3sLanguageManager   __construct()   Constructor.
int   add()   Adds a new language to w3studioCMS
int   delete()   Deletes the current language
bool   deleteRelatedContents()   Deletes the language's contents that belongs to the current language object
int   edit()   Edits an existing language
void   getLanguage()  

[ Top ]
Properties
mixed   $language [line 26]
API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 34]

  BaseW3sLanguageManager __construct( [object The $language = null]  )

Constructor.

Parameters:
object The   $language:  w3sLanguage object. Can be null when adding

API Tags:
Access:  public


[ Top ]
add  [line 54]

  int add( array $params  )

Adds a new language to w3studioCMS

Parameters:
array   $params:  An array with the following options: languageName - The new language's name isMain - 1 to set the new language as main language

API Tags:
Return:  - The result of the add operation
Access:  public


[ Top ]
delete  [line 234]

  int delete( [int $op = 1]  )

Deletes the current language

Parameters:
int   $op:  The value related to the operation to perform.
    1. - Delete content

    API Tags:
    Return:  - The result of the delete operation
    Access:  public


    [ Top ]
    deleteRelatedContents  [line 289]

      bool deleteRelatedContents( [int $op = 1]  )

    Deletes the language's contents that belongs to the current language object

    Parameters:
    int   $op:  The value related to the operation to perform.
      1. - Delete content

      API Tags:
      Return:  false - The save operation failed true - Operation success
      Access:  protected


      [ Top ]
      edit  [line 162]

        int edit( array $params  )

      Edits an existing language

      Parameters:
      array   $params:  An array with the following options: languageName - The new language's name isMain - 1 to set the new language as main language

      API Tags:
      Return:  The result of the edit operation
      Access:  public


      [ Top ]
      getLanguage  [line 39]

        void getLanguage( )


      API Tags:
      Access:  public


      [ Top ]

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