|
Cheetah
|
Go to the source code of this file.
Functions | |
| getMemberMembershipInfo_current ($iMemberId, $time='') | |
| getMemberMembershipInfo_latest ($iMemberId, $iTime='') | |
| getMemberMembershipInfo ($iMemberId, $iTime='', $bCheckUserStatus=false) | |
| checkAction ($iMemberId, $actionID, $performAction=false, $iForcedProfID=0, $isCheckMemberStatus=true) | |
| buyMembership ($iMemberId, $iMembershipId, $sTransactionId, $bStartsNow=false) | |
| setMembership ($iMemberId, $iMembershipId, $iDays=0, $bStartsNow=false, $sTransactionId='', $isSendMail=true) | |
| getMemberships ($purchasableOnly=false) | |
| getMembershipPrices ($iMembershipId) | |
| getMembershipInfo ($iMembershipId) | |
| defineMembershipActions ($aActionsAll, $sPrefix='CH_') | |
| membershipActionsCmp ($a, $b) | |
| translateMembershipActions (&$aActions) | |
| markMembershipAsExpiring ($iMemberId, $iLevelId, $sTransactionId) | |
| unmarkMembershipAsExpiring ($iMemberId, $iLevelId, $sTransactionId) | |
| unmarkMembershipAsExpiringAll () | |
| clearActionsTracksForMember ($iMemberId) | |
| buyMembership | ( | $iMemberId, | |
| $iMembershipId, | |||
| $sTransactionId, | |||
$bStartsNow = false |
|||
| ) |
Buy a membership for a member
| int | $iMemberId | - member that is going to get the membership |
| int | $iMembershipId | - bought membership |
| int | $sTransactionId | - internal key of the transaction (ID from Transactions table) |
| boolean | $bStartsNow | - if true, the membership will start immediately; if false, the membership will start after the current membership expires |
Definition at line 511 of file membership_levels.inc.php.
| checkAction | ( | $iMemberId, | |
| $actionID, | |||
$performAction = false, |
|||
$iForcedProfID = 0, |
|||
$isCheckMemberStatus = true |
|||
| ) |
Checks if a given action is allowed for a given member and updates action information if the action is performed.
| int | $iMemberId | - ID of a member that is going to perform an action |
| int | $actionID | - ID of the action itself |
| boolean | $performAction | - if true, then action information is updated, i.e. action is 'performed' |
NOTES:
$result[CHECK_ACTION_MESSAGE] contains a message with detailed information about the result, already processed by the language file
if $result[CHECK_ACTION_RESULT] == CHECK_ACTION_RESULT_ALLOWED then this node contains an empty string
The error messages themselves are stored in the language file. Additional variables are passed to the languages.inc.php function _t_ext() as an array and can be used there in the form of {0}, {1}, {2} ...
Additional variables passed to the lang. file on errors (can be used in error messages):
For all errors:
$arg0[CHECK_ACTION_LANG_FILE_ACTION] = name of the action
$arg0[CHECK_ACTION_LANG_FILE_MEMBERSHIP]= name of the current membership
CHECK_ACTION_RESULT_LIMIT_REACHED:
$arg0[CHECK_ACTION_LANG_FILE_LIMIT] = limit on number of actions allowed for the member
$arg0[CHECK_ACTION_LANG_FILE_PERIOD] = period that the limit is set for (in hours, 0 if unlimited)
CHECK_ACTION_RESULT_NOT_ALLOWED_BEFORE:
$arg0[CHECK_ACTION_LANG_FILE_BEFORE] = date/time since when the action is allowed
CHECK_ACTION_RESULT_NOT_ALLOWED_AFTER:
$arg0[CHECK_ACTION_LANG_FILE_AFTER] = date/time since when the action is not allowed
$result[CHECK_ACTION_PARAMETER] contains an additional parameter that can be considered when performing the action (like the number of profiles to show in search result)
Definition at line 313 of file membership_levels.inc.php.
| clearActionsTracksForMember | ( | $iMemberId | ) |
Definition at line 804 of file membership_levels.inc.php.
| defineMembershipActions | ( | $aActionsAll, | |
$sPrefix = 'CH_' |
|||
| ) |
Define action, during defining all names are translated the following way: my action => CH_MY_ACTION
| $aActions | array of actions from sys_acl_actions table, with default array keys (starting from 0) and text values |
Definition at line 744 of file membership_levels.inc.php.
| getMemberMembershipInfo | ( | $iMemberId, | |
$iTime = '', |
|||
$bCheckUserStatus = false |
|||
| ) |
Retrieves information about membership for a given member at a given moment.
If there are no memberships purchased/assigned to the given member or all of them have expired at the given point, the member is assumed to be a standard member, and the function returns information about the Standard membership. This will also happen if a member wasnt actually registered in the database at that point - the function will still return info about Standard membership, not the Non-member one.
If there is no profile with the given $iMemberId, the function returns information about the Non-member predefined membership.
The Standard and Non-member memberships have their DateStarts and DateExpires attributes set to NULL.
| int | $iMemberId | - ID of a member to get info about |
| int | $time | - specifies the time to use when determining membership; if not specified, the function takes the current time |
Definition at line 234 of file membership_levels.inc.php.
| getMemberMembershipInfo_current | ( | $iMemberId, | |
$time = '' |
|||
| ) |
Returns number of members with a given membership at a given time
| int | $iMembershipId | - members of what membership should be counted. if 0, then all members are counted ($except is not considered); if MEMBERSHIP_ID_NON_MEMBER is specified, function returns -1 |
| unix_timestamp | $time | - date/time to use when counting members. if not specified, uses the present moment |
| boolean | $except | - if true, counts all members that DON'T have specified membership This is an internal function - do NOT use it outside of membership_levels.inc.php! |
Fetch the last purchased/assigned membership that is still active for the given member. NOTE. Don't use cache here, because it's causing an error, if a number of memberrship levels are purchased at the same time. fromMemory returns the same DateExpires because buyMembership function is called in cycle in the same session.
no such member found
no purchased/assigned memberships for the member or all of them have expired – the member is assumed to have Standard membership
Definition at line 121 of file membership_levels.inc.php.
| getMemberMembershipInfo_latest | ( | $iMemberId, | |
$iTime = '' |
|||
| ) |
This is an internal function - do NOT use it outside of membership_levels.inc.php!
Definition at line 185 of file membership_levels.inc.php.
| getMembershipInfo | ( | $iMembershipId | ) |
Get info about a given membership
| int | $iMembershipId | - membership to get info about |
Definition at line 724 of file membership_levels.inc.php.
| getMembershipPrices | ( | $iMembershipId | ) |
Get pricing options for the given membership
| int | $iMembershipId | - membership to get prices for |
Definition at line 698 of file membership_levels.inc.php.
| getMemberships | ( | $purchasableOnly = false | ) |
Get the list of existing memberships
| bool | $purchasableOnly | - if true, fetches only purchasable memberships; 'purchasable' here means that:
|
Definition at line 670 of file membership_levels.inc.php.
| markMembershipAsExpiring | ( | $iMemberId, | |
| $iLevelId, | |||
| $sTransactionId | |||
| ) |
Definition at line 778 of file membership_levels.inc.php.
| membershipActionsCmp | ( | $a, | |
| $b | |||
| ) |
Definition at line 760 of file membership_levels.inc.php.
| setMembership | ( | $iMemberId, | |
| $iMembershipId, | |||
$iDays = 0, |
|||
$bStartsNow = false, |
|||
$sTransactionId = '', |
|||
$isSendMail = true |
|||
| ) |
Set a membership for a member
| int | $iMemberId | - member that is going to get the membership |
| int | $iMembershipId | - membership that is going to be assigned to the member if $iMembershipId == MEMBERSHIP_ID_STANDARD then $days and $bStartsNow parameters are not used, so Standard membership is always set immediately and forever |
| int | $days | - number of days to set membership for if 0, then the membership is set forever |
| boolean | $bStartsNow | - if true, the membership will start immediately; if false, the membership will start after the current membership expires |
Setting Standard membership level
make the membership starts after the latest membership expires or return false if latest membership isn't Standard and is lifetime membership
set lifetime membership if 0 days is used.
Definition at line 561 of file membership_levels.inc.php.
| translateMembershipActions | ( | & | $aActions | ) |
Definition at line 766 of file membership_levels.inc.php.
| unmarkMembershipAsExpiring | ( | $iMemberId, | |
| $iLevelId, | |||
| $sTransactionId | |||
| ) |
Definition at line 788 of file membership_levels.inc.php.
| unmarkMembershipAsExpiringAll | ( | ) |
Definition at line 798 of file membership_levels.inc.php.
| const ACTION_ID_COMMENTS_EDIT_OWN 8 |
Definition at line 42 of file membership_levels.inc.php.
| const ACTION_ID_COMMENTS_POST 6 |
Definition at line 40 of file membership_levels.inc.php.
| const ACTION_ID_COMMENTS_REMOVE_OWN 9 |
Definition at line 43 of file membership_levels.inc.php.
| const ACTION_ID_COMMENTS_VOTE 7 |
Definition at line 41 of file membership_levels.inc.php.
| const ACTION_ID_GET_EMAIL 5 |
Definition at line 39 of file membership_levels.inc.php.
| const ACTION_ID_SEND_FRIEND_REQUEST 10 |
Definition at line 44 of file membership_levels.inc.php.
| const ACTION_ID_SEND_MESSAGE 4 |
Definition at line 38 of file membership_levels.inc.php.
| const ACTION_ID_SEND_VKISS 1 |
Definition at line 35 of file membership_levels.inc.php.
| const ACTION_ID_VIEW_PROFILES 2 |
Definition at line 36 of file membership_levels.inc.php.
| const ACTION_ID_VOTE 3 |
Definition at line 37 of file membership_levels.inc.php.
| const CHECK_ACTION_LANG_FILE_ACTION 1 |
Definition at line 25 of file membership_levels.inc.php.
| const CHECK_ACTION_LANG_FILE_AFTER 5 |
Definition at line 29 of file membership_levels.inc.php.
| const CHECK_ACTION_LANG_FILE_BEFORE 6 |
Definition at line 30 of file membership_levels.inc.php.
| const CHECK_ACTION_LANG_FILE_LIMIT 3 |
Definition at line 27 of file membership_levels.inc.php.
| const CHECK_ACTION_LANG_FILE_MEMBERSHIP 2 |
Definition at line 26 of file membership_levels.inc.php.
| const CHECK_ACTION_LANG_FILE_PERIOD 4 |
Definition at line 28 of file membership_levels.inc.php.
| const CHECK_ACTION_LANG_FILE_SITE_EMAIL 7 |
Definition at line 31 of file membership_levels.inc.php.
| const CHECK_ACTION_MESSAGE 1 |
Definition at line 55 of file membership_levels.inc.php.
| const CHECK_ACTION_MESSAGE_LIMIT_REACHED "_ACTION_LIMIT_REACHED" |
Definition at line 18 of file membership_levels.inc.php.
| const CHECK_ACTION_MESSAGE_MESSAGE_EVERY_PERIOD "_ACTION_EVERY_PERIOD" |
Definition at line 19 of file membership_levels.inc.php.
| const CHECK_ACTION_MESSAGE_NOT_ACTIVE "_ACTION_NOT_ACTIVE" |
Definition at line 17 of file membership_levels.inc.php.
| const CHECK_ACTION_MESSAGE_NOT_ALLOWED "_ACTION_NOT_ALLOWED" |
This work, "Cheetah - https://www.cheetahwsb.com", is a derivative of "Dolphin Pro V7.4.2" by BoonEx Pty Limited - https://www.boonex.com/, used under CC-BY. "Cheetah" is licensed under CC-BY by Dean J. Bassett Jr. CC-BY License - http://creativecommons.org/licenses/by/3.0/
Definition at line 16 of file membership_levels.inc.php.
| const CHECK_ACTION_MESSAGE_NOT_ALLOWED_AFTER "_ACTION_NOT_ALLOWED_AFTER" |
Definition at line 21 of file membership_levels.inc.php.
| const CHECK_ACTION_MESSAGE_NOT_ALLOWED_BEFORE "_ACTION_NOT_ALLOWED_BEFORE" |
Definition at line 20 of file membership_levels.inc.php.
| const CHECK_ACTION_PARAMETER 3 |
Definition at line 56 of file membership_levels.inc.php.
| const CHECK_ACTION_RESULT 0 |
Definition at line 54 of file membership_levels.inc.php.
| const CHECK_ACTION_RESULT_ALLOWED 0 |
Definition at line 60 of file membership_levels.inc.php.
| const CHECK_ACTION_RESULT_LIMIT_REACHED 3 |
Definition at line 63 of file membership_levels.inc.php.
| const CHECK_ACTION_RESULT_NOT_ACTIVE 2 |
Definition at line 62 of file membership_levels.inc.php.
| const CHECK_ACTION_RESULT_NOT_ALLOWED 1 |
Definition at line 61 of file membership_levels.inc.php.
| const CHECK_ACTION_RESULT_NOT_ALLOWED_AFTER 5 |
Definition at line 65 of file membership_levels.inc.php.
| const CHECK_ACTION_RESULT_NOT_ALLOWED_BEFORE 4 |
Definition at line 64 of file membership_levels.inc.php.
| const MEMBERSHIP_ID_NON_MEMBER 1 |
Definition at line 48 of file membership_levels.inc.php.
| const MEMBERSHIP_ID_PROMOTION 3 |
Definition at line 50 of file membership_levels.inc.php.
| const MEMBERSHIP_ID_STANDARD 2 |
Definition at line 49 of file membership_levels.inc.php.
1.8.20