include/utils/db_utils.php

Show: inherited
    Table of Contents

    Functions

    functiondb_concat(  $table,  $fields ) : void

    Parameters
    Name Type Description
    $table
    $fields
    Details
    Deprecated
    use DBManager::concat() instead.  
    functiondb_convert(  $string,  $type,  $additional_parameters = array(),  $additional_parameters_oracle_only = array() ) : void

    Parameters
    Name Type Description
    $string
    $type
    $additional_parameters
    $additional_parameters_oracle_only
    Details
    Deprecated
    use DBManager::convert() instead.  
    functionfrom_db_convert(  $string,  $type ) : void

    Parameters
    Name Type Description
    $string
    $type
    Details
    Deprecated
    use DBManager::fromConvert() instead.  
    functionfrom_html( string $string, bool $encode = true ) : string

    Replaces specific HTML entity values with the true characters

    Parameters
    Name Type Description
    $string string

    String to check/replace

    $encode bool

    Default true

    Returns
    Type Description
    string
    functiongetValidDBName(  $name,  $ensureUnique = false,  $maxLen = 30 ) : void

    Parameters
    Name Type Description
    $name
    $ensureUnique
    $maxLen
    functionisValidDBName( string $name, string $dbType ) : bool

    isValidDBName

    Utility to perform the check during install to ensure a database name entered by the user is valid based on the type of database server

    Parameters
    Name Type Description
    $name string

    Proposed name for the DB

    $dbType string

    Type of database server

    Returns
    Type Description
    bool true or false based on the validity of the DB name
    functionto_html( string $string, bool $encode = true ) : string

    Replaces specific characters with their HTML entity values

    Parameters
    Name Type Description
    $string string

    String to check/replace

    $encode bool

    Default true

    Returns
    Type Description
    string
    Details
    Todo
    Make this utilize the external caching mechanism after re-testing (see log on r25320). Bug 49489 - removed caching of to_html strings as it was consuming memory and never releasing it  
    Documentation was generated by DocBlox 0.18.1.