ChMbpModule Class Reference

Inheritance diagram for ChMbpModule:

Public Member Functions
	__construct ($aModule)
	getSettingsForm ($mixedResult)
	setSettings ($aData)
	getCurrentLevelBlock ()
	getAvailableLevelsBlock ()
	getSelectLevelBlock ($bDynamic=false)
	actionIndex ()
	actionJoin ()
	actionJoinSubmit ()
	actionJoinForm ()
	actionAdmin ()
	serviceIsDisableFreeJoin ()
	serviceGetUpgradeUrl ()
	serviceGetMemberMenuLink ($iMemberId)
	serviceSelectLevelBlock ()
	serviceGetPaymentData ()
	serviceGetItems ($iVendorId)
	serviceGetCartItem ($iClientId, $iItemId)
	serviceRegisterCartItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrderId)
	serviceUnregisterCartItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrderId)
	serviceProlongSubscriptions ()
	_getCartItem ($iClientId, $iItemId)
Public Member Functions inherited from ChWsbModule
	isLogged ()
	getUserId ()
	getUserPassword ()
	getTitleKey ($sUri)
	serviceGetBaseUrl ()

Additional Inherited Members
Static Public Member Functions inherited from ChWsbModule
static	getInstance ($sClassName)
static	getTitle ($sUri)
Public Attributes inherited from ChWsbModule
	$_aModule
	$_oDb
	$_oTemplate
	$_oConfig

Detailed Description

Membership module by Cheetah

This module is needed to integrate the default Membership/ACL engine with Payment module.

Profile's Wall: no spy events

Spy: no spy events

Memberships/ACL: Doesn't depend on user's membership.

Service methods:

Get the content of the link for Dashboard item in member menu.

See also

ChMbpModule::serviceGetMemberMenuLink ChWsbService::call('membership', 'get_member_menu_link', array($iMemberId));

Note

is needed for internal usage.

Get single item. Is used in Shopping Cart to get one product by specified id.

See also

ChMbpModule::serviceGetCartItem ChWsbService::call('membership', 'get_cart_item', array($iClientId, $iItemId));

Note

is needed for internal usage.

Get items. Is used in Orders Administration to get all products of the requested seller(vendor).

See also

ChMbpModule::serviceGetItems ChWsbService::call('membership', 'get_items', array($iVendorId));

Note

is needed for internal usage.

Register purchased membership level.

See also

ChMbpModule::serviceRegisterCartItem ChWsbService::call('membership', 'register_cart_item', array($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrderId));

Note

is needed for internal usage.

Unregister the membership level purchased earlier.

See also

ChMbpModule::serviceUnregisterCartItem ChWsbService::call('membership', 'unregister_cart_item', array($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrderId));

Note

the service does nothing because membership level cannot be canceled manually. It should expire by itself.

Alerts: no alerts available

Definition at line 63 of file ChMbpModule.php.

Constructor & Destructor Documentation

__construct()

ChMbpModule::__construct

(

$aModule

)

Constructor

Reimplemented from ChWsbModule.

Definition at line 68 of file ChMbpModule.php.

Member Function Documentation

_getCartItem()

ChMbpModule::_getCartItem	(		$iClientId,
			$iItemId
	)

Definition at line 416 of file ChMbpModule.php.

actionAdmin()

ChMbpModule::actionAdmin

(

)

Definition at line 254 of file ChMbpModule.php.

actionIndex()

ChMbpModule::actionIndex

(

)

Action Methods

Definition at line 145 of file ChMbpModule.php.

actionJoin()

ChMbpModule::actionJoin

(

)

Definition at line 168 of file ChMbpModule.php.

actionJoinForm()

ChMbpModule::actionJoinForm

(

)

Definition at line 229 of file ChMbpModule.php.

actionJoinSubmit()

ChMbpModule::actionJoinSubmit

(

)

Definition at line 186 of file ChMbpModule.php.

getAvailableLevelsBlock()

ChMbpModule::getAvailableLevelsBlock

(

)

Definition at line 116 of file ChMbpModule.php.

getCurrentLevelBlock()

ChMbpModule::getCurrentLevelBlock

(

)

Page blocks' methods

Definition at line 111 of file ChMbpModule.php.

getSelectLevelBlock()

ChMbpModule::getSelectLevelBlock

(

$bDynamic = false

)

Definition at line 130 of file ChMbpModule.php.

getSettingsForm()

ChMbpModule::getSettingsForm

(

$mixedResult

)

Admin Settings Methods

Definition at line 78 of file ChMbpModule.php.

serviceGetCartItem()

ChMbpModule::serviceGetCartItem	(		$iClientId,
			$iItemId
	)

Is used in Shopping Cart to get one product by specified id.

Parameters

integer	$iClientId	client's ID.
integer	$iItemId	product's ID.

Returns

array with product description.

Definition at line 365 of file ChMbpModule.php.

serviceGetItems()

ChMbpModule::serviceGetItems

(

$iVendorId

)

Is used in Orders Administration to get all products of the requested seller(vendor).

Parameters

integer

$iVendorId

seller ID.

Returns

array of products.

Definition at line 341 of file ChMbpModule.php.

serviceGetMemberMenuLink()

ChMbpModule::serviceGetMemberMenuLink

(

$iMemberId

)

Definition at line 306 of file ChMbpModule.php.

serviceGetPaymentData()

ChMbpModule::serviceGetPaymentData

(

)

Integration with Payment module

Definition at line 330 of file ChMbpModule.php.

serviceGetUpgradeUrl()

ChMbpModule::serviceGetUpgradeUrl

(

)

Definition at line 301 of file ChMbpModule.php.

serviceIsDisableFreeJoin()

ChMbpModule::serviceIsDisableFreeJoin

(

)

System Methods

Definition at line 297 of file ChMbpModule.php.

serviceProlongSubscriptions()

ChMbpModule::serviceProlongSubscriptions

(

)

Check whether prolongation is available for membership levels marked as 'Expiring'

Definition at line 401 of file ChMbpModule.php.

serviceRegisterCartItem()

ChMbpModule::serviceRegisterCartItem	(		$iClientId,
			$iSellerId,
			$iItemId,
			$iItemCount,
			$sOrderId
	)

Register purchased product.

Parameters

integer	$iClientId	client's ID.
integer	$iSellerId	seller's ID.
integer	$iItemId	product's ID.
integer	$iItemCount	product count purchased at the same time.
string	$sOrderId	internal order ID generated for the payment.

Returns

array with product description.

Definition at line 379 of file ChMbpModule.php.

serviceSelectLevelBlock()

ChMbpModule::serviceSelectLevelBlock

(

)

Definition at line 323 of file ChMbpModule.php.

serviceUnregisterCartItem()

ChMbpModule::serviceUnregisterCartItem	(		$iClientId,
			$iSellerId,
			$iItemId,
			$iItemCount,
			$sOrderId
	)

Unregister the product purchased earlier.

Parameters

integer	$iClientId	client's ID.
integer	$iSellerId	seller's ID.
integer	$iItemId	product's ID.
integer	$iItemCount	product count.
string	$sOrderId	internal order ID.

Definition at line 396 of file ChMbpModule.php.

setSettings()

ChMbpModule::setSettings

(

$aData

)

Definition at line 95 of file ChMbpModule.php.

---

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

• modules/cheetah/membership/classes/ChMbpModule.php