/sources/ocf_members_action2.php

Description
Description | Functions
Functions
Description | Functions
init__ocf_members_action2 (line 24)

Standard code module initialisation function.

void init__ocf_members_action2 ()
ocf_ban_member (line 888)

Ban a member.

void ocf_ban_member (AUTO_LINK $member_id, LONG_TEXT $reason)
  • AUTO_LINK $member_id: The ID of the member.
  • LONG_TEXT $reason: The reason for the banning.
ocf_check_name_valid (line 1090)

Check a username is valid for adding, and possibly also the password.

  • return: Error (NULL: none).
?tempcode ocf_check_name_valid (SHORT_TEXT $username, [?MEMBER $member_id = NULL], [?SHORT_TEXT $password = NULL], [boolean $return_errors = false])
  • SHORT_TEXT $username: The username.
  • ?MEMBER $member_id: The member (NULL: member not actually added yet; this ID is only given for the duplication check, to make sure it doesn't think we are duplicating with ourself).
  • ?SHORT_TEXT $password: The password (NULL: nothing to check).
  • boolean $return_errors: Whether to return errors instead of dieing on them.
ocf_delete_custom_field (line 1004)

Delete a custom profile field.

void ocf_delete_custom_field (AUTO_LINK $id)
  • AUTO_LINK $id: The ID of the custom profile field.
ocf_delete_member (line 844)

Delete a member.

void ocf_delete_member (AUTO_LINK $member_id)
  • AUTO_LINK $member_id: The ID of the member.
ocf_edit_custom_field (line 938)

Edit a custom profile field.

void ocf_edit_custom_field (AUTO_LINK $id, SHORT_TEXT $name, SHORT_TEXT $description, LONG_TEXT $default, BINARY $public_view, BINARY $owner_view, BINARY $owner_set, BINARY $encrypted, BINARY $required, BINARY $show_in_posts, BINARY $show_in_post_previews, integer $order, LONG_TEXT $only_group, ID_TEXT $type, BINARY $show_on_join_form)
  • AUTO_LINK $id: The ID of the custom profile field.
  • SHORT_TEXT $name: Name of the field.
  • SHORT_TEXT $description: Description of the field.
  • LONG_TEXT $default: The default value for the field.
  • BINARY $public_view: Whether the field is publically viewable.
  • BINARY $owner_view: Whether the field is viewable by the owner.
  • BINARY $owner_set: Whether the field may be set by the owner.
  • BINARY $encrypted: Whether the field should be encrypted.
  • BINARY $required: Whether the field is to be shown on the join form
  • BINARY $show_in_posts: Whether this field is shown in posts and places where member details are highlighted (such as an image in a member gallery).
  • BINARY $show_in_post_previews: Whether this field is shown in preview places, such as in the teaser for a member gallery.
  • integer $order: The order of this field relative to other fields.
  • LONG_TEXT $only_group: The usergroups that this field is confined to (comma-separated list).
  • ID_TEXT $type: The type of the field.
  • BINARY $show_on_join_form: Whether it is required that every member have this field filled in.
ocf_edit_member (line 672)

Edit a member.

void ocf_edit_member (AUTO_LINK $member_id, ?SHORT_TEXT $email_address, ?BINARY $preview_posts, ?integer $dob_day, ?integer $dob_month, ?integer $dob_year, ?integer $timezone_offset, ?GROUP $primary_group, array $custom_fields, ?ID_TEXT $theme, ?BINARY $reveal_age, ?BINARY $views_signatures, ?BINARY $track_contributed_topics, ?LANGUAGE_NAME $language, ?BINARY $allow_emails, [?BINARY $validated = NULL], [?string $username = NULL], [?string $password = NULL], [?BINARY $zone_wide = 1], [?BINARY $highlighted_name = NULL], [?SHORT_TEXT $pt_allow = '*'], [?LONG_TEXT $pt_rules_text = ''], [?TIME $on_probation_until = NULL], [?TIME $join_time = NULL], [?URLPATH $avatar_url = NULL], [?LONG_TEXT $signature = NULL], [?BINARY $is_perm_banned = NULL], [?URLPATH $photo_url = NULL], [?URLPATH $photo_thumb_url = NULL], [?SHORT_TEXT $salt = NULL], [?ID_TEXT $password_compatibility_scheme = NULL], [boolean $skip_checks = false])
  • AUTO_LINK $member_id: The ID of the member.
  • ?SHORT_TEXT $email_address: The e-mail address. (NULL: don't change)
  • ?BINARY $preview_posts: Whether posts are previewed before they are made. (NULL: don't change)
  • ?integer $dob_day: Day of date of birth. (NULL: don't change)
  • ?integer $dob_month: Month of date of birth. (NULL: don't change)
  • ?integer $dob_year: Year of date of birth. (NULL: don't change)
  • ?integer $timezone_offset: The offset of the members time zone relative to the server time zone. (NULL: don't change)
  • ?GROUP $primary_group: The members primary (NULL: don't change).
  • array $custom_fields: A map of custom fields values (field-id=>value).
  • ?ID_TEXT $theme: The members default theme. (NULL: don't change)
  • ?BINARY $reveal_age: Whether the members age may be shown. (NULL: don't change)
  • ?BINARY $views_signatures: Whether the member sees signatures in posts. (NULL: don't change)
  • ?BINARY $track_contributed_topics: Whether the member tracks topics they post in automatically. (NULL: don't change)
  • ?LANGUAGE_NAME $language: The members language. (NULL: don't change)
  • ?BINARY $allow_emails: Whether the member allows e-mails via the site. (NULL: don't change)
  • ?BINARY $validated: Whether the profile has been validated (NULL: do not change this). (NULL: don't change)
  • ?string $username: The username. (NULL: don't change)
  • ?string $password: The password. (NULL: don't change)
  • ?BINARY $zone_wide: Whether the member likes to view zones without menus, when a choice is available. (NULL: don't change)
  • ?BINARY $highlighted_name: Whether the member username will be highlighted. (NULL: don't change)
  • ?SHORT_TEXT $pt_allow: Usergroups that may PT the member. (NULL: don't change)
  • ?LONG_TEXT $pt_rules_text: Rules that other members must agree to before they may start a PT with the member. (NULL: don't change)
  • ?TIME $on_probation_until: When the member is on probation until (NULL: don't change)
  • ?TIME $join_time: When the member joined (NULL: don't change)
  • ?URLPATH $avatar_url: Avatar (NULL: don't change)
  • ?LONG_TEXT $signature: Signature (NULL: don't change)
  • ?BINARY $is_perm_banned: Banned status (NULL: don't change)
  • ?URLPATH $photo_url: Photo URL (NULL: don't change)
  • ?URLPATH $photo_thumb_url: URL of thumbnail of photo (NULL: don't change)
  • ?SHORT_TEXT $salt: Password salt (NULL: don't change)
  • ?ID_TEXT $password_compatibility_scheme: Password compatibility scheme (NULL: don't change)
  • boolean $skip_checks: Whether to skip security checks and most of the change-triggered emails
ocf_get_member_fields (line 271)

Get form fields for adding/editing/finishing a member profile.

  • return: A pair: The form fields, Hidden fields (both Tempcode).
array ocf_get_member_fields ([boolean $mini_mode = true], [?MEMBER $member_id = NULL], [?array $groups = NULL], [SHORT_TEXT $email_address = ''], [BINARY $preview_posts = 0], [?integer $dob_day = NULL], [?integer $dob_month = NULL], [?integer $dob_year = NULL], [integer $timezone_offset = 0], [?array $custom_fields = NULL], [?ID_TEXT $theme = NULL], [BINARY $reveal_age = 1], [BINARY $views_signatures = 1], [BINARY $track_contributed_topics = 1], [?LANGUAGE_NAME $language = NULL], [BINARY $allow_emails = 1], [BINARY $validated = 1], [?GROUP $primary_group = NULL], [SHORT_TEXT $username = ''], [BINARY $is_perm_banned = 0], [ID_TEXT $special_type = ''], [BINARY $zone_wide = 1], [BINARY $highlighted_name = 0], [SHORT_TEXT $pt_allow = '*'], [LONG_TEXT $pt_rules_text = ''], [?TIME $on_probation_until = NULL])
  • boolean $mini_mode: Whether we are only handling the essential details of a profile.
  • ?MEMBER $member_id: The ID of the member we are handling (NULL: new member).
  • ?array $groups: A list of usergroups (NULL: default/current usergroups).
  • SHORT_TEXT $email_address: The e-mail address.
  • BINARY $preview_posts: Whether posts are previewed before they are made.
  • ?integer $dob_day: Day of date of birth (NULL: not known).
  • ?integer $dob_month: Month of date of birth (NULL: not known).
  • ?integer $dob_year: Year of date of birth (NULL: not known).
  • integer $timezone_offset: The offset of the members time zone relative to the server time zone.
  • ?array $custom_fields: A map of custom fields values (field-id=>value) (NULL: not known).
  • ?ID_TEXT $theme: The members default theme (NULL: not known).
  • BINARY $reveal_age: Whether the members age may be shown.
  • BINARY $views_signatures: Whether the member sees signatures in posts.
  • BINARY $track_contributed_topics: Whether the member tracks topics they post in automatically.
  • ?LANGUAGE_NAME $language: The members language (NULL: auto detect).
  • BINARY $allow_emails: Whether the member allows e-mails via the site.
  • BINARY $validated: Whether the profile has been validated.
  • ?GROUP $primary_group: The members primary (NULL: not known).
  • SHORT_TEXT $username: The username.
  • BINARY $is_perm_banned: Whether the member is permanently banned.
  • ID_TEXT $special_type: The special type of profile this is (blank: not a special type).
  • BINARY $zone_wide: Whether the member likes to view zones without menus, when a choice is available.
  • BINARY $highlighted_name: Whether the member username will be highlighted.
  • SHORT_TEXT $pt_allow: Usergroups that may PT the member.
  • LONG_TEXT $pt_rules_text: Rules that other members must agree to before they may start a PT with the member.
  • ?TIME $on_probation_until: When the member is on probation until (NULL: just finished probation / or effectively was never on it)
ocf_member_choose_avatar (line 1243)

Edit a member's avatar, and check validity.

void ocf_member_choose_avatar (URLPATH $avatar_url, [?MEMBER $member_id = NULL])
  • URLPATH $avatar_url: The new avatar URL.
  • ?MEMBER $member_id: The member (NULL: the current member).
ocf_member_choose_photo (line 1319)

Edit a member's photo, and check validity.

void ocf_member_choose_photo (ID_TEXT $param_name, ID_TEXT $upload_name, [?MEMBER $member_id = NULL])
  • ID_TEXT $param_name: The identifier for the name of the posted URL field.
  • ID_TEXT $upload_name: The identifier for the name of the posted upload.
  • ?MEMBER $member_id: The member (NULL: the current member).
ocf_member_choose_signature (line 1220)

Edit a member's signature, and check validity.

void ocf_member_choose_signature (LONG_TEXT $new_signature, [?MEMBER $member_id = NULL])
  • LONG_TEXT $new_signature: The new signature.
  • ?MEMBER $member_id: The member (NULL: the current member).
ocf_member_choose_title (line 1205)

Edit a member's personal title, and check validity.

void ocf_member_choose_title (SHORT_TEXT $new_title, [?MEMBER $member_id = NULL])
  • SHORT_TEXT $new_title: The new title.
  • ?MEMBER $member_id: The member (NULL: the current member).
ocf_member_external_linker (line 116)

Finishing off of a member profile (such as for LDAP or httpauth, where a partial profile is automatically made, but needs completion).

  • return: The member ID for the finished off profile.
MEMBER ocf_member_external_linker (SHORT_TEXT $username, SHORT_TEXT $password, ID_TEXT $type)
  • SHORT_TEXT $username: The username for the member profile.
  • SHORT_TEXT $password: The password for the member profile.
  • ID_TEXT $type: The type of member profile we are finishing off.
ocf_member_external_linker_ask (line 75)

Get a form for finishing off a member profile (such as for LDAP or httpauth, where a partial profile is automatically made, but needs completion).

  • return: The form.
tempcode ocf_member_external_linker_ask (SHORT_TEXT $username, ID_TEXT $type, [string $email = ''])
  • SHORT_TEXT $username: The username for the member profile.
  • ID_TEXT $type: The type of member profile we are finishing off.
  • string $email: Auto-detected e-mail address (blank: none)
ocf_read_in_custom_fields (line 179)

Read in the custom profile field POST data.

  • return: The CPF data.
array ocf_read_in_custom_fields (array $custom_fields, [?MEMBER $member_id = NULL])
  • array $custom_fields: The CPF field rows that we'll be reading in the member's values for.
  • ?MEMBER $member_id: Member involved (NULL: new member)
ocf_set_custom_field (line 1035)

Set a custom profile field for a member.

  • return: Mapping change (NULL: none / can't defer).
?array ocf_set_custom_field (MEMBER $member_id, AUTO_LINK $field, mixed $value, [?ID_TEXT $type = NULL], [boolean $defer = false])
  • MEMBER $member_id: The member.
  • AUTO_LINK $field: The field being set.
  • mixed $value: The value of the field. For a trans-type field, this can be either a lang-ID to be copied (from forum DB), or an actual string.
  • ?ID_TEXT $type: The field type (NULL: look it up).
  • boolean $defer: Whether to defer the change, by returning a result change rather than doing it right away.
ocf_unban_member (line 906)

Unban a member.

void ocf_unban_member (AUTO_LINK $member_id, LONG_TEXT $reason)
  • AUTO_LINK $member_id: The ID of the member.
  • LONG_TEXT $reason: The reason for the unbanning.
validate_ip_script (line 33)

Validate an IP address, indirectly by passing through a confirmation code.

void validate_ip_script ()

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