/sources/ocf_forum_driver_helper_install.php

Description
Functions
_helper_install_create_custom_field (line 39)

Add the specified custom field to the forum (some forums implemented this using proper custom profile fields, others through adding a new field).

  • return: Whether the custom field was created successfully
boolean _helper_install_create_custom_field (object Link $this_ref, string $name, integer $length, [BINARY $locked = 1], [BINARY $viewable = 0], [BINARY $settable = 0], [BINARY $required = 0], [string $description = ''], [string $type = 'long_text'], [BINARY $encrypted = 0], [?string $default = NULL])
  • object Link $this_ref: to the real forum driver
  • string $name: The name of the new custom field
  • integer $length: The length of the new custom field
  • BINARY $locked: Whether the field is locked
  • BINARY $viewable: Whether the field is for viewing
  • BINARY $settable: Whether the field is for setting
  • BINARY $required: Whether the field is required
  • string $description: Description
  • string $type: The field type
  • BINARY $encrypted: Whether the field is encrypted
  • ?string $default: Default field value (NULL: standard for field type)
_helper_install_specifics (line 69)

Get an array of attributes to take in from the installer. Almost all forums require a table prefix, which the requirement there-of is defined through this function.

The attributes have 4 values in an array

  • name, the name of the attribute for info.php
  • default, the default value (perhaps obtained through autodetection from forum config)
  • description, a textual description of the attributes
  • title, a textual title of the attribute

  • return: The attributes for the forum
array _helper_install_specifics ()
_helper_install_test_load_from (line 100)

Searches for forum auto-config at this path.

  • return: Whether the forum auto-config could be found
boolean _helper_install_test_load_from (PATH $path)
  • PATH $path: The path in which to search

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