Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes

BeHashComponent Class Reference

General BEdita hash component. More...

List of all members.

Public Member Functions

 startup (&$controller=null)
 startup component
 handleHash ($service_type, $hash=null)
 handle hash request like newsletter/frontend subscribe/unsubscribe
 getHashRow ($hash)
 get hash_jobs row

Public Attributes

 $components = array("BeMail")
 $closeHashJob = true

Protected Member Functions

 userSignUp ($data)
 user sign up registration
 userSignUpActivation ($data)
 Signup activation for user.
 newsletterSubscribe ($data)
 subscribe to a newsletter
 newsletterSubscribeConfirm ($data)
 confirm subscription to a newsletter
 newsletterUnsubscribe ($data)
 unsubscribe from a newsletter
 newsletterUnsubscribeConfirm ($data)
 Confirm newsletter unsubscribe.
 recoverPassword ($data)
 recover password.
 recoverPasswordChange ($data)
 Recover password.
 sendNotificationMail (array $mailParams)
 Send notification email.
 loadMessages ()
 Load messages: 1.
 getNotifyText ($msgType, $field)
 get message (in current lang, if present translation)
 replacePlaceHolder ($text, array &$params)
 replace place holder

Protected Attributes

 $controller
 $notifyMsg = null

Detailed Description

General BEdita hash component.

Version:

$Id: be_newsletter.php

Definition at line 31 of file be_hash.php.


Member Function Documentation

BeHashComponent::getHashRow ( hash  ) 

get hash_jobs row

Parameters:
string $hash
Returns:
array HashJob row

Definition at line 149 of file be_hash.php.

Referenced by handleHash().

BeHashComponent::getNotifyText ( msgType,
field 
) [protected]

get message (in current lang, if present translation)

Parameters:
string $msgType
string $field
Returns:
string

Definition at line 838 of file be_hash.php.

BeHashComponent::handleHash ( service_type,
hash = null 
)

handle hash request like newsletter/frontend subscribe/unsubscribe

Parameters:
string $service_type
string $hash
Returns:
boolean
Exceptions:
BeditaException 
BeditaHashException 

Definition at line 79 of file be_hash.php.

References getHashRow().

BeHashComponent::loadMessages (  )  [protected]

Load messages: 1.

default messages 2. local unversioned instance messages 3. frontend messages (if frontend app)

Definition at line 810 of file be_hash.php.

Referenced by startup().

BeHashComponent::newsletterSubscribe ( data  )  [protected]

subscribe to a newsletter

Parameters:
array $data
Returns:
array
Exceptions:
BeditaHashException 
BeditaException 

Definition at line 350 of file be_hash.php.

BeHashComponent::newsletterSubscribeConfirm ( data  )  [protected]

confirm subscription to a newsletter

Parameters:
array $data
Returns:
array
Exceptions:
BeditaHashException 
BeditaException 

Definition at line 475 of file be_hash.php.

BeHashComponent::newsletterUnsubscribe ( data  )  [protected]

unsubscribe from a newsletter

Parameters:
array $data
Returns:
array
Exceptions:
BeditaHashException 
BeditaException 

Definition at line 540 of file be_hash.php.

BeHashComponent::newsletterUnsubscribeConfirm ( data  )  [protected]

Confirm newsletter unsubscribe.

Parameters:
array $data
Returns:
array
Exceptions:
BeditaHashException 
BeditaException 

Definition at line 615 of file be_hash.php.

BeHashComponent::recoverPassword ( data  )  [protected]

recover password.

Send an email with hash to reset password

Parameters:
array $data
Returns:
array mail params
Exceptions:
BeditaHashException 
BeditaException 

Definition at line 669 of file be_hash.php.

BeHashComponent::recoverPasswordChange ( data  )  [protected]

Recover password.

Parameters:
array $data
Returns:
array
Exceptions:
BeditaHashException 

Definition at line 734 of file be_hash.php.

BeHashComponent::replacePlaceHolder ( text,
array &$  params 
) [protected]

replace place holder

Parameters:
unknown_type $text
array $params
Returns:
string

Definition at line 854 of file be_hash.php.

BeHashComponent::sendNotificationMail ( array $  mailParams  )  [protected]

Send notification email.

Parameters:
array $mailParams

Definition at line 785 of file be_hash.php.

BeHashComponent::startup ( &$  controller = null  ) 

startup component

Parameters:
Controller $controller

Definition at line 64 of file be_hash.php.

References loadMessages().

BeHashComponent::userSignUp ( data  )  [protected]

user sign up registration

Parameters:
array $data
Returns:
array
Exceptions:
BeditaHashException 
BeditaException 

Definition at line 175 of file be_hash.php.

BeHashComponent::userSignUpActivation ( data  )  [protected]

Signup activation for user.

Parameters:
array $data
Returns:
array
Exceptions:
BeditaHashException 
BeditaException 

Definition at line 301 of file be_hash.php.


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:46 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus