/sources/ocf_members.php

Description
Description | Functions
Functions
Description | Functions
init__ocf_members (line 24)

Standard code module initialisation function.

void init__ocf_members ()
ocf_authusername_is_bound_via_httpauth (line 60)

Find whether a member of a certain username is bound to HTTP authentication (an exceptional situation, only for sites that use it).

  • return: The member ID, if it is (NULL: not bound).
?integer ocf_authusername_is_bound_via_httpauth (string $authusername)
  • string $authusername: The username.
ocf_get_all_custom_fields_match (line 109)

Gets all the system custom fields that match certain parameters.

  • return: A list of rows of such fields.
array ocf_get_all_custom_fields_match (?array $groups, [?BINARY $public_view = NULL], [?BINARY $owner_view = NULL], [?BINARY $owner_set = NULL], [?BINARY $required = NULL], [?BINARY $show_in_posts = NULL], [?BINARY $show_in_post_previews = NULL], [BINARY $special_start = 0], [?boolean $show_on_join_form = NULL])
  • ?array $groups: That are applicable only to one of the usergroups in this list (empty: CPFs with no restriction) (NULL: disregard restriction).
  • ?BINARY $public_view: That are publicly viewable (NULL: don't care).
  • ?BINARY $owner_view: That are owner viewable (NULL: don't care).
  • ?BINARY $owner_set: That are owner settable (NULL: don't care).
  • ?BINARY $required: That are required (NULL: don't care).
  • ?BINARY $show_in_posts: That are to be shown in posts (NULL: don't care).
  • ?BINARY $show_in_post_previews: That are to be shown in post previews (NULL: don't care).
  • BINARY $special_start: That start 'ocp_'
  • ?boolean $show_on_join_form: That are to go on the join form (NULL: don't care).
ocf_get_all_custom_fields_match_member (line 187)

Gets all a member's custom fields that match certain parameters.

  • return: A mapping of field key to field value.
array ocf_get_all_custom_fields_match_member (MEMBER $member_id, [?BINARY $public_view = NULL], [?BINARY $owner_view = NULL], [?BINARY $owner_set = NULL], [?BINARY $encrypted = NULL], [?BINARY $required = NULL], [?BINARY $show_in_posts = NULL], [?BINARY $show_in_post_previews = NULL], [boolean $special_start = false], [?BINARY $show_on_join_form = NULL])
  • MEMBER $member_id: The member.
  • ?BINARY $public_view: That are publically viewable (NULL: don't care).
  • ?BINARY $owner_view: That are owner viewable (NULL: don't care).
  • ?BINARY $owner_set: That are owner settable (NULL: don't care).
  • ?BINARY $encrypted: That are encrypted (NULL: don't care).
  • ?BINARY $required: That are required (NULL: don't care).
  • ?BINARY $show_in_posts: That are to be shown in posts (NULL: don't care).
  • ?BINARY $show_in_post_previews: That are to be shown in post previews (NULL: don't care).
  • boolean $special_start: That start 'ocp_'
  • ?BINARY $show_on_join_form: That are to go on the join form (NULL: don't care).
ocf_get_custom_fields_member (line 323)

Returns a mapping between field number and field value. Doesn't take translation into account. Doesn't take anything permissive into account.

  • return: The mapping.
array ocf_get_custom_fields_member (MEMBER $member_id)
  • MEMBER $member_id: The member.
ocf_get_custom_field_mappings (line 281)

Returns a list of all field values for user. Doesn't take translation into account. Doesn't take anything permissive into account.

  • return: The list.
array ocf_get_custom_field_mappings (MEMBER $member_id)
  • MEMBER $member_id: The member.
ocf_get_filter_cats (line 41)

Find all the personal topic filter categories employed by the current member.

  • return: List of filter categories
array ocf_get_filter_cats ()
ocf_get_member_primary_group (line 343)

Get the primary of a member (supports consulting of LDAP).

  • return: The primary.
GROUP ocf_get_member_primary_group (MEMBER $member_id)
  • MEMBER $member_id: The member.
ocf_is_httpauth_member (line 89)

Find whether a member is bound to HTTP authentication (an exceptional situation, only for sites that use it).

  • return: The answer.
boolean ocf_is_httpauth_member (MEMBER $member_id)
  • MEMBER $member_id: The member.
ocf_is_ldap_member (line 74)

Find whether a member is bound to HTTP LDAP (an exceptional situation, only for sites that use it).

  • return: The answer.
boolean ocf_is_ldap_member (MEMBER $member_id)
  • MEMBER $member_id: The member.

Documentation generated on Sun, 02 Jan 2011 23:19:55 +0000 by phpDocumentor 1.4.3