functions.php File Reference

Go to the source code of this file.

Namespaces
	installer

Functions
	genPathCheckHtml ($path, $valid)
	getDbCharsets ($link)
	getDbCollations ($link, $charset)
	getDbConnection (&$error)
	getDbConnectionParams ()
	getDirList ($dirname)
	install_acceptUser ($hash= '')
	install_finalize ($installer_modified)
	validateDbCharset ($link, &$charset, &$collation)
	xoBoolField ($name, $value, $label, $help= '')
	xoDiag ($status=-1, $str= '')
	xoDiagBoolSetting ($name, $wanted=false, $severe=false)
	xoDiagIfWritable ($path)
	xoFormBlockCollation ($name, $value, $label, $help, $link, $charset)
	xoFormField ($name, $value, $label, $help= '')
	xoFormFieldCharset ($name, $value, $label, $help, $link)
	xoFormFieldCollation ($name, $value, $label, $help, $link, $charset)
	xoPassField ($name, $value, $label, $help= '')
	xoPhpVersion ()

Function Documentation

genPathCheckHtml	(		$path,
			$valid
	)

Parameters

string	$path
bool	$valid

Returns

string

Definition at line 240 of file functions.php.

References $msg, $path, ERR_COULD_NOT_ACCESS, ERR_NO_XOOPS_FOUND, XOOPS_FOUND, XOOPS_PATH_FOUND, and XOOPS_VERSION.

getDbCharsets

(

$link

)

Parameters

resource

$link

Returns

array

Definition at line 275 of file functions.php.

References $link, and $result.

Referenced by validateDbCharset(), and xoFormFieldCharset().

Here is the caller graph for this function:

getDbCollations	(		$link,
			$charset
	)

Parameters

resource	$link
string	$charset

Returns

Definition at line 304 of file functions.php.

References $link, and $result.

Referenced by validateDbCharset(), and xoFormFieldCollation().

Here is the caller graph for this function:

getDbConnection

(

&

$error

)

getDbConnection - get database connection based on current setting

Parameters

string

&$error

will be set with any error encountered

Returns

Connection a database connection instance

Definition at line 502 of file functions.php.

References $config, $error, ERR_NO_DBCONNECTION, and getDbConnectionParams().

Here is the call graph for this function:

getDbConnectionParams

(

)

getDbConnectionParams - build array of connection parameters from collected DB_* session variables

Returns

array of Doctrine Connection parameters

Definition at line 472 of file functions.php.

References $_SESSION, $driver_info, $driver_params, $settings, and $wizard.

Referenced by getDbConnection().

Here is the caller graph for this function:

getDirList

(

$dirname

)

Definition at line 152 of file functions.php.

References $dirlist, $dirname, and $file.

install_acceptUser

(

$hash = ''

)

Parameters

string

$hash

Returns

bool

Definition at line 29 of file functions.php.

References $_SESSION, $member_handler, $uname, $user, $xoops, Xoops\getInstance(), XOOPS_DB_NAME, XOOPS_DB_PASS, and XOOPS_DB_PREFIX.

Referenced by XoopsInstallWizard\checkAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

install_finalize

(

$installer_modified

)

Parameters

$installer_modified

Returns

void

Definition at line 56 of file functions.php.

References $installer_modified.

validateDbCharset	(		$link,
		&	$charset,
		&	$collation
	)

Parameters

resource	$link
string	$charset
string	$collation

Returns

null|string

Definition at line 326 of file functions.php.

References $error, $link, ERR_INVALID_DBCHARSET, ERR_INVALID_DBCOLLATION, getDbCharsets(), and getDbCollations().

Here is the call graph for this function:

xoBoolField	(		$name,
			$value,
			$label,
			$help = ''
	)

xoBoolField - display a boolean checkbox field

Parameters

string	$name	field name
string	$value	value
string	$label	label
string	$help	help text

Returns

void

Definition at line 131 of file functions.php.

References $myts, $name, _INSTALL_CHARSET, ENABLE, and MyTextSanitizer\getInstance().

Here is the call graph for this function:

xoDiag	(		$status = -1,
			$str = ''
	)

Parameters

	$status
string	$str

Returns

string

Definition at line 173 of file functions.php.

References $_SESSION, $status, FAILED, SUCCESS, and WARNING.

Referenced by xoDiagBoolSetting(), xoDiagIfWritable(), and xoPhpVersion().

Here is the caller graph for this function:

xoDiagBoolSetting	(		$name,
			$wanted = false,
			$severe = false
	)

Parameters

string	$name
bool	$wanted
bool	$severe

Returns

string

Definition at line 192 of file functions.php.

References $name, and xoDiag().

Here is the call graph for this function:

xoDiagIfWritable

(

$path

)

Parameters

string

$path

Returns

string

Definition at line 207 of file functions.php.

References $error, $path, and xoDiag().

Here is the call graph for this function:

xoFormBlockCollation	(		$name,
			$value,
			$label,
			$help,
			$link,
			$charset
	)

Parameters

string	$name
string	$value
string	$label
string	$help
resource	$link
string	$charset

Returns

string

Definition at line 412 of file functions.php.

References $link, $name, and xoFormFieldCollation().

Here is the call graph for this function:

xoFormField	(		$name,
			$value,
			$label,
			$help = ''
	)

xoFormField - display an input field

Parameters

string	$name	field name
string	$value	value
string	$label	label
string	$help	help text

Returns

void

Definition at line 76 of file functions.php.

References $myts, $name, _INSTALL_CHARSET, and MyTextSanitizer\getInstance().

Here is the call graph for this function:

xoFormFieldCharset	(		$name,
			$value,
			$label,
			$help,
			$link
	)

Parameters

string	$name
string	$value
string	$label
string	$help
resource	$link

Returns

string

Definition at line 429 of file functions.php.

References $link, $myts, $name, _INSTALL_CHARSET, getDbCharsets(), and MyTextSanitizer\getInstance().

Here is the call graph for this function:

xoFormFieldCollation	(		$name,
			$value,
			$label,
			$help,
			$link,
			$charset
	)

Parameters

string	$name
string	$value
string	$label
string	$help
resource	$link
string	$charset

Returns

string

Definition at line 364 of file functions.php.

References $link, $myts, $name, $options, _INSTALL_CHARSET, getDbCollations(), and MyTextSanitizer\getInstance().

Referenced by xoFormBlockCollation().

Here is the call graph for this function:

Here is the caller graph for this function:

xoPassField	(		$name,
			$value,
			$label,
			$help = ''
	)

xoPassField - display a password field

Parameters

string	$name	field name
string	$value	value
string	$label	label
string	$help	help text

Returns

void

Definition at line 103 of file functions.php.

References $myts, $name, _INSTALL_CHARSET, and MyTextSanitizer\getInstance().

Here is the call graph for this function:

xoPhpVersion

(

)

Returns

string

Definition at line 226 of file functions.php.

References xoDiag().

Here is the call graph for this function: