/install.php

Description
Description | Constants | Functions
Constants
Description | Constants | Functions
FILE_BINARY = false (line 49)
FILE_TEXT = false (line 48)
HIPHOP_PHP = '1' (line 80)
Functions
Description | Constants | Functions
big_installation_common (line 1756)

Parts common to any modular installation step.

void big_installation_common ()
compress_filter (line 2441)

Return decompressed version of the input (at time of writing, no compression being used for quick installer archiving).

  • return: The decompressed file
string compress_filter (string $input)
  • string $input: The file in raw compressed form
example (line 2295)

Get an example string for the installer UI (abstraction).

  • return: The text
tempcode example (string $example, [string $description = ''])
  • string $example: The name of the example text language string (blank: none)
  • string $description: The name of the example description language string (blank: none)
find_forum_path (line 2324)

Using the current forum driver, find the forum path.

  • return: The answer (NULL: could not find the forum)
?URLPATH find_forum_path (string $given)
  • string $given: What the user manually gave as the forum path (may be blank)
get_dir_contents (line 2346)

Get the contents of a directory, with support for searching the installation archive.

  • return: A map of the contents (file=>dir)
array get_dir_contents (PATH $dir, [boolean $php = false])
  • PATH $dir: The directory to get the contents of
  • boolean $php: Whether just to get .php files
handle_self_referencing_embedment (line 2065)

Handle GET URLs requesting embedded media files.

void handle_self_referencing_embedment ()
include_ocf (line 1053)

Jerry-rig a site tied OCF, for basic installation, and prepping incase we switch to it.

void include_ocf ()
make_option (line 2249)

Make the UI for an installer textual option.

  • return: The option
tempcode make_option (tempcode $nice_name, tempcode $description, ID_TEXT $name, string $value, [boolean $hidden = false], [boolean $required = false])
  • tempcode $nice_name: The human readable name for the option
  • tempcode $description: A description of the option
  • ID_TEXT $name: The name of the option
  • string $value: The default/current value of the option
  • boolean $hidden: Whether the options value should be kept star'red out (e.g. it is a password)
  • boolean $required: Whether the option is required
make_tick (line 2282)

Make the UI for an installer tick option.

  • return: The list of usergroups
tempcode make_tick (tempcode $nice_name, tempcode $description, ID_TEXT $name, BINARY $value)
  • tempcode $nice_name: The human readable name for the option
  • tempcode $description: A description of the option
  • ID_TEXT $name: The name of the option
  • BINARY $value: The default/current value of the option
object_factory (line 2057)

Make an object of the given class

  • return: object
object The object_factory (string $class)
  • string $class: The class name
require_code (line 1991)

This function is a very important one when coding. It allows you to include a source code file (from root/sources/ or root/sources_custom/) through the proper channels.

You should remember this function, and not substitute anything else for it, as that will likely make your code unstable. It is key to source code modularity in ocPortal.

void require_code (string $codename)
  • string $codename: The codename for the source module to load
step_1 (line 280)

First installation step.

  • return: Progress report / UI
tempcode step_1 ()
step_2 (line 526)

Second installation step.

  • return: Progress report / UI
tempcode step_2 ()
step_3 (line 550)

Third installation step.

  • return: Progress report / UI
tempcode step_3 ()
step_4 (line 671)

Fourth installation step.

  • return: Progress report / UI
tempcode step_4 ()
step_5 (line 941)

Fifth installation step.

  • return: Progress report / UI
tempcode step_5 ()
step_5_checks (line 1374)

Fifth installation step: sanity checks.

  • return: Progress report / UI
tempcode step_5_checks ()
step_5_core (line 1510)

Fifth installation step: core tables.

  • return: Progress report / UI
tempcode step_5_core ()
step_5_core_2 (line 1618)

Fifth installation step: more core tables.

  • return: Progress report / UI
tempcode step_5_core_2 ()
step_5_ftp (line 1074)

Fifth installation step: FTP upload (not used for manual installer).

  • return: A pair: progress report/ui, and number of files uploaded so far (or -1 meaning all uploaded)
array step_5_ftp ()
step_5_uninstall (line 1481)

Fifth installation step: uninstallation of old install.

  • return: Progress report / UI
tempcode step_5_uninstall ()
step_5_write_config (line 1413)

Fifth installation step: writing of configuration.

  • return: Progress report / UI
tempcode step_5_write_config ()
step_6 (line 1728)

Sixth installation step.

  • return: Progress report / UI
tempcode step_6 ()
step_7 (line 1789)

Seventh installation step.

  • return: Progress report / UI
tempcode step_7 ()
step_8 (line 1824)

Eighth installation step.

  • return: Progress report / UI
tempcode step_8 ()
step_9 (line 1847)

Ninth installation step.

  • return: Progress report / UI
tempcode step_9 ()
step_10 (line 1889)

Tenth installation step: wrapper and special interface.

  • return: Progress report / UI
tempcode step_10 ()
step_10_forum_stuff (line 1959)

Tenth installation step: forum part.

  • return: Progress report / UI
tempcode step_10_forum_stuff ()
step_10_populate_database (line 1928)

Tenth installation step: main.

  • return: Progress report / UI
tempcode step_10_populate_database ()
test_htaccess (line 2451)

Try and get a good .htaccess file built.

void test_htaccess (resource $conn)
  • resource $conn: FTP connection to server
test_writable (line 2313)

Test whether a file exists and is writable.

void test_writable (PATH $file)
  • PATH $file: The file path

Documentation generated on Sun, 02 Jan 2011 23:16:06 +0000 by phpDocumentor 1.4.3