Class affiliate

---

[Строка 14]

Размещен: /shop/affiliate.class.php

---

Описание

Система управления сайтом HostCMS v. 5.xx Copyright © 2005-2010 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Класс модуля "Аффилиаты".

Файл: /modules/affiliate/affiliate.class.php

author

Hostmake LLC

version

5.x

---

Свойства класса

---

Константы класса

---

Унаследованные константы класса

---

Унаследованные свойства класса

---

Методы

• void AcceptAffiliatePlanForSiteUsers()
  Начисление пользователю сумм с заказа по партнеской программе
• void AcceptAffiliatePlanToShop()
  Добавление/удаление ассоциации партнерской программы магазину
• mixed CheckSiteUserAffiliate()
  Проеверка участия пользователя сайта в аффилиат программе в качестве привлеченного пользователя
• resource DeleteAffiliate()
  Удаление информации об аффилиате
• resource DeleteAffiliatePlans()
  Удаление информации о плане аффилиата
• resource DeleteAffiliateValues()
  Удаление информации о комиссии
• void DisableAffiliatePlanToShop()
  Удаление ассоциации партнерской программы магазину
• void EnableAffiliatePlanToShop()
  Добавление ассоциации партнерской программы магазину
• str GenXML4AffiliatePlan()
  Генерация XML-данных для партнерских программ магазина
• str GenXML4AffiliateValues()
  Генерация XML для уровней партнерской программы
• void GenXmlAffiliatTree()
  
• mixed GetAffiliate()
  Получение информации об аффилиате
• mixed GetAffiliatePlans()
  Получение информации о плане аффилиата
• arr GetAffiliatePlansIdForShop()
  Получение идентификаторов всех парнерских программ для магазина
• mixed GetAffiliateValues()
  Получение информации о комисии
• void getAffiliatInnerLevelForUser()
  
• array GetAffiliatsForUser()
  Получение массива идентификаторов аффилиатов пользователя
• mixed GetAllAffiliatePlans()
  Получение всех партнерских программ
• mixed GetAllAffiliateValuesForAffiliate()
  Получение всех уровней партнерской программы
• unknown GetAllUsersForAffiliate()
  Получение всех пользователей, привлеченных определенным аффилиатом
• arr GetShopsIdForAffiliatePlans()
  Получение идентификаторов всех магазинов, в которых доступна парнерская программа
• void getUsersID()
  Метод формирования массива идентификаторов пользавателей сайта, участвующих в программе партнерских отношений.
• mixed InsertAffiliate()
  Добавление информации об аффилиате
• mixed InsertAffiliatePlans()
  Добавление информации о плане аффилиата
• mixed InsertAffiliateValues()
  Добавление информации о комиссии
• void ShowAffiliate()
  Показ партнерских программ.
• void ShowAffiliatStatistics()
  

Унаследованные методы

---

Описания методов

affiliate::AcceptAffiliatePlanForSiteUsers

AcceptAffiliatePlanForSiteUsers( $site_users_id $site_users_id, $shop_order_id $shop_order_id );

Описание

Начисление пользователю сумм с заказа по партнеской программе

Принимаемые параметры

$site_users_id

идентификатор пользователя сайта (реферала), который оформил заказ

$shop_order_id

идентификатор заказа

[ Наверх ]




affiliate::AcceptAffiliatePlanToShop

AcceptAffiliatePlanToShop( int $affiliate_plans_id, int $shop_shops_id );

Описание

Добавление/удаление ассоциации партнерской программы магазину

Принимаемые параметры

$affiliate_plans_id

идентификатор партнерской программы

$shop_shops_id

идентификатор магазина

[ Наверх ]




affiliate::CheckSiteUserAffiliate

CheckSiteUserAffiliate( int $site_users_id, [int $affiliate_site_users_id = false] );

Описание

Проеверка участия пользователя сайта в аффилиат программе в качестве привлеченного пользователя

Принимаемые параметры

$site_users_id

идентификатор пользователя сайта

$affiliate_site_users_id

идентификатор аффилиата

Возвращает

массив данных, либо False

[ Наверх ]




affiliate::DeleteAffiliate

DeleteAffiliate( int $affiliate_id );

Описание

Удаление информации об аффилиате

Принимаемые параметры

$affiliate_id

идентификатор аффилиата

[ Наверх ]




affiliate::DeleteAffiliatePlans

DeleteAffiliatePlans( int $affiliate_plans_id );

Описание

Удаление информации о плане аффилиата

Принимаемые параметры

$affiliate_plans_id

идентификатор плана

[ Наверх ]




affiliate::DeleteAffiliateValues

DeleteAffiliateValues( int $affiliate_values_id );

Описание

Удаление информации о комиссии

Принимаемые параметры

$affiliate_values_id

идентификатор комиссии

[ Наверх ]




affiliate::DisableAffiliatePlanToShop

DisableAffiliatePlanToShop( int $affiliate_plans_id, int $shop_shops_id );

Описание

Удаление ассоциации партнерской программы магазину

Принимаемые параметры

$affiliate_plans_id

идентификатор партнерской программы

$shop_shops_id

идентификатор магазина

[ Наверх ]




affiliate::EnableAffiliatePlanToShop

EnableAffiliatePlanToShop( int $affiliate_plans_id, int $shop_shops_id );

Описание

Добавление ассоциации партнерской программы магазину

Принимаемые параметры

$affiliate_plans_id

идентификатор партнерской программы

$shop_shops_id

идентификатор магазина

[ Наверх ]




affiliate::GenXML4AffiliatePlan

GenXML4AffiliatePlan( int $shop_shops_id, int $site_user_id );

Описание

Генерация XML-данных для партнерских программ магазина

Принимаемые параметры

$shop_shops_id

идентификатор магазина

$site_user_id

идентификатор пользователя сайта - аффилиата

Возвращает

XML данные

[ Наверх ]




affiliate::GenXML4AffiliateValues

GenXML4AffiliateValues( int $affiliate_plans_id );

Описание

Генерация XML для уровней партнерской программы

Принимаемые параметры

$affiliate_plans_id

идентификатор партнерской программы

Возвращает

XML-код

[ Наверх ]




affiliate::GenXmlAffiliatTree

GenXmlAffiliatTree( $affiliate_site_users_id );

Принимаемые параметры

$affiliate_site_users_id

[ Наверх ]




affiliate::GetAffiliate

GetAffiliate( int $affiliate_id );

Описание

Получение информации об аффилиате

Принимаемые параметры

$affiliate_id

идентификатор аффилиата

Возвращает

массив данных, либо False

[ Наверх ]




affiliate::GetAffiliatePlans

GetAffiliatePlans( int $affiliate_plans_id );

Описание

Получение информации о плане аффилиата

Принимаемые параметры

$affiliate_plans_id

идентификатор плана аффилиата

Возвращает

массив данных, либо False

[ Наверх ]




affiliate::GetAffiliatePlansIdForShop

GetAffiliatePlansIdForShop( int $shop_shops_id, int $site_user_id, [arr $param = array()] );

Описание

Получение идентификаторов всех парнерских программ для магазина

Принимаемые параметры

$shop_shops_id

идентификатор магазина

$site_user_id

идентификатор пользователя сайта - Аффилиата

$param

массив дополнительных параметров

• array['affiliate_plans_min_num_of_items'] минимальное количество купленного товара
• array['affiliate_plans_min_sum_of_items'] минимальная сумма, на которую куплен товар

Возвращает

массив идентификаторов партнерских программ

[ Наверх ]




affiliate::GetAffiliateValues

GetAffiliateValues( int $affiliate_values_id );

Описание

Получение информации о комисии

Принимаемые параметры

$affiliate_values_id

идентификатор комиссии

Возвращает

массив данных, либо False

[ Наверх ]




affiliate::getAffiliatInnerLevelForUser

getAffiliatInnerLevelForUser( $site_user_id, $affiliat_users_id, [ $innerLevel = 0] );

Принимаемые параметры

$site_user_id

$affiliat_users_id

$innerLevel

[ Наверх ]




affiliate::GetAffiliatsForUser

GetAffiliatsForUser( int $site_users_id, [bool $first_call = true], [ $overflow_protection = 0] );

Описание

Получение массива идентификаторов аффилиатов пользователя

Принимаемые параметры

$site_users_id

идентификатор пользователя сайта

$first_call

флаг первого вызова

$overflow_protection

Возвращает

массив аффилиатов данного пользователя

[ Наверх ]




affiliate::GetAllAffiliatePlans

GetAllAffiliatePlans( arr $site_users_group_array, [int $site_id = false] );

Описание

Получение всех партнерских программ

Принимаемые параметры

$site_users_group_array

массив идентификаторов групп пользователей сайта

$site_id

идентификатор сайта (0 - выборка со всех сайтов)

Возвращает

Resource или False

[ Наверх ]




affiliate::GetAllAffiliateValuesForAffiliate

GetAllAffiliateValuesForAffiliate( int $affiliate_plans_id );

Описание

Получение всех уровней партнерской программы

Принимаемые параметры

$affiliate_plans_id

идентификатор партнерской программы

Возвращает

Resource или False

[ Наверх ]




affiliate::GetAllUsersForAffiliate

GetAllUsersForAffiliate( unknown_type $affiliate_site_users_id );

Описание

Получение всех пользователей, привлеченных определенным аффилиатом

Принимаемые параметры

$affiliate_site_users_id

[ Наверх ]




affiliate::GetShopsIdForAffiliatePlans

GetShopsIdForAffiliatePlans( int $affiliate_plans_id );

Описание

Получение идентификаторов всех магазинов, в которых доступна парнерская программа

Принимаемые параметры

$affiliate_plans_id

идентификатор партнерской программы

Возвращает

массив идентификаторов магазинов

[ Наверх ]




affiliate::getUsersID

getUsersID( point &$users_id_array, bool $current_site_user_id );

Описание

Метод формирования массива идентификаторов пользавателей сайта, участвующих в программе партнерских отношений.

Принимаемые параметры

$current_site_user_id

идентификатор пользователя сайта, для которого требуется получить цепочку идентификаторов

&$users_id_array

arr $users_id_array указатель на массив, в который будут возвращены данные

[ Наверх ]




affiliate::InsertAffiliate

InsertAffiliate( array $param );

Описание

Добавление информации об аффилиате

Принимаемые параметры

$param

Массив параметров

• int $param['affiliate_id'] идентификатор связи пользователя и аффилиата
• int $param['site_users_id'] идентификатор пользователя, которого привел аффилиат
• int $param['affiliate_plans_id'] идентификатор патрнерской программы
• int $param['affiliate_site_users_id'] идентификатор аффилиата
• int $param['affiliate_active'] флаг активности польщователя аффилиата
• str $param['affiliate_invite_date'] дата приглашения аффилиата, если не передана, ставится текущая

Возвращает

Идентификатор вставленной записи, либо False

[ Наверх ]




affiliate::InsertAffiliatePlans

InsertAffiliatePlans( array $param );

Описание

Добавление информации о плане аффилиата

Принимаемые параметры

$param

Массив параметров

• int $param['affiliate_plans_id'] идентификатор плана аффилиата
• int $param['site_id'] идентификатор сайта
• str $param['affiliate_plans_name'] название плана
• str $param['affiliate_plans_description'] описание плана
• int $param['affiliate_plans_activity'] статус активности
• int $param['site_users_group_id'] идентификатор группы пользователей сайта
• str $param['affiliate_plans_last_change_datetime'] дата последнего изменения плана
• int $param['affiliate_plans_min_num_of_items'] минимальное количество товаров в заказе для активации плана
• int $param['affiliate_plans_min_sum_of_items'] минимальное сумма единовременной покупки для активации плана
• int $param['affiliate_plans_delivery_on'] флаг учета доставки при просчете комиссии

Возвращает

Идентификатор вставленной записи, либо False

[ Наверх ]




affiliate::InsertAffiliateValues

InsertAffiliateValues( array $param );

Описание

Добавление информации о комиссии

Принимаемые параметры

$param

Массив параметров

• int $param['affiliate_values_id'] идентификатор комиссии
• int $param['affiliate_plans_id'] идентификатор плана
• int $param['affiliate_values_inner_level'] уровень вложенности
• int $param['affiliate_values_percent'] комиссия в процентах
• int $param['affiliate_values_value'] комиссия в одной из валют магазина
• int $param['affiliate_values_type'] тип комиссии

Возвращает

Идентификатор вставленной записи, либо False

[ Наверх ]




affiliate::ShowAffiliate

ShowAffiliate( int $site_id, str $xsl_name, [arr $param = array()], [array $external_propertys = array()] );

Описание

Показ партнерских программ.

Принимаемые параметры

$site_id

идентификатор сайта

$xsl_name

имя XSL-шаблона

$param

ассоциативный массив параметров

• array['site_user_id'] идентификатор пользователя сайта

$external_propertys

массив дополнительных свойств для включения в исходный XML-код

[ Наверх ]




affiliate::ShowAffiliatStatistics

ShowAffiliatStatistics( $site_user_id, $xsl_name, $date_from, $date_to );

Принимаемые параметры

$site_user_id

$xsl_name

$date_from

$date_to

[ Наверх ]

---

Описания переменных

---

Описание констант класса

---