Public Member Functions | Protected Member Functions | Protected Attributes

Invite Class Reference

Inheritance diagram for Invite:
Collaboration diagram for Invite:

List of all members.

Public Member Functions

 render ()
 send ()
 setInviteData ($oData)
 getInviteData ()
 getCaptcha ()

Protected Member Functions

 _updateStatistics ($sUserId, $aRecEmail)

Protected Attributes

 $_sThisTemplate = 'invite.tpl'
 $_aReqFields = array( 'rec_email', 'send_name', 'send_email', 'send_message', 'send_subject' )
 $_oCrossSelling = null
 $_oSimilarProducts = null
 $_oRecommList = null
 $_aInviteData = null
 $_oCaptcha = null
 $_iMailStatus = null

Detailed Description

Article suggestion page. Collects some article base information, sets default recomendation text, sends suggestion mail to user.

Definition at line 8 of file invite.php.


Member Function Documentation

Invite._updateStatistics ( sUserId,
aRecEmail 
) [protected]

Updating invitations statistics

Parameters:
string $sUserId ID of user, who sents invitation
array $aRecEmail array of recipients emails
Returns:
null

Definition at line 225 of file invite.php.

Invite.getCaptcha (  ) 

Template variable getter. Returns object of handling CAPTCHA image

Returns:
object

Definition at line 209 of file invite.php.

Invite.getInviteData (  ) 

Template variable getter.

Returns:
array

Definition at line 199 of file invite.php.

Invite.render (  ) 

Loads and passes article and related info to template engine (oxarticle.getReviews(), oxarticle.getCrossSelling(), oxarticle.GetSimilarProducts()), executes parent.render() and returns template file name to render suggest._sThisTemplate.

Template variables: product, reviews, crossselllist, similarlist

Returns:
string current template file name

Reimplemented from oxUBase.

Definition at line 71 of file invite.php.

Invite.send (  ) 

Sends product suggestion mail and returns a URL according to URL formatting rules.

Template variables: editval, error

Returns:
null

Definition at line 97 of file invite.php.

Invite.setInviteData ( oData  ) 

Suggest data setter

Parameters:
object $oData suggest data object
Returns:
null

Definition at line 189 of file invite.php.


Member Data Documentation

Invite.$_aInviteData = null [protected]

Definition at line 44 of file invite.php.

Invite.$_aReqFields = array( 'rec_email', 'send_name', 'send_email', 'send_message', 'send_subject' ) [protected]

Definition at line 20 of file invite.php.

Invite.$_iMailStatus = null [protected]

Definition at line 56 of file invite.php.

Invite.$_oCaptcha = null [protected]

Definition at line 50 of file invite.php.

Invite.$_oCrossSelling = null [protected]

Definition at line 26 of file invite.php.

Invite.$_oRecommList = null [protected]

Definition at line 38 of file invite.php.

Invite.$_oSimilarProducts = null [protected]

Definition at line 32 of file invite.php.

Invite.$_sThisTemplate = 'invite.tpl' [protected]

Reimplemented from oxView.

Definition at line 14 of file invite.php.


The documentation for this class was generated from the following file: