Mage_Customer_Model_Session Class Reference

Inheritance diagram for Mage_Customer_Model_Session:

List of all members.

Public Member Functions
	getCustomerConfigShare ()
	__construct ()
	setCustomer (Mage_Customer_Model_Customer $customer)
	getCustomer ()
	getCustomerId ()
	getCustomerGroupId ()
	isLoggedIn ()
	checkCustomerId ($customerId)
	login ($username, $password)
	setCustomerAsLoggedIn ($customer)
	loginById ($customerId)
	logout ()
	authenticate (Mage_Core_Controller_Varien_Action $action, $loginUrl=null)
Protected Attributes
	$_customer

---

Detailed Description

Definition at line 34 of file Session.php.

---

Constructor & Destructor Documentation

__construct

(

)

Constructor

By default is looking for first argument as array and assignes it as object attributes This behaviour may change in child classes

Reimplemented from Varien_Object.

Definition at line 48 of file Session.php.

    {
        $namespace = 'customer';
        if ($this->getCustomerConfigShare()->isWebsiteScope()) {
            $namespace .= '_' . (Mage::app()->getStore()->getWebsite()->getCode());
        }

        $this->init($namespace);
        Mage::dispatchEvent('customer_session_init', array('customer_session'=>$this));
    }

---

Member Function Documentation

authenticate	(	Mage_Core_Controller_Varien_Action $	action,
		$	loginUrl = null
	)

Authenticate controller action by login customer

Parameters:

Mage_Core_Controller_Varien_Action

$action

Returns:

bool

Definition at line 217 of file Session.php.

    {
        if (!$this->isLoggedIn()) {
            $this->setBeforeAuthUrl(Mage::getUrl('*/*/*', array('_current'=>true)));
            if (is_null($loginUrl)) {
                $loginUrl = Mage::helper('customer')->getLoginUrl();
            }
            $action->getResponse()->setRedirect($loginUrl);
            return false;
        }
        return true;
    }

checkCustomerId

(

$

customerId

)

Check exists customer (light check)

Parameters:

int

$customerId

Returns:

bool

Definition at line 147 of file Session.php.

    {
        return Mage::getResourceSingleton('customer/customer')
            ->checkCustomerId($customerId);
    }

getCustomer

(

)

Retrieve costomer model object

Returns:

Mage_Customer_Model_Customer

Definition at line 90 of file Session.php.

    {
        if ($this->_customer instanceof Mage_Customer_Model_Customer) {
            return $this->_customer;
        }

        $customer = Mage::getModel('customer/customer')
            ->setWebsiteId(Mage::app()->getStore()->getWebsiteId());
        if ($this->getId()) {
            $customer->load($this->getId());
        }

        $this->setCustomer($customer);
        return $this->_customer;
    }

getCustomerConfigShare

(

)

Retrieve customer sharing configuration model

Returns:

Mage_Customer_Model_Config_Share

Definition at line 43 of file Session.php.

    {
        return Mage::getSingleton('customer/config_share');
    }

getCustomerGroupId

(

)

Get customer group id If customer is not logged in system not logged in group id will be returned

Returns:

int

Definition at line 122 of file Session.php.

    {
        if ($this->isLoggedIn()) {
            return $this->getCustomer()->getGroupId();
        } else {
            return Mage_Customer_Model_Group::NOT_LOGGED_IN_ID;
        }
    }

getCustomerId

(

)

Retrieve customer id from current session

Returns:

int || null

Definition at line 111 of file Session.php.

    {
        return $this->getId();
    }

isLoggedIn

(

)

Checking custommer loggin status

Returns:

bool

Definition at line 136 of file Session.php.

    {
        return (bool)$this->getId() && (bool)$this->checkCustomerId($this->getId());
    }

login	(	$	username,
		$	password
	)

Customer authorization

Parameters:

	string	$username
	string	$password

Returns:

bool

Definition at line 160 of file Session.php.

    {
        $customer = Mage::getModel('customer/customer')
            ->setWebsiteId(Mage::app()->getStore()->getWebsiteId());

        if ($customer->authenticate($username, $password)) {
            $this->setCustomer($customer);
            Mage::dispatchEvent('customer_login', array('customer'=>$customer));
            return true;
        }
        return false;
    }

loginById

(

$

customerId

)

Authorization customer by identifier

Parameters:

int

$customerId

Returns:

bool

Definition at line 186 of file Session.php.

    {
        $customer = Mage::getModel('customer/customer')->load($customerId);
        if ($customer) {
            $this->setCustomer($customer);
            Mage::dispatchEvent('customer_login', array('customer'=>$customer));
            return true;
        }
        return false;
    }

logout

(

)

Logout customer

Returns:

Mage_Customer_Model_Session

Definition at line 202 of file Session.php.

    {
        if ($this->isLoggedIn()) {
            Mage::dispatchEvent('customer_logout', array('customer' => $this->getCustomer()) );
            $this->setId(null);
        }
        return $this;
    }

setCustomer

(

Mage_Customer_Model_Customer $

customer

)

Set customer object and setting customer id in session

Parameters:

Mage_Customer_Model_Customer

$customer

Returns:

Mage_Customer_Model_Session

Definition at line 65 of file Session.php.

    {
        // check if customer is not confirmed
        if ($customer->isConfirmationRequired()) {
            if ($customer->getConfirmation()) {
                throw new Exception('This customer is not confirmed and cannot log in.',
                    Mage_Customer_Model_Customer::EXCEPTION_EMAIL_NOT_CONFIRMED
                );
            }
        }
        $this->_customer = $customer;
        $this->setId($customer->getId());
        // save customer as confirmed, if it is not
        if ((!$customer->isConfirmationRequired()) && $customer->getConfirmation()) {
            $customer->setConfirmation(null)->save();
            $customer->setIsJustConfirmed(true);
        }
        return $this;
    }

setCustomerAsLoggedIn

(

$

customer

)

Definition at line 173 of file Session.php.

    {
        $this->setCustomer($customer);
        Mage::dispatchEvent('customer_login', array('customer'=>$customer));
        return $this;
    }

---

Member Data Documentation

$_customer [protected]

Definition at line 36 of file Session.php.

---

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

• app/code/core/Mage/Customer/Model/Session.php