Docs for page _functions

Procedural File: _functions_install.php

Page Details

This file implements support functions for the installer

Quam Plures - http://quamplures.net/ Released under GNU GPL License - http://quamplures.net/license.html

Copyright:	(c)2003-2009 by Francois PLANQUE - http://fplanque.net/
Copyright:	(c) 2009 - 2011 by the Quam Plures developers - http://quamplures.net/
Filesource:	Source Code for this file

Functions

advanced_properties [line 636]

void advanced_properties(
)

[ Top ]

block_close [line 31]

void block_close(
)

Close a block

[ Top ]

block_open [line 17]

void block_open(
)

Open a block

[ Top ]

cleanup_comment_quotes [line 259]

void cleanup_comment_quotes(
)

Clean up extra quotes in comments

[ Top ]

create_default_settings [line 308]

void create_default_settings(
[array $override = array()] 
)

Insert default settings into T_settings.

It only writes those to DB, that get overridden (passed as array), or have no default in _generalsettings.class.php / GeneralSettings::default.

Parameters:

array

$override:

associative array (settings name => value to use), allows overriding of defaults

[ Top ]

create_relations [line 653]

void create_relations(
)

Create relations

Information Tags:

Todo:

NOT UP TO DATE AT ALL :( -- update field names before activating this

[ Top ]

db_col_exists [line 234]

boolean db_col_exists(
 $table,  $col_name 
)

Parameters:

	$table:
	$col_name:

API Tags:

Return:

Does a given column name exist in DB?

[ Top ]

display_base_config_recap [line 74]

void display_base_config_recap(
)

Base config recap

[ Top ]

display_locale_selector [line 45]

void display_locale_selector(
)

Language selector

[ Top ]

get_db_version [line 206]

void get_db_version(
 $which 
)

Get DB version

returns either the database version or the version during upgrading

Parameters:

$which:

[ Top ]

install_basic_plugins [line 388]

void install_basic_plugins(
[integer $old_db_version = 0] 
)

Install basic plugins.

This gets called separately on fresh installs and installs all plugins found in the qp_plugins folder EXCEPT 'test_plugin' and 'generic_ping_plugin'.

Parameters:

integer

$old_db_version:

Old DB version, so that only new plugins gets installed

[ Top ]

install_basic_templates [line 344]

void install_basic_templates(
)

Install basic templates.

[ Top ]

install_basic_widgets [line 503]

void install_basic_widgets(
)

Install basic widgets.

[ Top ]

install_newdb [line 113]

void install_newdb(
)

Install new DB.

[ Top ]

install_plugin [line 466]

true install_plugin(
 $plugin 
)

Parameters:

$plugin:

API Tags:

Return:

on success

[ Top ]

install_validate_requirements [line 291]

array install_validate_requirements(
)

Validate install requirements.

API Tags:

Return:

List of errors, empty array if ok.

[ Top ]

load_db_schema [line 833]

void load_db_schema(
)

Loads the QP database scheme.

This gets updated through db_delta() which generates the queries needed to get to this scheme.

Please see db_delta() for things to take care of.

[ Top ]

task_end [line 194]

void task_end(
)

End install task.

This will offer other display methods in the future

[ Top ]

uninstall_plugin [line 451]

true uninstall_plugin(
 $plugin 
)

Parameters:

$plugin:

API Tags:

Return:

on success

[ Top ]