Inheritance diagram for Member_Model:

Public Member Functions
	get_member_joined ($member_id=NULL)
	Gets joined values of member for members fees.
	get_members_joined ($member_id=NULL)
	Gets joined values of members for members fees.
	get_active_traffic_members_ip_addresses ($day)
	Returns IP addresses of the most traffic-active members.
	get_all_members ($limit_from=0, $limit_results=50, $order_by= 'id', $order_by_direction= 'asc', $filter_sql= '')
	Function gets list of all members from database.
	get_registered_applicants ($limit_from=0, $limit_results=50, $order_by= 'id', $order_by_direction= 'asc', $filter_sql= '')
	Function gets list of registered applicans.
	count_all_members ($filter_sql="")
	Function counts all members.
	count_all_registered_applicants ($filter_sql= '')
	Function gets count of registered applicans.
	get_all_members_to_export ($filter_sql= '')
	Function gets all members to export.
	get_members_to_sync_vtiger ($ids, $in_set)
	Function gets selected members.
	get_members_to_messages ($type)
	Returns all members sccording to the type of message.
	get_members_of_subnet ($subnet_id, $order_by= 'id')
	Function gets all members who have at least one ip address in given subnet.
	get_members_of_cloud ($cloud_id, $order_by= 'id')
	Gets all members of cloud.
	get_member_by_crc_id ($vs)
	This function can be used for checking the validity of payment variable symbols and finding the related member.
	find_member_id_by_phone ($phone)
	This function is used in the Accounts_controller - e.g.
	find_member_by_phone ($phone)
	Find member by phone.
	count_all_members_to_ulogd ()
	Returns count of all non-former members without membership interrupt in that time and without set-up qos rate.
	get_all_members_to_dropdown ()
	Returns all members to dropdown.
	select_list_grouped ($optgroup=TRUE)
	Gets array of members for selectbox.
	get_doubleentry_account ($account_attribute_id)
	Returns doubleentry account of member by given account attribute id.
	get_all_as_array ()
	Returns all members as array.
	get_login ()
	Returns login of member.
	get_main_user ($member_id=NULL)
	Returns ID of main user of member.
	get_all_entrance_and_leaving_dates ($filter_sql= '')
	Gets all entrance and leaving dates.
	delete_accounts ($member_id)
	Deletes members accounts.
	delete_members_devices ($member_id)
	Deletes all devices and IP addresses of the given member or members.
	get_balance ($member_id=NULL)
	Returns balance of current member.
	has_membership_interrupt ($date=NULL, $member_id=NULL)
	Checks whether current member has membership interrupt in given date.
	has_whitelist ($member_id=NULL)
	Has member activates a whitelist?
	reactivate_messages ($member_id=NULL)
	Reactivates (rechecks) system messages for current member.
	update_member_registrations ($ids=array(), $registrations=array())
	Updates state of members registrations.
	add_today_former_members ()
	Adds today former members (members that have set leaving date that is less or equal than today and their type is not former).
	get_members_qos_ceil_rate ()
	Returns members with set-up qos ceil or rate.
	get_today_former_members ()
	Returns today former members (for auto notification)
	get_all_former_members ()
	Returns all former members (for auto redirection)
	get_interrupted_members_on ($date=NULL, $operation=1)
	Returns all interrupted members (for auto redirection)
	get_all_former_members_without_debt ()
	Returns all former members without debt (used to membership transfer)
	get_credit_account ($member_id=NULL)
	Return credit account of member.

Static Public Member Functions
static	get_type ($type)
	Returns type in string from integer.

Public Attributes
const	TYPE_APPLICANT = 1
	Type of member: applicant.
const	TYPE_REGULAR = 2
	Type of member: regular.
const	TYPE_HONORARY = 3
	Type of member: honorary.
const	TYPE_SYMPATHIZING = 4
	Type of member: sympatizing.
const	TYPE_NON = 5
	Type of member: non.
const	TYPE_FEE_FREE = 6
	Type of member: fee-free.
const	TYPE_FORMER = 15
	Type of member: former.
const	ASSOCIATION = 1
	Association member ID.

Protected Attributes
	$has_one
	$has_many
	$belongs_to = array('address_point', 'user', 'speed_class')

Member Function Documentation

Member_Model::add_today_former_members ( )

Adds today former members (members that have set leaving date that is less or equal than today and their type is not former).

Author: Ondrej Fibich

Member_Model::count_all_members ( $filter_sql = "" )

Function counts all members.

!!!!!! SECURITY WARNING !!!!!! Be careful when you using this method, param $filter_sql is unprotected for SQL injections, security should be made at controller site using Filter_form class. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Parameters

string $filter_values

Returns: integer

Member_Model::count_all_members_to_ulogd ( )

Returns count of all non-former members without membership interrupt in that time and without set-up qos rate.

Author: Michal Kliment

Returns: integer

Member_Model::count_all_registered_applicants ( $filter_sql = '' )

Function gets count of registered applicans.

Parameters

string $filter_sql used for filtering

Returns: integer

Member_Model::delete_accounts ( $member_id )

Deletes members accounts.

Parameters

integer $member_id

Member_Model::delete_members_devices ( $member_id )

Deletes all devices and IP addresses of the given member or members.

Author: Ondrej Fibich

Parameters

integer | array $member_id Member ID or multiple IDs

Member_Model::find_member_by_phone ( $phone )

Find member by phone.

Author: Tomas Dulik, Ondřej Fibich

Returns: Mysql_Result

Member_Model::find_member_id_by_phone ( $phone )

This function is used in the Accounts_controller - e.g.

in the function "store_transfer_ebanka" for finding the member who made a bank transaction where variable symbol = his phone number Similar function with different purpose can be found in get_member_by_phone

Parameters

string $phone string containing a phone number

Returns: Mysql_Result first member_id of a member with given phone number

Member_Model::get_active_traffic_members_ip_addresses ( $day )

Returns IP addresses of the most traffic-active members.

Parameters

string $day

See Also: Web_interface_Controller::active_traffic_members_ip_addresses

Author: Michal Kliment

Returns: Mysql_Result

Member_Model::get_all_as_array ( )

Returns all members as array.

Author: Michal Kliment, Ondřej Fibich

Returns: array

Member_Model::get_all_entrance_and_leaving_dates ( $filter_sql = '' )

Gets all entrance and leaving dates.

Parameters

string $filter_sql

Returns: Mysql_Result

Member_Model::get_all_former_members ( )

Returns all former members (for auto redirection)

Author: Ondrej Fibich

Returns: Database_Result

Member_Model::get_all_former_members_without_debt ( )

Returns all former members without debt (used to membership transfer)

Author: Michal Kliment

Returns: Database_Result

Member_Model::get_all_members	(	$limit_from = `0`,
		$limit_results = `50`,
		$order_by = `'id'`,
		$order_by_direction = `'asc'`,
		$filter_sql = `''`
	)

Function gets list of all members from database.

!!!!!! SECURITY WARNING !!!!!! Be careful when you using this method, param $filter_sql is unprotected for SQL injections, security should be made at controller site using Filter_form class. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Parameters

$limit_from	starting row
$limit_results	number of rows
$order_by	sorting column
$order_by_direction	sorting direction
$filter_values	used for filtering

Returns: Mysql_Result

Member_Model::get_all_members_to_dropdown ( )

Returns all members to dropdown.

Todo:: I think this format is better than default select list

Author: Michal Kliment

Returns: Mysql_Result object

Member_Model::get_all_members_to_export ( $filter_sql = '' )

Function gets all members to export.

!!!!!! SECURITY WARNING !!!!!! Be careful when you using this method, param $filter_sql is unprotected for SQL injections, security should be made at controller site using Filter_form class. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Parameters

string $filter_values

Author: Jiri Svitak, Ondřej Fibich

Returns: Mysql_Result

Member_Model::get_balance ( $member_id = NULL )

Returns balance of current member.

Author: Michal Kliment

Parameters

integer $member_id

Returns: integer

Member_Model::get_credit_account ( $member_id = NULL )

Return credit account of member.

Author: Michal Kliment

Parameters

type $member_id

Returns: type

Member_Model::get_doubleentry_account ( $account_attribute_id )

Returns doubleentry account of member by given account attribute id.

Author: Michal Kliment

Parameters

integer $account_attribute_id

Returns: Mysql_Result object

Member_Model::get_interrupted_members_on	(	$date = `NULL`,
		$operation = `1`
	)

Returns all interrupted members (for auto redirection)

Author: Ondrej Fibich

Parameters

string	$date	Date in format Y-m-d [optional]
integer	$operation	Operation [optional] 1 .. date must be between interrupted interval 2 .. date must be begin of interrupted interval 3 .. date must be end of interrupted interval

Returns: Database_Result

Member_Model::get_login ( )

Returns login of member.

Author: Michal Kliment

Returns: string

Member_Model::get_main_user ( $member_id = NULL )

Returns ID of main user of member.

Author: Ondřej Fibich

Returns: integer|null

Member_Model::get_member_by_crc_id ( $vs )

This function can be used for checking the validity of payment variable symbols and finding the related member.

If the variable symbol was generated from member id using crc16 function, then it is easy to check if the variable symbol is OK and extract the member id from it.

Author: Tomas Dulik

Parameters

$vs	- string containing variable symbol (concatenation of member id and its crc16)

Returns: object containing the member

Member_Model::get_member_joined ( $member_id = NULL )

Gets joined values of member for members fees.

Parameters

integer $member_id

Returns: Member_Model

Member_Model::get_members_joined ( $member_id = NULL )

Gets joined values of members for members fees.

Parameters

integer $member_id

Returns: ORM_Iterator

Member_Model::get_members_of_cloud	(	$cloud_id,
		$order_by = `'id'`
	)

Gets all members of cloud.

Parameters

integer	$cloud_id
string	$order_by

Returns: Mysql_Result

Member_Model::get_members_of_subnet	(	$subnet_id,
		$order_by = `'id'`
	)

Function gets all members who have at least one ip address in given subnet.

Author: Jiri Svitak

Parameters

integer	$subnet_id
string	$order_by

Returns: Mysql_Result

Member_Model::get_members_qos_ceil_rate ( )

Returns members with set-up qos ceil or rate.

Author: Michal Kliment

Returns: MySQL Result

Member_Model::get_members_to_messages ( $type )

Returns all members sccording to the type of message.

This method does not handle whitelists. (members with witelists are returned anyway and they must be filtered after).

THIS IS ONE OF THE MOST IMPORTANT SQL QUERY IN THE WHOLE SYSTEM PLEASE BE VERY CAREFUL WITH EDITING OF IT.

Author: Michal Kliment, Ondrej Fibich

Parameters

string	$order_by
string	$order_by_direction

Returns: MySQL Result

Member_Model::get_members_to_sync_vtiger	(	$ids,
		$in_set
	)

Function gets selected members.

Parameters

array	$ids
boolean	$in_set

Author: Jan Dubina

Returns: Mysql_Result

Member_Model::get_registered_applicants	(	$limit_from = `0`,
		$limit_results = `50`,
		$order_by = `'id'`,
		$order_by_direction = `'asc'`,
		$filter_sql = `''`
	)

Function gets list of registered applicans.

Parameters

	$limit_from	starting row
	$limit_results	number of rows
	$order_by	sorting column
	$order_by_direction	sorting direction
string	$filter_sql	used for filtering

Returns: Mysql_Result

Member_Model::get_today_former_members ( )

Returns today former members (for auto notification)

Author: Ondrej Fibich

Returns: Database_Result

static Member_Model::get_type ( $type )

static

Returns type in string from integer.

Parameters

integer | string $type

Returns: string

Member_Model::has_membership_interrupt	(	$date = `NULL`,
		$member_id = `NULL`
	)

Checks whether current member has membership interrupt in given date.

Author: Michal Kliment

Parameters

string	$date
integer	$member_id

Returns: bool

Member_Model::has_whitelist ( $member_id = NULL )

Has member activates a whitelist?

Parameters

integer $member_id [optional]

Member_Model::reactivate_messages ( $member_id = NULL )

Reactivates (rechecks) system messages for current member.

Author: Michal Kliment

Parameters

integer $member_id

Returns: bool

Member_Model::select_list_grouped ( $optgroup = TRUE )

Gets array of members for selectbox.

Returns: array[string]

Member_Model::update_member_registrations	(	$ids = `array()`,
		$registrations = `array()`
	)

Updates state of members registrations.

Author: Michal Kliment

Parameters

array	$ids
array	$registrations

Member Data Documentation

Member_Model::$has_many

protected

Initial value:

 array
        (
                'allowed_subnets', 'invoices', 'users', 'accounts',
                'transfers', 'bank_accounts', 'membership_interrupts',
                'connection_requests', 'members_whitelists'
        )

Member_Model::$has_one

protected

Initial value:

 array
        (
                'allowed_subnets_count', 'members_traffic', 'members_domicile'
        )

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

member.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Member Function Documentation

Member Data Documentation