Class Mage_Sendfriend_Model_Sendfriend

SendFriend Log

Varien_Object

Mage_Sendfriend_Model_Sendfriend

Package: Mage\Sendfriend
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sendfriend/Model/Sendfriend.php

Methods summary
`protected`	# `_construct( )` Initialize resource model Initialize resource model
`protected Mage_Sendfriend_Helper_Data`	# `_getHelper( )` Retrieve Data Helper Retrieve Data Helper Returns `Mage_Sendfriend_Helper_Data`
`public`	# `send( )`
`public boolean\|array`	# `validate( )` Validate Form data Validate Form data Returns `boolean\|array`
`public Mage_Sendfriend_Model_Sendfriend`	# `setCookie( Mage_Core_Model_Cookie $cookie )` Set cookie instance Set cookie instance Parameters `$cookie` `Mage_Core_Model_Cookie` $product Returns `Mage_Sendfriend_Model_Sendfriend`
`public Mage_Core_Model_Cookie`	# `getCookie( )` Retrieve Cookie instance Retrieve Cookie instance Returns `Mage_Core_Model_Cookie` Throws `Mage_Core_Exception`
`public Mage_Sendfriend_Model_Sendfriend`	# `setRemoteAddr( integer $ipAddr )` Set Visitor Remote Address Set Visitor Remote Address Parameters `$ipAddr` `integer` $ipAddr the IP address on Long Format Returns `Mage_Sendfriend_Model_Sendfriend`
`public integer`	# `getRemoteAddr( )` Retrieve Visitor Remote Address Retrieve Visitor Remote Address Returns `integer`
`public Mage_Sendfriend_Model_Sendfriend`	# `setWebsiteId( integer $id )` Set Website Id Set Website Id Parameters `$id` `integer` $id - website id Returns `Mage_Sendfriend_Model_Sendfriend`
`public integer`	# `getWebsiteId( )` Retrieve Website Id Retrieve Website Id Returns `integer`
`public Mage_Sendfriend_Model_Sendfriend`	# `setRecipients( array $recipients )` Set Recipients Set Recipients Parameters `$recipients` `array` $recipients Returns `Mage_Sendfriend_Model_Sendfriend`
`public Varien_Object`	# `getRecipients( )` Retrieve Recipients object Retrieve Recipients object Returns `Varien_Object`
`public Mage_Sendfriend_Model_Sendfriend`	# `setProduct( Mage_Catalog_Model_Product $product )` Set product instance Set product instance Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Sendfriend_Model_Sendfriend`
`public Mage_Catalog_Model_Product`	# `getProduct( )` Retrieve Product instance Retrieve Product instance Returns `Mage_Catalog_Model_Product` Throws `Mage_Core_Exception`
`public Mage_Sendfriend_Model_Sendfriend`	# `setSender( array $sender )` Set Sender Information array Set Sender Information array Parameters `$sender` `array` $sender Returns `Mage_Sendfriend_Model_Sendfriend`
`public Varien_Object`	# `getSender( )` Retrieve Sender Information Object Retrieve Sender Information Object Returns `Varien_Object` Throws `Mage_Core_Exception`
`public integer`	# `getMaxSendsToFriend( )` Get max allowed uses of "Send to Friend" function per hour Get max allowed uses of "Send to Friend" function per hour Returns `integer`
`public string`	# `getTemplate( )` Get current Email "Send to friend" template Get current Email "Send to friend" template Returns `string`
`public integer`	# `getMaxRecipients( )` Get max allowed recipients for "Send to a Friend" function Get max allowed recipients for "Send to a Friend" function Returns `integer`
`public boolean`	# `canEmailToFriend( )` Check if user is allowed to email product to a friend Check if user is allowed to email product to a friend Returns `boolean`
`public boolean`	# `isExceedLimit( )` Check if user is exceed limit Check if user is exceed limit Returns `boolean`
`public integer`	# `getSentCount( boolean $useCache = true )` Return count of sent in last period Return count of sent in last period Parameters `$useCache` `boolean` $useCache - flag, is allow to use value of attribute of model if it is processed last time Returns `integer`
`protected integer`	# `_incrementSentCount( )` Increase count of sent Increase count of sent Returns `integer`
`protected integer`	# `_sentCountByCookies( boolean $increment = false )` Return count of sent in last period by cookie Return count of sent in last period by cookie Parameters `$increment` `boolean` $increment - flag, increase count before return value Returns `integer`
`protected integer`	# `_sentCountByIp( boolean $increment = false )` Return count of sent in last period by IP address Return count of sent in last period by IP address Parameters `$increment` `boolean` $increment - flag, increase count before return value Returns `integer`
`public Mage_Sendfriend_Model_Sendfriend`	# `register( )` Register self in global register with name send_to_friend_model Register self in global register with name send_to_friend_model Returns `Mage_Sendfriend_Model_Sendfriend`

Methods inherited from Mage_Core_Model_Abstract
_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _beforeSave(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()

Properties summary
`protected array`	`$_names`	`array()`	# Recipient Names Recipient Names
`protected array`	`$_emails`	`array()`	# Recipient Emails Recipient Emails
`protected array`	`$_sender`	`array()`	# Sender data array Sender data array
`protected Mage_Catalog_Model_Product`	`$_product`		# Product Instance Product Instance
`protected integer`	`$_sentCount`		# Count of sent in last period Count of sent in last period
`protected string`	`$_lastCookieValue`	`array()`	# Last values for Cookie Last values for Cookie

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_eventObject, $_eventPrefix, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Class Mage_Sendfriend_Model_Sendfriend

Returns

Returns

Parameters

Returns

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Throws

Parameters

Returns

Returns

Throws

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns