Class: IcmsPersistableController

Source Location: /kernel/icmspersistablecontroller.php

Class IcmsPersistableController

Property Summary
mixed   $handler  

[ Top ]
Method Summary
IcmsPersistableController   IcmsPersistableController()  
void   &doStoreFromDefaultForm()  
string   getAdminViewItemLink()   Retreive the object admin side link for a IcmsPersistableSingleView page
void   getDeleteItemLink()  
void   getEditItemLink()  
void   getEditLanguageLink()  
string   getItemLink()   Retreive the object user side link
void   getModuleItemString()  
void   getPrintAndMailLink()  
string   getViewItemLink()   This method returns a view link of the Object
bool   handleObjectDeletion()   Handles deletion of an object which keyid is passed as a GET param
void   handleObjectDeletionFromUserSide()  
void   postDataToObject()  
bool   &storeFromDefaultForm()   Store the object in the database autmatically from a form sending POST data
void   &storeIcmsPersistableObject()  
void   &storeIcmsPersistableObjectD()  

[ Top ]
Properties
mixed   $handler [line 21]

[ Top ]
Methods
Constructor IcmsPersistableController  [line 22]

  IcmsPersistableController IcmsPersistableController( $handler  )

Parameters:
   $handler: 


[ Top ]
doStoreFromDefaultForm  [line 108]

  void &doStoreFromDefaultForm( &$icmsObj, $objectid, $created_success_msg, $modified_success_msg, [ $redirect_page = false], [ $debug = false]  )

Parameters:
   &$icmsObj: 
   $objectid: 
   $created_success_msg: 
   $modified_success_msg: 
   $redirect_page: 
   $debug: 


[ Top ]
getAdminViewItemLink  [line 369]

  string getAdminViewItemLink( object $icmsObj, [bool $onlyUrl = false], [ $withimage = false]  )

Retreive the object admin side link for a IcmsPersistableSingleView page

Parameters:
object   $icmsObj:  reference to the object from which we want the user side link
bool   $onlyUrl:  wether or not to return a simple URL or a full <a> link
   $withimage: 

API Tags:
Return:  admin side link to the object


[ Top ]
getDeleteItemLink  [line 482]

  void getDeleteItemLink( $icmsObj, [ $onlyUrl = false], [ $withimage = true], [ $userSide = false]  )

Parameters:
   $icmsObj: 
   $onlyUrl: 
   $withimage: 
   $userSide: 


[ Top ]
getEditItemLink  [line 459]

  void getEditItemLink( $icmsObj, [ $onlyUrl = false], [ $withimage = true], [ $userSide = false]  )

Parameters:
   $icmsObj: 
   $onlyUrl: 
   $withimage: 
   $userSide: 


[ Top ]
getEditLanguageLink  [line 446]

  void getEditLanguageLink( $icmsObj, [ $onlyUrl = false], [ $withimage = true]  )

Parameters:
   $icmsObj: 
   $onlyUrl: 
   $withimage: 


[ Top ]
getItemLink  [line 389]

  string getItemLink( &$icmsObj, [bool $onlyUrl = false], object $icmsObj  )

Retreive the object user side link

Parameters:
object   $icmsObj:  reference to the object from which we want the user side link
bool   $onlyUrl:  wether or not to return a simple URL or a full <a> link
   &$icmsObj: 

API Tags:
Return:  user side link to the object


[ Top ]
getModuleItemString  [line 526]

  void getModuleItemString( )



[ Top ]
getPrintAndMailLink  [line 505]

  void getPrintAndMailLink( $icmsObj  )

Parameters:
   $icmsObj: 


[ Top ]
getViewItemLink  [line 428]

  string getViewItemLink( IcmsPersistableObject $icmsObj, [boolean $onlyUrl = false], [boolean $withimage = true], [boolean $userSide = false]  )

This method returns a view link of the Object

Parameters:
IcmsPersistableObject   $icmsObj: 
boolean   $onlyUrl: 
boolean   $withimage: 
boolean   $userSide: 

API Tags:
Access:  public


[ Top ]
handleObjectDeletion  [line 282]

  bool handleObjectDeletion( [ $confirm_msg = false], [ $op = 'del'], [ $userSide = false], string $redir_page  )

Handles deletion of an object which keyid is passed as a GET param

Parameters:
string   $redir_page:  redirect page after deleting the object
   $confirm_msg: 
   $op: 
   $userSide: 


[ Top ]
handleObjectDeletionFromUserSide  [line 329]

  void handleObjectDeletionFromUserSide( [ $confirm_msg = false], [ $op = 'del']  )

Parameters:
   $confirm_msg: 
   $op: 


[ Top ]
postDataToObject  [line 26]

  void postDataToObject( &$icmsObj  )

Parameters:
   &$icmsObj: 


[ Top ]
storeFromDefaultForm  [line 214]

  bool &storeFromDefaultForm( string $created_success_msg, string $modified_success_msg, [string $redirect_page = false], [ $debug = false], [ $x_param = false], string $created_redir_page, string $modified_redir_page, bool $exit  )

Store the object in the database autmatically from a form sending POST data

Parameters:
string   $created_success_msg:  message to display if new object was created
string   $modified_success_msg:  message to display if object was successfully edited
string   $created_redir_page:  redirect page after creating the object
string   $modified_redir_page:  redirect page after editing the object
string   $redirect_page:  redirect page, if not set, then we backup once
bool   $exit:  if set to TRUE then the script ends
   $debug: 
   $x_param: 


[ Top ]
storeIcmsPersistableObject  [line 269]

  void &storeIcmsPersistableObject( [ $debug = false], [ $xparam = false]  )

Parameters:
   $debug: 
   $xparam: 


[ Top ]
storeIcmsPersistableObjectD  [line 265]

  void &storeIcmsPersistableObjectD( )



[ Top ]

Documentation generated on Sat, 12 Dec 2009 21:21:12 -0600 by phpDocumentor 1.4.1