IP.Board  3.3.0
usercpForms_gallery Class Reference
Inheritance diagram for usercpForms_gallery:
public_core_usercp_manualResolver interface_usercp ipsCommand

Public Member Functions

 getLinks ()
 init ()
 runCustomEvent ($currentArea)
 saveForm ($current_area)
 showAlbumListing ()
 showForm ($current_area, $errors=array())

Data Fields

 $defaultAreaCode = 'albums'
 $hide_form_and_save_button = true
 $ok_message = ''
 $tab_name = ''
 $uploadFormMax = 0
 $version = 32

Member Function Documentation

getLinks ( )

Return links for this tab You may return an empty array or FALSE to not have any links show in the tab.

The links must have 'area=xxxxx'. The rest of the URL is added automatically. 'area' can only be a-z A-Z 0-9 - _

Returns:
array Array of menu links

Implements interface_usercp.

init ( )

Initiate this module

Returns:
void

Implements interface_usercp.

runCustomEvent ( currentArea)

Run custom event

If you pass a 'do' in the URL / post form that is not either: save / save_form or show / show_form then this function is loaded instead. You can return a HTML chunk to be used in the UserCP (the tabs and footer are auto loaded) or redirect to a link.

If you are returning HTML, you can use $this->hide_form_and_save_button = 1; to remove the form and save button that is automatically placed there.

Parameters:
string$currentAreaCurrent 'area' variable (area=xxxx from the URL)
Returns:
mixed html or void

Implements interface_usercp.

saveForm ( current_area)

UserCP Form Check

Parameters:
string$current_areaCurrent area as defined by 'get_links'
Returns:
string Processed HTML

Implements interface_usercp.

Builds list of albums

Returns:
string
showForm ( current_area,
errors = array() 
)

UserCP Form Show

Parameters:
string$current_areaCurrent area as defined by 'get_links'
array$errorsErrors found
Returns:
string Processed HTML

Implements interface_usercp.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables