phpDocumentor MultiLang
Classes
[ class tree: MultiLang ] [ index: MultiLang ] [ all elements ]

Class: MultiLangHelper

Source Location: /modules/multilang/classes/MultiLangHelper.class

Class MultiLangHelper

Class Overview

A helper class for the MultiLang module.

Located in /modules/multilang/classes/MultiLangHelper.class [line 35]



		
		
		
		

Methods

[ Top ]
Method Summary
array   getItemData()   Get language data for an item
GalleryStatus   onLoad()   Update item with data for the current language, if available
GalleryStatus   setItemData()   Set language data for an item, or remove data if all text parameters are empty

[ Top ]
Methods
getItemData  [line 44]

  array getItemData( int $itemId  )

Get language data for an item

Parameters:
int   $itemId: 

API Tags:
Return:  GalleryStatus a status code array (language => array data, ..)


[ Top ]
onLoad  [line 161]

  GalleryStatus onLoad( &$item, GalleryItem $item  )

Update item with data for the current language, if available

Parameters:
GalleryItem   $item: 
   &$item: 

API Tags:
Return:  a status code


[ Top ]
setItemData  [line 70]

  GalleryStatus setItemData( GalleryItem $item, string $language, [string $title = null], [string $summary = null], [string $description = null]  )

Set language data for an item, or remove data if all text parameters are empty

Parameters:
GalleryItem   $item: 
string   $language: 
string   $title:  (optional)
string   $summary:  (optional)
string   $description:  (optional)

API Tags:
Return:  a status code


[ Top ]

Documentation generated on Fri, 08 Oct 2010 05:40:57 -0700 by phpDocumentor 1.3.0RC6