Класс customer модуля emarket — различия между версиями

Материал из Umicms
Перейти к:навигация, поиск
Строка 63: Строка 63:
 
                         //будет создан экземпляр класса customer, на основе объекта переданного в переменную $object
 
                         //будет создан экземпляр класса customer, на основе объекта переданного в переменную $object
 
$customer = new customer($object);
 
$customer = new customer($object);
                       //только что созданный экземпляр класса обратиться к функции <span style="font-weight:bold"> tryMerge()</span>
+
                       //только что созданный экземпляр класса обратиться к функции tryMerge()
 
$customer->tryMerge();
 
$customer->tryMerge();
 
return $customer;
 
return $customer;
Строка 80: Строка 80:
 
<p>'''Результат:''' экземпляр класса customer</p>
 
<p>'''Результат:''' экземпляр класса customer</p>
  
При создании объекта, методом определяется, какое значение будет хранить переменная $isAuth
+
При создании объекта, методом определяется, какое значение будет хранить переменная $isAuth:
 +
 
 +
<source lang="php">
 +
 
 +
public function __construct(iUmiObject $object) {
 +
$permissions = permissionsCollection::getInstance();
 +
                        //получить id текущего пользователя
 +
$userId = $permissions->getUserId();
 +
                        //получить id гостя
 +
$guestId = permissionsCollection::getGuestId();
 +
                        // если id гостя равен id текущего пользователя записать в переменную $isAuth false, в противном 
 +
                        случае записать id текущего пользователя
 +
$this->isAuth = ($userId == $guestId) ? false : $userId;
 +
                        //создать экземпляр класса покупатель
 +
parent::__construct($object);
 +
}
 +
</source>
  
 
== IsUser() ==
 
== IsUser() ==

Версия 15:12, 21 февраля 2014

Актуально для версии 2.9.5


Описание

Одним из классов, который необходим для работы модуля "интернет-магазин" является класс customer. Данный класс предоставляет доступ к управлению объектами-покупателями интернет-магазина. Исходный код класса находится в файле classes\modules\emarket\classes\customer\customer.php

Переменные

В класса объявлены две переменные.

Переменная $defaultExpiration, которая будет использована при создании cookie для указания времени ее жизни

public static $defaultExpiration = 2678400;	// 31 days

Переменная $isAuth будет хранить id пользователя, если покупатель - авторизованный пользователь, false в противном случае

protected $isAuth;

Методы

get()

Получить экземпляр класса можно с помощью функции get(), если покупатель не существует, то метод создаст новый экземпляр класса

Параметры:


bool $nocache:

не использовать данные кэша, по умолчанию false

Результат: экземпляр класса customer

		public static function get($nocache = false) {
			static $customer;
//Сначала функция get() проверит создан ли уже объект покупатель
			if(!$nocache && !is_null($customer)) {

//вернет объект покупатель, если он существует
				return $customer;                           
			}


			$objects = umiObjectsCollection::getInstance();     
			$permissions = permissionsCollection::getInstance();

                        // если объект не существует, проверит авторизован ли пользователь
			if($permissions->isAuth()) {
				$userId = $permissions->getUserId();

                                 //авторизован - запишет в переменную $object(входной параметр для конструктора класса)
                                 объект текущего пользователя
				$object = $objects->getObject($userId);
			} else {
                                //не авторизован - запишет в переменную $object объект покупателя-гостя, 
                                получает этот объект функция<span style="font-weight:bold"> getCustomerId()</span>
				$object = self::getCustomerId();

				//Second try may be usefull to avoid server after-reboot conflicts
				if($object === false) $object = self::getCustomerId(true);
			}

			if($object instanceof iUmiObject) {
                        //будет создан экземпляр класса customer, на основе объекта переданного в переменную $object
				$customer = new customer($object);
                       //только что созданный экземпляр класса обратиться к функции  tryMerge()
				$customer->tryMerge();
				return $customer;
			}
		}


__construct()

Экземпляр класса создается с помощью функции __construct()

Параметры:


iUmiObject $object:

содержит в себе либо объект "зарегистрированный пользователь" либо объект "незарегистрированный покупатель"

Результат: экземпляр класса customer

При создании объекта, методом определяется, какое значение будет хранить переменная $isAuth:

	public function __construct(iUmiObject $object) {
			$permissions = permissionsCollection::getInstance();
                         //получить id текущего пользователя
			$userId = $permissions->getUserId();
                        //получить id гостя
			$guestId = permissionsCollection::getGuestId();
                        // если id гостя равен id текущего пользователя записать в переменную $isAuth false, в противном   
                         случае записать id текущего пользователя
			$this->isAuth = ($userId == $guestId) ? false : $userId;
                        //создать экземпляр класса покупатель
			parent::__construct($object);
		}

IsUser()

Метод isUser() вернет значение типа boolean, 1 или 0, в зависимости от того является ли покупатель зарегистрированным пользователем, т.е. будет проверено содержит ли переменная $isAuth идентификатор пользователя, или же, содержит false

Параметры:

Результат: boolean


getCustomerId()

Метод getCustomerId() вернет объект покупателя-гостя, если объект не существует, обратится к методу createGuestCustomer(), который создаст нового покупателя-гостя

Параметры:


bool $noCookie:

"не использовать данные кук", по умолчанию false

Результат: объект "покупатель-гость", записанный в переменную $customer


В теле функции объявлена переменная $customerId, в которую записывается id покупателя-гостя

Сначала, метод проверит содержит ли данная переменная значение.

Если переменная пуста $customerId, получит id пользователя из кук. Кука в браузере пользователя создается этой же функцией при генерации объекта покупатель-гость, т.е. если пользователь уже заходил на сайт, то метод сразу же вернет объект покупателя-гостя в переменной $customer.

Если куки не существует($customer осталась пустой), то метод обратиться к функции createGuestCustomer(), которая создаст нового покупателя-гостя. Также, будет записана кука в браузер пользователя:

setcookie('customer-id', $customerId, (time() + self::$defaultExpiration), '/');