Dossier Class Reference

manage the current dossier, everywhere we need to know to which folder we are connected, because we can't use $_SESSION, we need to pass the dossier_id via a _GET or a POST variable private static $variable=array("id"=>"dos_id", "name"=>"dos_name", "desc"=>"dos_description"); More...

Collaboration diagram for Dossier:

Public Member Functions
	__construct ($p_id)
	count ()
	Count the number of folder in the repository. More...
	get_info ()
	get_parameter ($p_string)
	get_user_folder ($sql="")
	Return all the users as an array but NOALYSS_ADMINISTRATOR, that user cannot be changed by the interface for administrating user. More...
	load ()
	save ()
	set_parameter ($p_string, $p_value)
	update ()

Static Public Member Functions
static	check ()
	check if gDossier is set ?? dead code ??? More...
static	connect ()
static	get ()
	return a string to put to gDossier into a GET More...
static	get_version ($p_cn)
static	hidden ()
	return a string to set gDossier into a FORM More...
static	id ()
	return the 'gDossier' value after a check More...
static	name ($id=0)
	retrieve the name of the current dossier More...
static	set_current ($p_dossier)
	Set the current dossier to $p_dossier. More...
static	show_dossier ($p_type, $p_login="", $p_text="", $limit=0)
	Show the folder where user have access. More...
static	synchro_admin ($p_id)
	connect to folder and give to admin. More...
static	upgrade ()
	Upgrade check if the folder ACCOUNT_REPOSITORY needs to be upgrade thanks the variable DBVERSIONREPO and run all the SQL script named ac-upgradeX.sql from the folder noalyss/include/sql/patch until X equal DBVERSIONREPO-1 After it will call the function apply_patch, remove_inexistant_user and clean_orphan_log for each folder. More...

Data Fields
	$cn
	Database connexion. More...
	$dos_description
	$dos_email
	$dos_id
	number of db More...
	$dos_name

Static Private Attributes
static	$variable

Detailed Description

manage the current dossier, everywhere we need to know to which folder we are connected, because we can't use $_SESSION, we need to pass the dossier_id via a _GET or a POST variable private static $variable=array("id"=>"dos_id", "name"=>"dos_name", "desc"=>"dos_description");

Definition at line 39 of file dossier.class.php.

Constructor & Destructor Documentation

__construct()

Dossier::__construct

(

$p_id

)

Definition at line 53 of file dossier.class.php.

    {
        $this->cn=new Database();  // Connect to the repository
        $this->dos_id=$p_id;
    }

References $p_id, and cn.

Member Function Documentation

check()

static Dossier::check ( )

static

check if gDossier is set ?? dead code ???

Definition at line 175 of file dossier.class.php.

    {
        try {
            $http=new HttpInput();
            $id=$http->request("gDossier","number");
            if ($id > 999999 || $id < 0) throw new \Exception(_("Dossier max dépassé "));
        } catch (\Exception $e) {
 
            die('Dossier invalide ');
        }
 
    }

References $e, $http, and $id.

Referenced by set_current().

connect()

static Dossier::connect ( )

static

Examples

acc_ledger_historyTest.php, and inplace_edit.test.php.

Definition at line 295 of file dossier.class.php.

    {
        static $cn=null;
        if ($cn!=null)
            return $cn;
        $id=Dossier::id();
        $cn=new Database($id);
        return $cn;
    }

References $cn, $id, and id().

Referenced by Periode_Ledger_Table\__construct(), Operation_Exercice\__construct(), Acc_Ledger_Search\__construct(), Anc_Account_Table\__construct(), Template_Card_Category\add_mandatory_attr(), Print_Ledger\available_ledger(), Acc_Report_MTable\build(), Mobile_Device_MTable\build(), Acc_Other_Tax_MTable\build(), Forecast_Category_MTable\build(), Forecast_Item_MTable\build(), Parameter_Extra_MTable\build(), Print_Operation_Currency\build(), Acc_Operation_Note\build_jrn_id(), Card_Multiple\build_sql(), Document_Option\can_add_comment(), Acc_Plan_MTable\check(), Anc_Account_Table\check(), Template_Card_Category\check(), Tva_Rate_MTable\check(), Periode_Ledger\close(), Card_Multiple\count_sql(), Operation_Exercice\delete(), Anc_Account_Table\delete(), Template_Card_Category\delete(), Tva_Rate_MTable\delete(), Calendar\display(), ITva_Popup\display(), Noalyss\Mobile\display_menu(), Card_Multiple\display_option(), Periode\display_periode_global(), Operation_Exercice\display_result(), Acc_Plan_MTable\display_row(), Anc_Account_Table\display_row(), Acc_Other_Tax_MTable\display_row_custom(), Operation_Exercice\display_total(), Calendar\fill_from_action(), Periode\filter_exercice(), find_default_menu(), Periode\form_exercice_add(), Periode\form_exercice_label(), Periode\form_periode_add(), Fiche\from_qcode(), Calendar\get_preference(), Acc_Account_Ledger\get_used_accounting(), Template_Card_Category\input(), Acc_Other_Tax_MTable\input_custom(), Acc_Plan_MTable\input_custom(), Tag_Group_MTable\input_tag(), Operation_Closing\insert(), Operation_Opening\insert(), Document_Option\is_enable_comment(), Document_Option\is_enable_contact_multiple(), Document_Option\is_enable_editable_description(), Document_Option\is_enable_make_feenote(), Document_Option\is_enable_make_invoice(), Document_Option\is_enable_operation_detail(), Document_Option\is_enable_video_conf(), Html_Input_Noalyss\ledger_supplemental_tax(), Noalyss_Appearance\load(), Noalyss\Mobile\load_module(), Document_Option\option_comment(), Document_Option\option_operation_detail(), Document_Option\option_video_conf(), rebuild_access_code(), Periode_Ledger\reopen(), Acc_Operation_Note\save(), Action_Document_Type_MTable\save(), Currency_MTable\save(), Noalyss_Appearance\save(), Tva_Rate_MTable\save(), Calendar\set_month_year(), Operation_Exercice\submit_transfer(), Acc_Ledger\test_me(), Acc_Bilan\test_me(), Acc_Operation\test_me(), Acc_Reconciliation\test_me(), Anc_Balance_Double\test_me(), Anc_Balance_Simple\test_me(), Anc_Group\test_me(), Anc_Group_Operation\test_me(), Anc_Operation\test_me(), Anc_Plan\test_me(), Fiche\test_me(), Html_Table\test_me(), Operation_Exercice\transform(), Calendar\zoom_calendar(), and Calendar\zoom_list().

Here is the call graph for this function:

count()

Dossier::count

(

)

Count the number of folder in the repository.

Returns

integer

Definition at line 129 of file dossier.class.php.

    {
        $nb_folder=$this->cn->get_value('select count(*) from ac_dossier');
        return $nb_folder;
    }

References cn.

Referenced by synchro_admin().

get()

static Dossier::get ( )

static

return a string to put to gDossier into a GET

Definition at line 192 of file dossier.class.php.

    {
        $http=new \HttpInput();
        return "gDossier=".$http->request("gDossier","number");
    }

References $http.

get_info()

Dossier::get_info

(

)

Definition at line 243 of file dossier.class.php.

    {
        return var_export(self::$variable, true);
    }

References $variable.

get_parameter()

Dossier::get_parameter

(

$p_string

)

Definition at line 221 of file dossier.class.php.

    {
        if (array_key_exists($p_string, self::$variable))
        {
            $idx=self::$variable[$p_string];
            return $this->$idx;
        }
        else
            throw new Exception("Attribut inexistant $p_string");
    }

References $idx, and $variable.

get_user_folder()

Dossier::get_user_folder

(

$sql = ""

)

Return all the users as an array but NOALYSS_ADMINISTRATOR, that user cannot be changed by the interface for administrating user.

Parameters

SQL

$sql

sql string to add to the query :

Note

that string MUST be the result of Database::escape_string

Definition at line 141 of file dossier.class.php.

    {
 
        $sql="
            select
                use_id,
                use_first_name,
                use_name,
                use_email,
                use_login,
                use_active,
                use_admin,
                ag_dossier
            from
            ac_users  as ac
            left join    
                (select array_to_string(array_agg(dos_name),',') as ag_dossier,
                        jt.use_id as jt_use_id
                  from ac_dossier as ds
                    join  jnt_use_dos as jt on (jt.dos_id=ds.dos_id)
                    group by jt.use_id) as dossier_name on (jt_use_id=ac.use_id)
            where
            use_login!=$1
            $sql
            ";
 
        $res=$this->cn->get_array($sql, array(NOALYSS_ADMINISTRATOR));
        return $res;
    }

References $res, $sql, cn, and NOALYSS_ADMINISTRATOR.

get_version()

static Dossier::get_version (   $p_cn )

static

Definition at line 290 of file dossier.class.php.

    {
        return $p_cn->get_value('select max(val) from version');
    }

hidden()

static Dossier::hidden ( )

static

return a string to set gDossier into a FORM

Examples

acc_ledger_historyTest.php.

Definition at line 202 of file dossier.class.php.

    {
        $http=new \HttpInput();
 
        return '<input type="hidden" id="gDossier" name="gDossier" value="'.$http->request("gDossier","number").'">';
    }

References $http.

Referenced by Operation_Exercice\display_result(), Acc_Parm_Code\form(), Acc_Operation\form_clone_operation(), Tax_Summary\form_export_csv(), Tax_Summary\form_export_pdf(), and Periode\form_periode_add().

id()

static Dossier::id ( )

static

return the 'gDossier' value after a check

Examples

html_tab.test.php, inplace_edit.test.php, and progress-bar.test.php.

Definition at line 61 of file dossier.class.php.

    {
        $http=new HttpInput();
        
        return $http->request('gDossier','number');
    }

References $http.

Referenced by Card_Attribut_MTable\__construct(), Manage_Table_SQL\__construct(), Tag_Action\add_clear_button(), Tag_Operation\add_clear_button(), Document\anchor(), Acc_Ledger_Search\build_name_filter(), Acc_Ledger_Search\build_search_filter(), Follow_Up_Other_Concerned\button_action_add_concerned_card(), Acc_Account_Ledger\button_csv(), Fiche\button_csv(), Acc_Account_Ledger\button_pdf(), Fiche\button_pdf(), Acc_Ledger_Search\button_propose_filter(), connect(), Acc_Ledger\CurrencyInput(), Pre_Op_Advanced\display(), Follow_Up\display_children(), Acc_Bilan\display_form(), Follow_Up_Other_Concerned\display_linked_count(), Follow_Up\display_parent(), Operation_Exercice\display_result(), Follow_Up_Other_Concerned\display_row(), Acc_Plan_MTable\display_row(), Follow_Up\display_saved_search(), Noalyss\Mobile\execute_menu(), Anc_Plan\form(), Acc_Operation\form_clone_operation(), Document\generate(), Document_Type\get_list(), Acc_Ledger\input(), ICard\input(), Acc_Plan_MTable\input(), Template_Card_Category\input(), Tva_Rate_MTable\input(), Acc_Other_Tax_MTable\input_custom(), Acc_Report_MTable\input_custom(), Anticipation\input_form(), Acc_Report\input_name(), Tag_Group_MTable\input_tag(), Operation_Closing\insert(), Acc_Ledger_Search\list_operation_to_reconcile(), Profile_Menu\printing(), Acc_Ledger_Search\search_form(), Tag_Action\select_tag_search(), and Profile_Menu\sub_menu().

load()

Dossier::load

(

)

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

    {
 
        $sql="select * from ac_dossier where dos_id=$1";
 
        $res=$this->cn->exec_sql(
                $sql, array($this->dos_id)
        );
 
        if (Database::num_row($res)==0)
            return;
        $row=Database::fetch_array($res, 0);
        foreach ( self::$variable as $idx)
        {
            $this->$idx=$row[$idx];
        }
    }

References $idx, $res, $row, $sql, $variable, cn, DatabaseCore\fetch_array(), and DatabaseCore\num_row().

Here is the call graph for this function:

name()

static Dossier::name (   $id = 0 )

static

retrieve the name of the current dossier

Definition at line 211 of file dossier.class.php.

    {
 
        $http=new \HttpInput();
        $cn=new Database();
        $id=($id==0)?$http->request("gDossier","number"):$id;
        $name=$cn->get_value("select dos_name from ac_dossier where dos_id=$1", array($id));
        return $name;
    }

References $cn, $http, $id, and $name.

save()

Dossier::save

(

)

Definition at line 248 of file dossier.class.php.

    {
        $this->update();
    }

References update().

Here is the call graph for this function:

set_current()

static Dossier::set_current (   $p_dossier )

static

Set the current dossier to $p_dossier.

Parameters

numeric

$p_dossier

Definition at line 430 of file dossier.class.php.

                                            {
        
        self::check($p_dossier);
        put_global([ [ "key"=>"gDossier","value"=>$p_dossier]]);
 
    }

References check(), and put_global().

Here is the call graph for this function:

set_parameter()

Dossier::set_parameter	(		$p_string,
			$p_value
	)

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

    {
        if (array_key_exists($p_string, self::$variable))
        {
            $idx=self::$variable[$p_string];
            $this->$idx=$p_value;
        }
        else
            throw new Exception("Attribut inexistant $p_string");
    }

References $idx, and $variable.

show_dossier()

static Dossier::show_dossier (   $p_type,   $p_login = "",   $p_text = "",   $limit = 0  )

static

Show the folder where user have access.

Parameters

p_type	string A for all dossiers R for accessible folders X forbidden folders
p_login	is the user name
p_text	is a part of the name where are looking for

Returns

nothing

Definition at line 79 of file dossier.class.php.

    {
        $cn=new Database();
        $str_limit=($limit==0)?'':' limit '.$limit;
        if ($p_type=="A")
        {
            $l_sql="select *, 'W' as priv_priv "
                    ."from ac_dossier "
                    ."where "
                    ."dos_name ilike '%'|| $2 ||'%'"
                    ."or dos_description ilike '%'|| $2 || '%' "
                    ."ORDER BY dos_name $str_limit  ";
            $a_row=$cn->get_array($l_sql, $p_text);
            return $a_row;
        }
        else if ($p_type=="R")
        {
            $l_sql="select * from jnt_use_dos
                   natural join ac_dossier
                   natural join ac_users
                   where
                   use_login=$1
                   and ( dos_name ilike '%'||  $2 || '%'  or dos_description ilike '%'|| $2|| '%' )
                   
                   order by dos_name 
                   $str_limit
                   ";
 
            $a_row=$cn->get_array($l_sql, array($p_login, $p_text));
            return $a_row;
        }
        else if ($p_type=='X')
        {
            $l_sql=" select * from ac_dossier where dos_id not in 
                  (select dos_id from jnt_use_dos where use_id=$1)
                  and ( dos_name ilike '%'||  $2|| '%'  or dos_description ilike '%'||  $2 || '%')
                  order by dos_name ".$str_limit;
            $a_row=$cn->get_array($l_sql, array($p_login, $p_text));
            return $a_row;
        }
        else
        {
            throw new Exception(_("Erreur paramètre"));
        }
    }

References $a_row, $cn, $limit, and $p_type.

synchro_admin()

static Dossier::synchro_admin (   $p_id )

static

connect to folder and give to admin.

the profile Admin(builtin)

Parameters

int

$p_id

dossier::id()

synchro global

Definition at line 309 of file dossier.class.php.

    {
// connect to target
        $cn=new Database($p_id);
 
        if (!$cn->exist_table("profile_menu"))
        {
            echo_warning("Dossier invalide");
            return;
        }
// connect to repo
        $repo=new Database();
 
        $a_admin=$repo->get_array("select use_login from ac_users where
                        use_admin=1 and use_active=1");
        try
        {
            /**
             * synchro global
             */
            $cn->start();
            for ($i=0; $i<count($a_admin); $i++)
            {
                Noalyss_user::grant_admin_access($a_admin[$i]['use_login'], $p_id);
            }
            $cn->commit();
        }
        catch (Exception $e)
        {
 
            echo_warning($e->getMessage());
              record_log($e);
            $cn->rollback();
        }
    }

References $cn, $e, $i, $p_id, $repo, count(), echo_warning(), and record_log().

Referenced by upgrade().

Here is the call graph for this function:

update()

Dossier::update

(

)

Definition at line 253 of file dossier.class.php.

    {
        if (noalyss_strlentrim($this->dos_name)==0)
            return;
 
        if ($this->cn->get_value("select count(*) from ac_dossier "
                        ." where dos_name=$1 and dos_id<>$2", array($this->dos_name, $this->dos_id))!=0)
            return;
 
        $sql="update ac_dossier set dos_name=$1,dos_description=$2 ,dos_email=$3".
                " where dos_id = $4";
        $res=$this->cn->exec_sql(
                $sql, array(trim($this->dos_name),
            trim($this->dos_description),
            $this->dos_email,
            $this->dos_id)
        );
    }

References $res, $sql, cn, and noalyss_strlentrim().

Referenced by save().

Here is the call graph for this function:

upgrade()

static Dossier::upgrade ( )

static

Upgrade check if the folder ACCOUNT_REPOSITORY needs to be upgrade thanks the variable DBVERSIONREPO and run all the SQL script named ac-upgradeX.sql from the folder noalyss/include/sql/patch until X equal DBVERSIONREPO-1 After it will call the function apply_patch, remove_inexistant_user and clean_orphan_log for each folder.

Definition at line 351 of file dossier.class.php.

    {
        $rep=new Database();
        /* If multi folders */
        $Resdossier=$rep->exec_sql("select dos_id, dos_name from ac_dossier");
        $MaxDossier=$rep->size($Resdossier);
 
        //----------------------------------------------------------------------
        // Upgrade the account_repository
        //----------------------------------------------------------------------
        echo "<h2>"._("Mise à jour de la base de données principale")."</h2>";
        $cn=new Database();
        if (DEBUGNOALYSS == 0)
            ob_start();
        $MaxVersion=DBVERSIONREPO-1;
        for ($i=4; $i<=$MaxVersion; $i++)
        {
            if ($cn->get_version()<=$i)
            {
                $cn->execute_script(NOALYSS_INCLUDE.'/sql/patch/ac-upgrade'.$i.'.sql');
            }
        }
        if (DEBUGNOALYSS == 0)             ob_end_clean();
        //----------------------------------------------------------------------
        // Upgrade the folders
        //----------------------------------------------------------------------
        echo "<h2>"._("Mise à jour dossiers")."</h2>";
 
        for ($e=0; $e<$MaxDossier; $e++)
        {
            $db_row=Database::fetch_array($Resdossier, $e);
            $name=$rep->format_name($db_row['dos_id'], 'dos');
            echo "<h3>Patching ".$db_row['dos_name'].'</h3>';
            echo _('Base de données')." ".$name;
 
            if ($rep->exist_database($name)>0)
            {
                $db=new Database($db_row['dos_id'], 'dos');
                $db->apply_patch($db_row['dos_name']);
                Dossier::synchro_admin($db_row['dos_id']);
                Noalyss_user::remove_inexistant_user($db_row['dos_id']);
                $db->clean_orphan_lob();
            }
            else
            {
                echo_warning(_("Dossier inexistant")." $name");
            }
        }
 
        //----------------------------------------------------------------------
        // Upgrade the template
        //----------------------------------------------------------------------
        $Resdossier=$rep->exec_sql("select mod_id, mod_name from modeledef");
        $MaxDossier=$rep->size();
        echo "<h2>"._("Mise à jour modèles")."</h2>";
 
        for ($e=0; $e<$MaxDossier; $e++)
        {
            $db_row=Database::fetch_array($Resdossier, $e);
            $name=$rep->format_name($db_row['mod_id'], 'mod');
            echo "<h3>Patching ".$db_row['mod_name']."</h3>";
            echo _('Base de données')." ".$name;
            if ($rep->exist_database($name)>0)
            {
                $db=new Database($db_row['mod_id'], 'mod');
                $db->apply_patch($db_row['mod_name']);
                $db->clean_orphan_lob();
            }
            else
            {
                echo_warning(_("Modèle inexistant")." $name");
            }
        }
    }

References $cn, $e, $i, $name, $rep, DBVERSIONREPO, echo_warning(), DatabaseCore\fetch_array(), and synchro_admin().

Here is the call graph for this function:

Field Documentation

$cn

Dossier::$cn

Database connexion.

Definition at line 47 of file dossier.class.php.

Referenced by connect(), name(), show_dossier(), synchro_admin(), and upgrade().

$dos_description

Dossier::$dos_description

Definition at line 50 of file dossier.class.php.

$dos_email

Dossier::$dos_email

Definition at line 51 of file dossier.class.php.

$dos_id

Dossier::$dos_id

number of db

Definition at line 48 of file dossier.class.php.

$dos_name

Dossier::$dos_name

Definition at line 49 of file dossier.class.php.

$variable

Dossier::$variable

staticprivate

Initial value:

=array("id"=>"dos_id",
        "name"=>"dos_name",
        "desc"=>"dos_description",
        "max_email"=>'dos_email')

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

---

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

• include/class/dossier.class.php