This class allow you to connect to the postgresql database, execute sql, retrieve data. More...

Inheritance diagram for DatabaseCore:

Collaboration diagram for DatabaseCore:

Public Member Functions
	__construct ($p_user, $p_password, $p_dbname, $p_host, $p_port)

	__toString ()

	alter_seq ($p_name, $min)
	alter the sequence value

	clean_orphan_lob ()
	Find all lob and remove those which are not used by any tables.

	clear_all_prepare ()
	clear all prepare stmt

	clear_prepare ($sql_name)
	clear a prepare stmt

	close ()
	wrapper for the function pg_close

	commit ()
	Commit the transaction.

	count ($p_ret=null)
	synomym for size()

	count_sql ($p_sql, $p_array=null)
	Count the number of row returned by a sql statement.

	create_sequence ($p_name, $min=1)
	Create a sequence.

	exec_sql ($p_string, $p_array=null)
	send a sql string to the database

	execute ($p_string, $p_array)
	wrapper for the function pg_execute

	execute_script ($script)
	Execute a sql script.

	exist_blob ($p_oid)
	check if the large object exists

	exist_column ($col, $table, $schema)
	Check if a column exists in a table.

	exist_database ($p_name)
	Count the database name in a system view.

	exist_schema ($p_name)

	exist_sequence ($p_name)
	test if a sequence exist

	exist_table ($p_name, $p_schema='public')
	test if a table exist

	exist_view ($p_name)

	fetch ($p_indice)
	fetch the $p_indice array from the last query

	get_affected ()
	return the number of rows affected by the previous query

	get_array ($p_sql, $p_array=null)
	purpose return the result of a sql statment in a array

	get_current_seq ($p_seq)
	get the current sequence value

	get_db ()

	get_encoding ()

	get_is_open ()

	get_name ()
	return the name of the current database

	get_next_seq ($p_seq)
	get the next sequence value

	get_ret ()

	get_row ($p_sql, $p_array=NULL)
	Returns only one row from a query.

	get_sql ()
	last SQL stmt executed

	get_value ($p_sql, $p_array=null)
	return the value of the sql, the sql will return only one value with the value

	is_prepare ($query_name)
	Check if a prepared statement already exists or not.

	lo_export ($p_oid, $tmp_file)
	wrapper for the function pg_lo_export

	lo_import ($p_filename)
	wrapper for the function pg_lo_export

	lo_unlink ($p_oid)
	wrapper for the function pg_lo_unlink

	make_array ($p_sql, $p_null=0, $p_array=null)
	make a array with the sql.

	make_list ($sql, $p_array=null)
	create a string containing the value separated by comma for use in a SQL in statement

	prepare ($p_string, $p_sql)
	wrapper for the function pg_prepare

	query_to_csv ($ret, $aheader)
	with the handle of a successull query, echo each row into CSV and send it directly to output.

	rollback ()
	rollback the current transaction

	search_sql_inject ($p_sql)
	FInd if a SQL Select has a SQL stmt to inject or damage Data When a SELECT SQL string is build, this string could contain a SQL attempt to damage data, so the statement DELETE TRUNCATE ... are forbidden.

	set_db ($db)

	set_encoding ($p_charset)

	set_is_open ($is_open)

	set_ret ($ret)

	set_sql ($sql)
	last SQL stmt executed

	size ($p_ret=null)
	return the number of rows found by the last query, or the number of rows from $p_ret

	start ()
	: start a transaction

	status ()
	get the transaction status : The status can be

	upload ($p_name)

	verify ()

Static Public Member Functions
static	escape_string ($p_string)
	wrapper for the function pg_escape_string

static	fetch_all ($ret)
	wrapper for the function pg_fetch_all

static	fetch_array ($ret, $p_indice=0, $p_mode=PGSQL_ASSOC)
	wrapper for the function pg_fetch_array

static	fetch_result ($ret, $p_row=0, $p_col=0)
	wrapper for the function pg_fetch_all

static	fetch_row ($ret, $p_row)
	wrapper for the function pg_fetch_row

static	nb_column ($p_ret)
	Returns the number of columns in a ret.

static	num_row ($ret)
	wrapper for the function pg_num_rows

static	test_me ()

Data Fields
	$array

	$sql
	last SQL stmt executed

Private Attributes
	$db
	database connection

	$is_open

	$ret
	return value

Detailed Description

This class allow you to connect to the postgresql database, execute sql, retrieve data.

Definition at line 35 of file database_core.class.php.

Constructor & Destructor Documentation

◆ __construct()

DatabaseCore::__construct	(	$p_user,
		$p_password,
		$p_dbname,
		$p_host,
		$p_port )

Definition at line 54 of file database_core.class.php.

    {
        $this->db = @pg_connect("dbname=$p_dbname host='$p_host' user='$p_user'
                     password='$p_password' port=$p_port");
        if ($this->db == false) {
            if ( DEBUGNOALYSS > 0 ) {
 
                echo '<h2 class="error">'._('Impossible de se connecter à postgreSql').'</h2>';
                echo '<p>';
                echo _("Vos paramètres sont incorrectes").": <br>";
                echo "<br>";
                printf (_("base de donnée  = %s"), $p_dbname)."<br>";
                printf (_("Port %s"),$p_port )."<br>";
                printf (  _("Utilisateur : %s"),$p_user )."<br>";
                echo '</p>';
 
                die();
            } else {
                echo '<h2 class="error">' . _('Erreur de connexion !') . '</h2>';
                $this->is_open = false;
                throw new Exception(_('Erreur Connexion'));
            }
        }
 
        $this->is_open = TRUE;
        $this->sql="";
 
    }

References _, and db.

Member Function Documentation

◆ __toString()

DatabaseCore::__toString ( )

Parameters

return

Note

See also

Definition at line 889 of file database_core.class.php.

    {
        return "database ";
    }

◆ alter_seq()

DatabaseCore::alter_seq	(		$p_name,
			$min )

alter the sequence value

Parameters

$p_name	name of the sequence
$min	the start value of the sequence

Definition at line 292 of file database_core.class.php.

    {
        if ($min < 1)
            $min = 1;
        $Res = $this->exec_sql("alter sequence $p_name restart $min");
    }

References $min, $Res, and exec_sql().

Referenced by Database\apply_patch().

Here is the call graph for this function:

◆ clean_orphan_lob()

DatabaseCore::clean_orphan_lob ( )

Find all lob and remove those which are not used by any tables.

Definition at line 920 of file database_core.class.php.

    {
        // find all columns of type lob
        $sql = " 
                select table_schema,table_name,column_name 
                from 
                    information_schema.columns 
                where table_schema not in ('information_schema','pg_catalog') 
                and data_type='oid'";
        $all_lob = "
            select oid,'N' as used from pg_largeobject_metadata
            ";
        $a_table = $this->get_array($sql);
        $a_lob = $this->get_array($all_lob);
        if ($a_table == false || $a_lob == false) return;
        // for each lob
        $nb_lob = count($a_lob);
        $nb_table = count($a_table);
        for ($i = 0; $i < $nb_lob; $i++) {
            $lob = $a_lob[$i]['oid'];
            if ($a_lob[$i]['used'] == 'Y') continue;
            for ($j = 0; $j < $nb_table; $j++) {
                if ($a_lob[$i]['used'] == 'Y') continue;
                $check = $this->get_value(" select count(*) from " .
                    $a_table[$j]['table_schema'] . "." . $a_table[$j]['table_name'] .
                    " where " .
                    $a_table[$j]['column_name'] . "=$1", array($lob));
                if ($check != 0)
                    $a_lob[$i]['used'] = 'Y';
 
            }
        }
        for ($i = 0; $i < $nb_lob; $i++) {
            if ($a_lob[$i]['used'] == 'Y') continue;
            $this->lo_unlink($a_lob[$i]['oid']);
        }
    }

References $check, $i, $sql, count(), get_array(), get_value(), and lo_unlink().

Here is the call graph for this function:

◆ clear_all_prepare()

DatabaseCore::clear_all_prepare ( )

clear all prepare stmt

See also: DatabaseCore\is_prepare; DatabaseCore\execute; DatabaseCore\prepare

Definition at line 1051 of file database_core.class.php.

    {
        pg_exec($this->db,'DEALLOCATE ALL');
    }

References db.

◆ clear_prepare()

DatabaseCore::clear_prepare ( $sql_name )

clear a prepare stmt

See also: DatabaseCore\is_prepare; DatabaseCore\execute; DatabaseCore\prepare

Parameters

$sql_name name of the prepare SQL

Definition at line 1041 of file database_core.class.php.

    {
        pg_exec($this->db,sprintf('DEALLOCATE "%s"'),DatabaseCore::escape_string($sql_name));
    }

References db, and escape_string().

Here is the call graph for this function:

◆ close()

DatabaseCore::close ( )

wrapper for the function pg_close

Definition at line 875 of file database_core.class.php.

    {
        if ($this->is_open) pg_close($this->db);
        $this->is_open = FALSE;
    }

References db.

◆ commit()

DatabaseCore::commit ( )

Commit the transaction.

Definition at line 272 of file database_core.class.php.

    {
        if (!$this->is_open) return;
        $Res = $this->exec_sql("commit");
    }

References $Res, and exec_sql().

Here is the call graph for this function:

◆ count()

DatabaseCore::count ( $p_ret = null )

synomym for size()

Definition at line 417 of file database_core.class.php.

    {
        return $this->size($p_ret);
    }

References size.

Referenced by clean_orphan_lob(), get_row(), make_list(), and query_to_csv().

◆ count_sql()

DatabaseCore::count_sql	(		$p_sql,
			$p_array = null )

Count the number of row returned by a sql statement.

Parameters

$p_sql	sql string
$p_array	if not null we use the safer pg_query_params

Definition at line 232 of file database_core.class.php.

    {
        $r_sql = $this->exec_sql($p_sql, $p_array);
        return pg_num_rows($r_sql);
    }

References $p_array, and exec_sql().

Referenced by exist_schema(), exist_sequence(), exist_table(), and exist_view().

Here is the call graph for this function:

◆ create_sequence()

DatabaseCore::create_sequence	(		$p_name,
			$min = 1 )

Create a sequence.

Parameters

string	$p_name	Sequence Name
int	$min	starting value

Definition at line 502 of file database_core.class.php.

    {
        if ($min < 1)
            $min = 1;
        $sql = "create sequence " . $p_name . " minvalue $min";
        $this->exec_sql($sql);
    }

References $min, $sql, and exec_sql().

Here is the call graph for this function:

◆ escape_string()

static DatabaseCore::escape_string ( $p_string )

static

wrapper for the function pg_escape_string

Parameters

$p_string is the string to escape

Returns: escaped string

Definition at line 864 of file database_core.class.php.

    {
        static $cn=null;
        if ( $cn==null) $cn=new Database();
        return pg_escape_string($cn->db,$p_string);
    }

References $cn.

Referenced by clear_prepare(), Acc_Ledger_Search\list_operation(), Anc_Acc_List\load_anc_account(), Anc_Acc_List\load_anc_card(), Anc_Acc_List\load_card(), Anc_Table\load_card(), Anc_Acc_List\load_poste(), Anc_Table\load_poste(), Follow_Up\myList(), and Noalyss_User\set_session_var().

◆ exec_sql()

DatabaseCore::exec_sql	(		$p_string,
			$p_array = null )

send a sql string to the database

Parameters

$p_string	sql string
$p_array	array for the SQL string (see pg_query_params)

Returns: the result of the query, a resource or false if an error occured

Definition at line 180 of file database_core.class.php.

    {
        try {
            if (!$this->is_open) throw new Exception(' Database is closed');
            $this->sql = $p_string;
            $this->array = $p_array;
 
            if ($p_array == null) {
                if ( DEBUGNOALYSS == 0 )
                    $this->ret = pg_query($this->db, $p_string);
                else
                    $this->ret = @pg_query($this->db, $p_string);
            } else {
                $a = is_array($p_array);
                if (!is_array($p_array)) {
                    throw new Exception(_("Erreur : exec_sql attend un array"));
                }
                if ( DEBUGNOALYSS == 0 )
                    $this->ret =@pg_query_params($this->db, $p_string, $p_array);
                else
                    $this->ret = pg_query_params($this->db, $p_string, $p_array);
            }
            if ($this->ret == false) {
                $str_error = pg_last_error($this->db) ;
                throw new Exception("  SQL ERROR $p_string " . $str_error, 1);
            }
        } catch (Exception $a) {
            if ( DEBUGNOALYSS > 0 ) {
                print_r($p_string);
                print_r($p_array);
                echo $a->getMessage();
                echo $a->getTraceAsString();
                echo pg_last_error($this->db);
            }
            record_log($a);
            record_log($p_string);
            record_log($p_array);
            $this->rollback();
 
            throw ($a);
        }
 
        return $this->ret;
    }

References $a, $p_array, $ret, _, db, record_log(), and rollback().

Referenced by Database\__construct(), alter_seq(), Database\apply_patch(), Extension\clean(), commit(), count_sql(), create_sequence(), execute_script(), get_array(), get_next_seq(), get_value(), Sendmail\increment_mail(), make_array(), rollback(), Database\save_receipt(), and start().

Here is the call graph for this function:

◆ execute()

DatabaseCore::execute	(		$p_string,
			$p_array )

wrapper for the function pg_execute

Parameters

$p_string	string name of the stmt given in pg_prepare function
$p_array	contains the variables

Note: set this->ret to the return of pg_execute

Returns: return the result of the operation,

Definition at line 828 of file database_core.class.php.

    {
        $this->ret = pg_execute($this->db, $p_string, $p_array);
        return $this->ret;
    }

References $p_array, $ret, and db.

◆ execute_script()

DatabaseCore::execute_script ( $script )

Execute a sql script.

Parameters

$script script name

Definition at line 304 of file database_core.class.php.

    {
 
        if ( DEBUGNOALYSS == 0 ) {
            ob_start();
        } else {
            $debug = fopen("/tmp/debug_execute_script".uniqid().".log", "w+");
        }
        $hf = fopen($script, 'r');
        if ($hf == false) {
            throw new Exception ('Ne peut ouvrir ' . $script);
        }
        printf (" open %s <br>", $script);
        $sql = "";
        $flag_function = false;
        while (!feof($hf)) {
            $buffer = fgets($hf);
            $buffer = str_replace('$BODY$', '$_$', $buffer);
            print $buffer . "<br>";
            // comment are not execute
            if (substr($buffer, 0, 2) == "--") {
                //echo "comment $buffer";
                continue;
            }
            // Blank Lines Are Skipped
            If (Strlen($buffer) == 0) {
                //echo "Blank $buffer";
                Continue;
            }
            if (strpos(strtolower($buffer), "create function") === 0) {
                echo "found a function";
                $flag_function = true;
                $sql = $buffer;
                continue;
            }
            if (strpos(strtolower($buffer), "create or replace function") === 0) {
                echo "found a function";
                $flag_function = true;
                $sql = $buffer;
                continue;
            }
            // No semi colon -> multiline command
            if ($flag_function == false && strpos($buffer, ';') == false) {
                $sql .= $buffer;
                continue;
            }
            if ($flag_function) {
                if (strpos(strtolower($buffer), "$$;") === false &&
                    strpos(strtolower($buffer), '$_$;') === false &&
                    strpos(strtolower($buffer), '$function$;') === false &&
                    strpos(strtolower($buffer), 'language plpgsql;') === false &&
                    strpos(strtolower($buffer), 'language plpgsql ;') === false
                ) {
                    $sql .= $buffer;
                    continue;
                }
            } else {
                // cut the semi colon
                $buffer = str_replace(';', '', $buffer);
            }
            $sql .= $buffer;
            if ( DEBUGNOALYSS > 0 ) fwrite($debug, $sql);
            if ($this->exec_sql($sql) == false) {
 
                $this->rollback();
                if ( DEBUGNOALYSS == 0 )
                    ob_end_clean();
                print "ERROR : $sql";
                throw new Exception("ERROR : $sql");
            }
            $sql = "";
            $flag_function = false;
            print "<hr>";
        } // while (feof)
        fclose($hf);
        if ( DEBUGNOALYSS == 0 )
            ob_end_clean();
    }

References $script, $sql, exec_sql(), print, and rollback().

Referenced by Database\apply_patch().

Here is the call graph for this function:

◆ exist_blob()

DatabaseCore::exist_blob ( $p_oid )

check if the large object exists

Parameters

$p_oid of the large object

Returns: return true if the large obj exist or false if not

Definition at line 571 of file database_core.class.php.

    {
        $r = $this->get_value('select count(*) from pg_largeobject_metadata where oid=$1'
            , array($p_oid));
        if ($r > 0)
            return true;
        else
            return false;
    }

References $r, and get_value().

Referenced by lo_unlink().

Here is the call graph for this function:

◆ exist_column()

DatabaseCore::exist_column	(	$col,
		$table,
		$schema )

Check if a column exists in a table.

Parameters

$col	: column name
$table	:table name
$schema	:schema name, default public

Returns: true or false

Definition at line 545 of file database_core.class.php.

    {
        $r = $this->get_value('select count(*) from information_schema.columns where table_name=lower($1) and column_name=lower($2) and table_schema=lower($3)', array($col, $table, $schema));
        if ($r > 0)
            return true;
        return false;
    }

References $r, $table, and get_value().

Here is the call graph for this function:

◆ exist_database()

DatabaseCore::exist_database ( $p_name )

Count the database name in a system view.

Parameters

$p_name string database name

Returns: number of database found (normally 0 or 1)

Definition at line 559 of file database_core.class.php.

    {
        $database_exist = $this->get_value('select count(*)
                from pg_catalog.pg_database where datname = lower($1)', array($p_name));
        return $database_exist;
    }

References get_value().

Here is the call graph for this function:

◆ exist_schema()

DatabaseCore::exist_schema ( $p_name )

Definition at line 599 of file database_core.class.php.

    {
        $r = $this->count_sql("select nspname from pg_namespace where nspname=lower($1)", array($p_name));
        if ($r == 0)
            return false;
        return true;
    }

References $r, and count_sql().

Referenced by Database\__construct(), Database\apply_patch(), and Extension\clean().

Here is the call graph for this function:

◆ exist_sequence()

DatabaseCore::exist_sequence ( $p_name )

test if a sequence exist

Definition at line 515 of file database_core.class.php.

    {
        $r = $this->count_sql("select relname from pg_class where relname=lower($1)", array($p_name));
        if ($r == 0)
            return false;
        return true;
    }

References $r, and count_sql().

Here is the call graph for this function:

◆ exist_table()

DatabaseCore::exist_table	(		$p_name,
			$p_schema = 'public' )

test if a table exist

Parameters

$p_name	table name
$schema	name of the schema default public

Returns: true if a table exist otherwise false

Definition at line 530 of file database_core.class.php.

    {
        $r = $this->count_sql("select table_name from information_schema.tables where table_schema=$1 and table_name=lower($2)", array($p_schema, $p_name));
        if ($r == 0)
            return false;
        return true;
    }

References $r, and count_sql().

Referenced by Database\apply_patch().

Here is the call graph for this function:

◆ exist_view()

DatabaseCore::exist_view ( $p_name )

Definition at line 586 of file database_core.class.php.

    {
        $r = $this->count_sql("select viewname from pg_views where viewname=lower($1)", array($p_name));
        if ($r == 0)
            return false;
        return true;
    }

References $r, and count_sql().

Here is the call graph for this function:

◆ fetch()

DatabaseCore::fetch ( $p_indice )

fetch the $p_indice array from the last query

Parameters

$p_indice index

Definition at line 389 of file database_core.class.php.

    {
        if ($this->ret == false)
            throw new Exception('this->ret is empty');
        return pg_fetch_array($this->ret, $p_indice,PGSQL_ASSOC);
    }

◆ fetch_all()

static DatabaseCore::fetch_all ( $ret )

static

wrapper for the function pg_fetch_all

Parameters

$ret	is the result of pg_exec (exec_sql)

Returns: double array (row x col ) or false

Definition at line 768 of file database_core.class.php.

    {
        return pg_fetch_all($ret,PGSQL_ASSOC);
    }

References $ret.

Referenced by Acc_Ledger_History\add_additional_tax_info(), Acc_Ledger_History_Purchase\add_vat_info(), Acc_Ledger_History_Sale\add_vat_info(), Fiche\belong_ledger(), Follow_Up\get(), Table_Data_SQL\get_all_to_array(), Anc_Operation\get_balance(), Acc_Ledger\get_class_def(), Acc_Ledger_History_Generic\get_detail(), Acc_Ledger\get_fiche_def(), Anc_Operation\get_jrid(), Acc_Operation\get_jrnx_detail(), Acc_Report\get_list(), Anc_Operation\get_list(), Anc_Plan\get_list(), Pre_operation\get_list_ledger(), Fiche\get_quick_code(), Acc_Ledger_History_Generic\get_row(), Acc_Account_Ledger\get_row_date(), Acc_Ledger_History_Generic\get_rowSimple(), Acc_Ledger\get_solde(), Fiche\getName(), Acc_Account_Ledger\load(), Anc_Balance_Simple\load(), Pre_op_ach\load(), Pre_Op_Advanced\load(), Pre_op_fin\load(), Pre_op_ods\load(), Pre_op_ven\load(), Pre_operation\load(), Acc_Ledger_Info\load_all(), Acc_Parm_Code\load_all(), Todo_List\load_all(), Anc_Group\myList(), Document_Modele\myList(), Follow_Up\myList(), Follow_Up\short_list(), and Customer\VatListing().

◆ fetch_array()

static DatabaseCore::fetch_array	(	$ret,
		$p_indice = 0,
		$p_mode = PGSQL_ASSOC )

static

wrapper for the function pg_fetch_array

Parameters

$ret	is the result of a pg_exec
$p_indice	is the index
$p_indice	is the index

Returns: $array of column

Definition at line 757 of file database_core.class.php.

    {
        return pg_fetch_array($ret, $p_indice,$p_mode);
    }

References $ret.

Referenced by Noalyss_Parameter_Folder\__construct(), Card_Property\build_input(), Noalyss_User\Check(), Document_Modele\Delete(), Manage_Table_SQL\display_table(), Periode_Ledger_Table\display_table(), Fiche_Def\DisplayAttribut(), Print_Ledger_Detail_Item\export(), Print_Ledger_Simple\export(), Print_Ledger_Simple_Without_Vat\export(), Acc_Ledger_History_Purchase\export_csv(), Acc_Ledger_History_Sale\export_csv(), Follow_Up\export_csv_detail(), Document\export_file(), Acc_Operation\find_tiers(), Document\generate(), Acc_Reconciliation\get(), Anc_Plan\get(), Document\get(), Document_Type\get(), Fiche_Def\get(), Fiche_Def\get_all(), Acc_Reconciliation\get_amount_noautovat(), Fiche_Def\get_attr_min(), Fiche\get_bk_balance(), Customer\get_by_account(), Supplier\get_by_account(), Fiche\get_by_category(), Fiche_Def\get_by_category(), Acc_Operation\get_data(), Periode\get_date_limit(), Acc_Operation\get_internal(), Acc_Account_Ledger\get_name(), Acc_Ledger\get_name(), Acc_Report\get_row(), Fiche\get_row_result_deprecated(), Acc_Account_Ledger\get_row_sql_deprecated(), Acc_Account_Ledger\get_solde(), Acc_Account_Ledger\get_solde_detail(), Fiche\get_solde_detail(), Acc_Ledger\get_type(), Fiche_Def\getAttribut(), html_min_page_start(), html_page_start(), isValid_deprecrated(), Acc_Ledger_Search\list_operation(), Acc_Ledger_Search\list_operation_to_reconcile(), Acc_Ledger\listing(), Acc_Bilan\load(), Acc_Ledger_Info\load(), Acc_Parm_Code\load(), Acc_Payment\load(), Anc_Group\load(), Card_Property\load(), Dossier\load(), Forecast\load(), Noalyss_User\load(), Todo_List\load(), Fiche_Def\myList(), query_to_csv(), Document_Modele\Save(), Document\send(), Profile_Menu\sub_menu(), Card_Property\update(), Document_Modele\update(), Anc_Operation\update_from_jrnx(), Dossier\upgrade(), Customer\VatListing(), Acc_Bilan\verify(), and Acc_Bilan\warning().

◆ fetch_result()

static DatabaseCore::fetch_result	(	$ret,
		$p_row = 0,
		$p_col = 0 )

static

wrapper for the function pg_fetch_all

Parameters

$ret	is the result of pg_exec (exec_sql)
$p_row	is the indice of the row
$p_col	is the indice of the col

Returns: a string or an integer

Definition at line 781 of file database_core.class.php.

    {
        return pg_fetch_result($ret, $p_row, $p_col);
    }

References $p_col, and $ret.

Referenced by Fiche\empty_attribute(), Print_Ledger_Financial\export(), Periode\find_periode(), Periode\get_exercice(), Acc_Account_Ledger\get_row(), Fiche\get_row(), Fiche\get_row_date(), Acc_Ledger_Info\insert(), Forecast\insert(), Todo_List\insert(), Periode\is_centralized(), Acc_Ledger_Info\search_id_internal(), and Acc_Operation\seek_internal().

◆ fetch_row()

static DatabaseCore::fetch_row	(		$ret,
			$p_row )

static

wrapper for the function pg_fetch_row

Parameters

$ret	is the result of pg_exec (exec_sql)
$p_row	is the indice of the row

Returns: an array indexed from 0

Definition at line 792 of file database_core.class.php.

    {
        return pg_fetch_row($ret, $p_row);
    }

References $ret.

Referenced by Html_Table\sql2table().

◆ get_affected()

DatabaseCore::get_affected ( )

return the number of rows affected by the previous query

Definition at line 459 of file database_core.class.php.

    {
        return Database::num_row($this->ret);
    }

References num_row().

Here is the call graph for this function:

◆ get_array()

DatabaseCore::get_array	(		$p_sql,
			$p_array = null )

purpose return the result of a sql statment in a array

Parameters

$p_sql	sql query
$p_array	if not null we use ExecSqlParam

Returns: false if nothing is found

Definition at line 472 of file database_core.class.php.

    {
        $r = $this->exec_sql($p_sql, $p_array);
 
        if (pg_num_rows($r) == 0)
            return array();
        $array = pg_fetch_all($r);
        return $array;
    }

References $array, $p_array, $r, and exec_sql().

Referenced by clean_orphan_lob(), get_row(), and make_list().

Here is the call graph for this function:

◆ get_current_seq()

DatabaseCore::get_current_seq ( $p_seq )

get the current sequence value

Definition at line 242 of file database_core.class.php.

    {
        $Res = $this->get_value("select currval('$p_seq') as seq");
        return $Res;
    }

References $Res, and get_value().

Here is the call graph for this function:

◆ get_db()

DatabaseCore::get_db ( )

Returns: mixed

Definition at line 110 of file database_core.class.php.

    {
        return $this->db;
    }

References $db.

◆ get_encoding()

DatabaseCore::get_encoding ( )

Definition at line 101 of file database_core.class.php.

    {
        return pg_client_encoding($this->db);
    }

References db.

◆ get_is_open()

DatabaseCore::get_is_open ( )

Returns: mixed

Definition at line 142 of file database_core.class.php.

    {
        return $this->is_open;
    }

References $is_open.

◆ get_name()

DatabaseCore::get_name ( )

return the name of the current database

Returns: false|string

Definition at line 87 of file database_core.class.php.

                                {
        return pg_dbname($this->db);
    }

References db.

◆ get_next_seq()

DatabaseCore::get_next_seq ( $p_seq )

get the next sequence value

Definition at line 252 of file database_core.class.php.

    {
        $Res = $this->exec_sql("select nextval('$p_seq') as seq");
        $seq = pg_fetch_array($Res, 0);
        return $seq['seq'];
    }

References $Res, $seq, and exec_sql().

Here is the call graph for this function:

◆ get_ret()

DatabaseCore::get_ret ( )

Returns: mixed

Definition at line 126 of file database_core.class.php.

    {
        return $this->ret;
    }

References $ret.

◆ get_row()

DatabaseCore::get_row	(		$p_sql,
			$p_array = NULL )

Returns only one row from a query.

Parameters

string	$p_sql
array	$p_array

Returns: array , idx = column of the table or null if nothing is found

Exceptions

Exception if too many rows are found code 100

Definition at line 489 of file database_core.class.php.

    {
        $array = $this->get_array($p_sql, $p_array);
        if (empty($array)) return null;
        if (count($array) == 1) return $array[0];
        throw new Exception(_("Database:get_row retourne trop de lignes"), 100);
    }

References $array, $p_array, _, count(), and get_array().

Here is the call graph for this function:

◆ get_sql()

DatabaseCore::get_sql ( )

last SQL stmt executed

Parameters

string $sql

Definition at line 158 of file database_core.class.php.

    {
        return $this->sql;
    }

References $sql.

◆ get_value()

DatabaseCore::get_value	(		$p_sql,
			$p_array = null )

return the value of the sql, the sql will return only one value with the value

Parameters

$p_sql	the sql stmt example :select s_value from document_state where s_id=2
$p_array	if array is not null we use the ExecSqlParm (safer)

See also: exec_sql

Note: print a warning if several value are found, if only the first value is needed consider using a LIMIT clause

Returns: only the first value or an empty string if nothing is found

Definition at line 436 of file database_core.class.php.

    {
        try {
            $this->ret = $this->exec_sql($p_sql, $p_array);
            $r = pg_num_rows($this->ret);
            if ($r == 0)
                return "";
            if ($r > 1) {
                $array = pg_fetch_all($this->ret);
                throw new Exception("Attention $p_sql retourne " . pg_num_rows($this->ret) . "  valeurs " .
                    var_export($p_array, true) . " values=" . var_export($array, true));
            }
            $r = pg_fetch_row($this->ret, 0);
            return $r[0];
 
        } catch (Exception $ex) {
            throw($ex);
        }
    }

References $array, $ex, $p_array, $r, and exec_sql().

Referenced by Acc_Account\__construct(), Database\apply_patch(), clean_orphan_lob(), exist_blob(), exist_column(), exist_database(), get_current_seq(), Sendmail\get_email_sent(), Sendmail\get_max_email(), Database\get_version(), and is_prepare().

Here is the call graph for this function:

◆ is_prepare()

DatabaseCore::is_prepare ( $query_name )

Check if a prepared statement already exists or not.

Parameters

string $query_name name of the prepared query

Returns: boolean false is not yet prepared

Definition at line 963 of file database_core.class.php.

    {
        $nb_prepared = $this->get_value("select count(*) from pg_prepared_statements where name=$1", [$query_name]);
        if ($nb_prepared == 0) return FALSE;
        return TRUE;
    }

References get_value().

Here is the call graph for this function:

◆ lo_export()

DatabaseCore::lo_export	(		$p_oid,
			$tmp_file )

wrapper for the function pg_lo_export

Parameters

$p_oid	is the oid of the log
$tmp_file	is the file

Returns: result of the operation

Definition at line 841 of file database_core.class.php.

    {
        return pg_lo_export($this->db, $p_oid, $tmp_file);
    }

References db.

◆ lo_import()

DatabaseCore::lo_import ( $p_filename )

wrapper for the function pg_lo_export

Parameters

$p_filename	is the filename
$tmp	is the file

Returns: result of the operation

Definition at line 853 of file database_core.class.php.

    {
        return pg_lo_import($this->db, $p_filename);
    }

References db.

◆ lo_unlink()

DatabaseCore::lo_unlink ( $p_oid )

wrapper for the function pg_lo_unlink

Parameters

$p_oid is the of oid

Returns: return the result of the operation

Definition at line 803 of file database_core.class.php.

    {
        if (!$this->exist_blob($p_oid)) return;
        return pg_lo_unlink($this->db, $p_oid);
    }

References db, and exist_blob().

Referenced by clean_orphan_lob(), and Database\save_receipt().

Here is the call graph for this function:

◆ make_array()

DatabaseCore::make_array	(	$p_sql,
		$p_null = 0,
		$p_array = null )

make a array with the sql.

Parameters

$p_sql	sql statement, only the first two column will be returned in an array. The first col. is the label and the second the value
$p_null	if the array start with a null value Yes = 1 , No=0
$p_array	is the array with the bind value

Note: this function is used with ISelect when it is needed to have a list of options.

Returns

: a double array like

* Array
* (
* [0] => Array
* (
* [value] => 1
* [label] => Marchandise A
* )
*
* [1] => Array
* (
* [value] => 2
* [label] => Marchandise B
* )
*
* [2] => Array
* (
* [value] => 3
* [label] => Marchandise C
* )
* )
*

See also: ISelect

Definition at line 671 of file database_core.class.php.

    {
        $a = $this->exec_sql($p_sql, $p_array);
        $max = pg_num_rows($a);
        if ($max == 0 && $p_null == 0)
            return null;
        for ($i = 0; $i < $max; $i++) {
            $row = pg_fetch_row($a);
            $r[$i]['value'] = $row[0];
            $r[$i]['label'] = h($row[1]);
        }
        // add a blank item ?
        if ($p_null == 1) {
            for ($i = $max; $i != 0; $i--) {
                $r[$i]['value'] = $r[$i - 1]['value'];
                $r[$i]['label'] = $r[$i - 1]['label'];
            }
            $r[0]['value'] = -1;
            $r[0]['label'] = " ";
        } //   if ( $p_null == 1 )
 
        return $r;
    }

References $a, $i, $max, $p_array, $r, $row, exec_sql(), and h.

Here is the call graph for this function:

◆ make_list()

DatabaseCore::make_list	(		$sql,
			$p_array = null )

create a string containing the value separated by comma for use in a SQL in statement

Returns: the string or empty if nothing is found

See also: fid_card.php

Definition at line 614 of file database_core.class.php.

    {
        if ($p_array == null) {
            $aArray = $this->get_array($sql);
        } else {
            $aArray = $this->get_array($sql, $p_array);
        }
        if (empty($aArray))
            return "";
        $aIdx = array_keys($aArray[0]);
        $idx = $aIdx[0];
        $ret = "";
        $f = "";
        for ($i = 0; $i < count($aArray); $i++) {
            $row = $aArray[$i];
            $ret .= $f . $aArray[$i][$idx];
            $f = ',';
        }
        $ret = trim($ret, ',');
        return $ret;
    }

References $f, $i, $idx, $p_array, $ret, $row, $sql, count(), and get_array().

Here is the call graph for this function:

◆ nb_column()

static DatabaseCore::nb_column ( $p_ret )

static

Returns the number of columns in a ret.

Parameters

handler $p_ret handler to a query

Definition at line 1012 of file database_core.class.php.

                                       {
        return pg_num_fields($p_ret);
    }

◆ num_row()

static DatabaseCore::num_row ( $ret )

static

wrapper for the function pg_num_rows

Parameters

$ret	is the result of a exec_sql

Returns: number of line affected

Definition at line 744 of file database_core.class.php.

    {
        return pg_num_rows($ret);
    }

References $ret.

Referenced by Default_Menu\__construct(), Noalyss_Parameter_Folder\__construct(), Fiche\belong_ledger(), Noalyss_User\Check(), Data_SQL\collect_objects(), Periode\display_periode_global(), Manage_Table_SQL\display_table(), Periode_Ledger_Table\display_table(), Fiche_Def\DisplayAttribut(), Acc_Account_Ledger\do_exist(), Fiche\empty_attribute(), Acc_Report\exist(), Print_Ledger_Detail_Item\export(), Print_Ledger_Simple\export(), Print_Ledger_Simple_Without_Vat\export(), Acc_Ledger_History_Purchase\export_csv(), Acc_Ledger_History_Sale\export_csv(), Follow_Up\export_csv(), Follow_Up\export_csv_detail(), Document\export_file(), Periode\find_periode(), Acc_Operation\find_tiers(), Acc_Reconciliation\get(), Anc_Plan\get(), Document\get(), Fiche_Def\get(), get_affected(), Fiche_Def\get_all(), Acc_Reconciliation\get_amount_noautovat(), Fiche_Def\get_attr_min(), Fiche\get_bk_balance(), Customer\get_by_account(), Supplier\get_by_account(), Fiche\get_by_category(), Fiche_Def\get_by_category(), Acc_Operation\get_data(), Periode\get_date_limit(), Periode\get_exercice(), Acc_Operation\get_internal(), Anc_Operation\get_jrid(), Acc_Operation\get_jrnx_detail(), Acc_Report\get_list(), Acc_Account_Ledger\get_name(), Acc_Ledger\get_name(), Acc_Account_Ledger\get_row(), Acc_Ledger_History_Generic\get_row(), Acc_Report\get_row(), Fiche\get_row(), Fiche\get_row_date(), Fiche\get_row_result_deprecated(), Acc_Account_Ledger\get_row_sql_deprecated(), Acc_Ledger_History_Generic\get_rowSimple(), Acc_Account_Ledger\get_solde(), Acc_Account_Ledger\get_solde_detail(), Fiche\get_solde_detail(), Acc_Ledger\get_type(), Fiche_Def\getAttribut(), Stock\history(), html_min_page_start(), html_page_start(), isValid_deprecrated(), Acc_Ledger_Search\list_operation(), Acc_Ledger_Search\list_operation_to_reconcile(), Acc_Ledger\listing(), Acc_Bilan\load(), Acc_Ledger_Info\load(), Acc_Parm_Code\load(), Acc_Payment\load(), Anc_Balance_Simple\load(), Card_Property\load(), Dossier\load(), Forecast\load(), Noalyss_User\load(), Todo_List\load(), Acc_Ledger_Info\load_all(), Document_Modele\myList(), Fiche_Def\myList(), query_to_csv(), Document_Modele\Save(), Acc_Ledger_Info\search_id_internal(), Acc_Operation\seek_internal(), Document\send(), Acc_Reconciliation\show_detail(), Html_Table\sql2table(), Profile_Menu\sub_menu(), Card_Property\update(), Document_Modele\update(), Anc_Operation\update_from_jrnx(), Customer\VatListing(), and Acc_Bilan\warning().

◆ prepare()

DatabaseCore::prepare	(		$p_string,
			$p_sql )

wrapper for the function pg_prepare

Parameters

$p_string	string name for pg_prepare function
$p_sql	is the sql to prepare

Returns: return the result of the operation

Definition at line 815 of file database_core.class.php.

    {
        return pg_prepare($this->db, $p_string, $p_sql);
    }

References db.

◆ query_to_csv()

DatabaseCore::query_to_csv	(		$ret,
			$aheader )

with the handle of a successull query, echo each row into CSV and send it directly to output.

To save it into a file, it is needed to send first the HEADER as CSV. If there are less column than column defined in $aheader, then the columns not included in the header are not displaid

Parameters

handle	$ret	handle to a query
array	$aheader	double array, each item of the array contains (idx : title, type) a key type (num) and a key title

Definition at line 979 of file database_core.class.php.

    {
        $csv = new Noalyss_Csv("db-query");
        $a_header = [];
        for ($i = 0; $i < count($aheader); $i++) {
            $a_header[] = $aheader[$i]['title'];
        }
        $csv->write_header($a_header);
 
        // fetch all the rows
        $nb = Database::num_row($ret);
        for ($i = 0; $i < $nb; $i++) {
            $row = Database::fetch_array($ret, $i);
            // for each rows, for each value
            $e=0;
            foreach ($row as $row_item){
                if ( $e >= count($a_header)) break;
                switch ($aheader[$e]['type']) {
                    case 'num':
                        $csv->add($row_item, "number");
                        break;
                    default:
                        $csv->add($row_item);
                }
                $e++;
            }
            $csv->write();
        }
    }

References $csv, $e, $i, $nb, $ret, $row, count(), fetch_array(), and num_row().

Here is the call graph for this function:

◆ rollback()

DatabaseCore::rollback ( )

rollback the current transaction

Definition at line 281 of file database_core.class.php.

    {
        if (!$this->is_open) return;
        $Res = $this->exec_sql("rollback");
    }

References $Res, and exec_sql().

Referenced by exec_sql(), execute_script(), and upload().

Here is the call graph for this function:

◆ search_sql_inject()

DatabaseCore::search_sql_inject ( $p_sql )

FInd if a SQL Select has a SQL stmt to inject or damage Data When a SELECT SQL string is build, this string could contain a SQL attempt to damage data, so the statement DELETE TRUNCATE ... are forbidden.

Throw an exception EXC_INVALID

Definition at line 1021 of file database_core.class.php.

    {
        $forbid_sql=array("update","delete","truncate","insert");
        // protect against SQL inject
        foreach ($forbid_sql as $forbid_key) {
            if (stripos($p_sql,$forbid_key) !== false)
            {
                throw new Exception(_("Possible SQL inject"),EXC_INVALID);
            }
 
        }
    }

References _, and EXC_INVALID.

◆ set_db()

DatabaseCore::set_db ( $db )

Parameters

mixed $db

Definition at line 118 of file database_core.class.php.

    {
        $this->db = $db;
    }

References $db, and db.

◆ set_encoding()

DatabaseCore::set_encoding ( $p_charset )

Definition at line 96 of file database_core.class.php.

    {
        pg_set_client_encoding($this->db, $p_charset);
    }

References db.

◆ set_is_open()

DatabaseCore::set_is_open ( $is_open )

Parameters

mixed $is_open

Definition at line 150 of file database_core.class.php.

    {
        $this->is_open = $is_open;
    }

References $is_open.

◆ set_ret()

DatabaseCore::set_ret ( $ret )

Parameters

mixed $ret

Definition at line 134 of file database_core.class.php.

    {
        $this->ret = $ret;
    }

References $ret.

◆ set_sql()

DatabaseCore::set_sql ( $sql )

last SQL stmt executed

Parameters

string $sql

Definition at line 166 of file database_core.class.php.

    {
        $this->sql=$sql;
        return $this;
    }

References $sql.

◆ size()

DatabaseCore::size ( $p_ret = null )

return the number of rows found by the last query, or the number of rows from $p_ret

Parameters

$p_ret is the result of a query, the default value is null, in that case it is related to the last query

Note: synomym for count()

Definition at line 405 of file database_core.class.php.

    {
        if ($p_ret == null)
            return pg_num_rows($this->ret);
        else
            return pg_num_rows($p_ret);
    }

◆ start()

DatabaseCore::start ( )

: start a transaction

Definition at line 263 of file database_core.class.php.

    {
        $Res = $this->exec_sql("start transaction");
    }

References $Res, and exec_sql().

Here is the call graph for this function:

◆ status()

DatabaseCore::status ( )

get the transaction status : The status can be

PGSQL_TRANSACTION_IDLE (currently idle),
PGSQL_TRANSACTION_ACTIVE (a command is in progress),
PGSQL_TRANSACTION_INTRANS (idle, in a valid transaction block),
PGSQL_TRANSACTION_INERROR (idle, in a failed transaction block).
PGSQL_TRANSACTION_UNKNOWN is reported if the connection is bad.
PGSQL_TRANSACTION_ACTIVE is reported only when a query has been sent to the server and not yet completed.

Returns: PGSQL_TRANSACTION_IDLE | PGSQL_TRANSACTION_ACTIVE | PGSQL_TRANSACTION_INTRANS | PGSQL_TRANSACTION_INERROR | PGSQL_TRANSACTION_UNKNOWN | PGSQL_TRANSACTION_ACTIVE

Definition at line 910 of file database_core.class.php.

    {
        return pg_transaction_status($this->db);
    }

References db.

◆ test_me()

static DatabaseCore::test_me ( )

static

Definition at line 894 of file database_core.class.php.

    {
 
    }

◆ upload()

DatabaseCore::upload ( $p_name )

Definition at line 706 of file database_core.class.php.

    {
        /* there is          no file to          upload */
        if ($_FILES[$p_name]["error"] == UPLOAD_ERR_NO_FILE) {
            return false;
        }
 
        $new_name = tempnam($_ENV['TMP'], $p_name);
        if ($_FILES[$p_name]["error"] > 0) {
            print_r($_FILES);
            echo_error(__FILE__ . ":" . __LINE__ . "Error: " . $_FILES[$p_name]["error"]);
            return false;
        }
        if (strlen($_FILES[$p_name]['tmp_name']) != 0) {
            if (move_uploaded_file($_FILES[$p_name]['tmp_name'], $new_name)) {
                // echo "Image saved";
                $oid = pg_lo_import($this->db, $new_name);
                if ($oid == false) {
                    echo_error(__FILE__, __LINE__, "cannot upload document");
                    $this->rollback();
                    return false;
                }
                return $oid;
            } else {
                echo "<H1>Error</H1>";
                $this->rollback();
                return false;
            }
        }
        return false;
    }

References $new_name, db, echo_error(), and rollback().

Referenced by Database\save_receipt().

Here is the call graph for this function:

◆ verify()

DatabaseCore::verify ( )

Definition at line 91 of file database_core.class.php.

    {
        // Verify that the elt we want to add is correct
    }

Field Documentation

◆ $array

DatabaseCore::$array

Definition at line 44 of file database_core.class.php.

Referenced by get_array(), get_row(), and get_value().

◆ $db

DatabaseCore::$db

private

database connection

Definition at line 38 of file database_core.class.php.

Referenced by get_db(), and set_db().

◆ $is_open

DatabaseCore::$is_open

private

true is connected

Definition at line 42 of file database_core.class.php.

Referenced by get_is_open(), and set_is_open().

◆ $ret

DatabaseCore::$ret

private

return value

Definition at line 40 of file database_core.class.php.

Referenced by exec_sql(), execute(), fetch_all(), fetch_array(), fetch_result(), fetch_row(), get_ret(), make_list(), num_row(), query_to_csv(), Database\save_receipt(), and set_ret().

◆ $sql

DatabaseCore::$sql

last SQL stmt executed

Definition at line 43 of file database_core.class.php.

Referenced by Database\apply_patch(), clean_orphan_lob(), create_sequence(), execute_script(), get_sql(), make_list(), and set_sql().

The documentation for this class was generated from the following file:

include/lib/database_core.class.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ alter_seq()

◆ clean_orphan_lob()

◆ clear_all_prepare()

◆ clear_prepare()

◆ close()

◆ commit()

◆ count()

◆ count_sql()

◆ create_sequence()

◆ escape_string()

◆ exec_sql()

◆ execute()

◆ execute_script()

◆ exist_blob()

◆ exist_column()

◆ exist_database()

◆ exist_schema()

◆ exist_sequence()

◆ exist_table()

◆ exist_view()

◆ fetch()

◆ fetch_all()

◆ fetch_array()

◆ fetch_result()

◆ fetch_row()

◆ get_affected()

◆ get_array()

◆ get_current_seq()

◆ get_db()

◆ get_encoding()

◆ get_is_open()

◆ get_name()

◆ get_next_seq()

◆ get_ret()

◆ get_row()

◆ get_sql()

◆ get_value()

◆ is_prepare()

◆ lo_export()

◆ lo_import()

◆ lo_unlink()

◆ make_array()

◆ make_list()

◆ nb_column()

◆ num_row()

◆ prepare()

◆ query_to_csv()

◆ rollback()

◆ search_sql_inject()

◆ set_db()

◆ set_encoding()

◆ set_is_open()

◆ set_ret()

◆ set_sql()

◆ size()

◆ start()

◆ status()

◆ test_me()

◆ upload()

◆ verify()

Field Documentation

◆ $array

◆ $db

◆ $is_open

◆ $ret

◆ $sql