Mage_Sendfriend_Model_Sendfriend Class Reference

Inheritance diagram for Mage_Sendfriend_Model_Sendfriend:

List of all members.

Public Member Functions
	toOptionArray ()
	send ()
	validate ()
	setIp ($ip)
	setRecipients ($recipients)
	setProduct ($product)
	setSender ($sender)
	getSendCount ($ip, $startTime)
	getMaxSendsToFriend ()
	getTemplate ()
	getMaxRecipients ()
	canEmailToFriend ()
	register ()
Public Attributes
const	XML_PATH_SENDFRIEND_EMAIL_TEMPLATE = 'sendfriend/email/template'
Protected Member Functions
	_construct ()
Protected Attributes
	$_names = array()
	$_emails = array()
	$_sender = array()
	$_ip = 0
	$_product = null
	$_period = 3600
	$_cookieName = 'stf'

---

Detailed Description

Definition at line 27 of file Sendfriend.php.

---

Member Function Documentation

_construct

(

)

[protected]

Enter description here...

Reimplemented from Varien_Object.

Definition at line 44 of file Sendfriend.php.

    {
        $this->_init('sendfriend/sendfriend');
    }

canEmailToFriend

(

)

Check if user is allowed to email product to a friend

Returns:

boolean

Definition at line 220 of file Sendfriend.php.

    {
        if (!Mage::getStoreConfig('sendfriend/email/enabled')) {
            return false;
        }
        if (!Mage::getStoreConfig('sendfriend/email/allow_guest')
            && !Mage::getSingleton('customer/session')->isLoggedIn()) {
            return false;
        }
        return true;
    }

getMaxRecipients

(

)

Get max allowed recipients for "Send to a Friend" function

Returns:

integer

Definition at line 210 of file Sendfriend.php.

    {
        return max(0, (int) Mage::getStoreConfig('sendfriend/email/max_recipients'));
    }

getMaxSendsToFriend

(

)

Get max allowed uses of "Send to Friend" function per hour

Returns:

integer

Definition at line 190 of file Sendfriend.php.

    {
        return max(0, (int) Mage::getStoreConfig('sendfriend/email/max_per_hour'));
    }

getSendCount	(	$	ip,
		$	startTime
	)

Definition at line 179 of file Sendfriend.php.

    {
        $count = $this->_getResource()->getSendCount($this, $ip, $startTime);
        return $count;
    }

getTemplate

(

)

Get current "Send to friend" template

Returns:

string

Definition at line 200 of file Sendfriend.php.

    {
        return Mage::getStoreConfig('sendfriend/email/template');
    }

register

(

)

Check and register object

Returns:

Mage_Sendfriend_Model_Sendfriend

Definition at line 302 of file Sendfriend.php.

    {
        if (!Mage::registry('send_to_friend_model')) {
            Mage::register('send_to_friend_model', $this);
        }
        return $this;
    }

send

(

)

Definition at line 62 of file Sendfriend.php.

    {
        $translate = Mage::getSingleton('core/translate');
        /* @var $translate Mage_Core_Model_Translate */
        $translate->setTranslateInline(false);

        $errors = array();

        $this->_emailModel = Mage::getModel('core/email_template');
        $message = nl2br(htmlspecialchars($this->_sender['message']));
        $sender  = array(
            'name' => strip_tags($this->_sender['name']),
            'email' => strip_tags($this->_sender['email'])
            );

        foreach($this->_emails as $key => $email) {
            $this->_emailModel->setDesignConfig(array('area'=>'frontend', 'store'=>$this->getStoreId()))
            ->sendTransactional(
                Mage::getStoreConfig(self::XML_PATH_SENDFRIEND_EMAIL_TEMPLATE),
                $sender,
                $email,
                $this->_names[$key],
                array(
                    'name'          => $this->_names[$key],
                    'email'         => $email,
                    'product_name'  => $this->_product->getName(),
                    'product_url'   => $this->_product->getProductUrl(),
                    'message'       => $message,
                    'sender_name'   => strip_tags($this->_sender['name']),
                    'sender_email'  => strip_tags($this->_sender['email']),
                    'product_image' => Mage::helper('catalog/image')->init($this->_product, 'small_image')->resize(75),
                )
            );
        }

        $translate->setTranslateInline(true);

        return $this;
    }

setIp

(

$

ip

)

Definition at line 160 of file Sendfriend.php.

    {
        $this->_ip = $ip;
    }

setProduct

(

$

product

)

Definition at line 171 of file Sendfriend.php.

                                        {
        $this->_product = $product;
    }

setRecipients

(

$

recipients

)

Definition at line 165 of file Sendfriend.php.

    {
        $this->_emails = array_unique($recipients['email']);
        $this->_names = $recipients['name'];
    }

setSender

(

$

sender

)

Definition at line 175 of file Sendfriend.php.

                                      {
        $this->_sender = $sender;
    }

toOptionArray

(

)

Definition at line 49 of file Sendfriend.php.

    {
        if(!$collection = Mage::registry('config_system_email_template')) {
            $collection = Mage::getResourceModel('core/email_template_collection')
                ->load();

            Mage::register('config_system_email_template', $collection);
        }
        $options = $collection->toOptionArray();
        array_unshift($options, array('value'=>'', 'label'=>''));
        return $options;
    }

validate

(

)

Definition at line 102 of file Sendfriend.php.

    {
        $errors = array();
        $helper = Mage::helper('sendfriend');

        if (empty($this->_sender['name'])) {
            $errors[] = $helper->__('Sender name can\'t be empty');
        }

        if (!isset($this->_sender['email']) || !Zend_Validate::is($this->_sender['email'], 'EmailAddress')) {
            $errors[] = $helper->__('Invalid sender email');
        }

        if (empty($this->_sender['message'])) {
            $errors[] = $helper->__('Message can\'t be empty');
        }

        foreach ($this->_emails as $email) {
            if (!Zend_Validate::is($email, 'EmailAddress')) {
                $errors[] = $helper->__('You input invalid email address for recipient');
                break;
            }
        }

        if (!$this->canEmailToFriend()) {
            $errors[] = $helper->__('You cannot email this product to a friend');
        }

        if ($this->_getSendToFriendCheckType()) {
            $amount = $this->_amountByCookies();
        } else {
            $amount = $this->_amountByIp();
        }

        if ($amount >= $this->getMaxSendsToFriend()){
            $errors[] = $helper->__('You have exceeded limit of %d sends in an hour', $this->getMaxSendsToFriend());
        }

        $maxRecipients = $this->getMaxRecipients();
        if (count($this->_emails) > $maxRecipients) {
            $errors[] = $helper->__('You cannot send more than %d emails at a time', $this->getMaxRecipients());
        }

        if (count($this->_emails) < 1) {
            $errors[] = $helper->__('You have to specify at least one recipient');
        }

        if (!$this->getTemplate()){
            $errors[] = $helper->__('Email template is not specified by administrator');
        }


        if (empty($errors)) {
            return true;
        }
        return $errors;
    }

---

Member Data Documentation

$_cookieName = 'stf' [protected]

Definition at line 42 of file Sendfriend.php.

$_emails = array() [protected]

Definition at line 35 of file Sendfriend.php.

$_ip = 0 [protected]

Definition at line 37 of file Sendfriend.php.

$_names = array() [protected]

Definition at line 34 of file Sendfriend.php.

$_period = 3600 [protected]

Definition at line 40 of file Sendfriend.php.

$_product = null [protected]

Definition at line 38 of file Sendfriend.php.

$_sender = array() [protected]

Definition at line 36 of file Sendfriend.php.

const XML_PATH_SENDFRIEND_EMAIL_TEMPLATE = 'sendfriend/email/template'

XML configuration paths

Definition at line 32 of file Sendfriend.php.

---

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

• app/code/core/Mage/Sendfriend/Model/Sendfriend.php