Tva_Rate_MTable Class Reference

Configure the tva : code , rate, label ... When using Manage_Table_SQL. More...

Inheritance diagram for Tva_Rate_MTable:

Collaboration diagram for Tva_Rate_MTable:

Public Member Functions
	__construct (V_Tva_rate_SQL $p_table)
	check ()
	Check data are valid. More...
	delete ()
	delete if not used anywhere More...
	getPreviousId ()
	input ()
	display into a dialog box the datarow in order to be appended or modified. More...
	save ()
	save the data in TVA_RATE if tva_both_side is 1 and tva_purchase or tva_sale is empty then it is equal to the other value More...
	setPreviousId ($previous_id)
Public Member Functions inherited from Manage_Table_SQL
	__construct (Data_SQL $p_table)
	add_json_param ($p_attribute, $p_value)
	Add json parameter to the current one. More...
	ajax_delete ()
	Delete a record and return an XML answer for ajax. More...
	ajax_input ($p_status="OK")
	send an xml with input of the object, create an xml answer. More...
	ajax_save ()
	Save the record from Request into the DB and returns an XML to update the Html Element. More...
	can_append_row ()
	return false if the append of the row is forbidden More...
	can_delete_row ()
	return false if the delete of the row is forbidden More...
	can_update_row ()
	return false if the update of the row is forbidden More...
	check ()
	count_error ()
	returns the nb of errors found More...
	create_js_script ()
	we must create first the javascript if we want to update, insert or delete rows. More...
	delete ()
	delete a datarow , the id must be have set before More...
	display_error ()
	Display a list of the error collected. More...
	display_icon_custom ($p_row)
	usually contain a link and calls another page, it must be overriden More...
	display_icon_del ($p_row)
	display_icon_mod ($p_row)
	display_row ($p_row)
	display a data row in the table, with the order defined in a_order and depending of the visibility of the column, all the rows contains the attribute ctl_pk_id , to retrieve in javascript , ie with the function afterSaveFct (see managetable.js) More...
	display_row_custom ($p_key, $p_value, $p_id=0)
	When displaying a row, if a column has the type "custom" , we can call this function to display properly the value including the tag "<td>". More...
	display_table ($p_order="", $p_array=NULL)
	display the data of the table More...
	display_table_header ()
	display the column header excepted the not visible one and in the order defined with $this->a_order More...
	execute_query ($p_order="", $p_array=NULL)
	execute the query (Data_SQL.seek), called by display_table More...
	from_request ()
	get the data from http request strip the not update or not visible data to their initial value. More...
	get_button_add_top ()
	get_col_option ($p_key)
	add extra to column, normally class , javascript or style More...
	get_col_sort ()
	When adding an element , it is column we checked to insert before,. More...
	get_col_type ($p_key)
	return the type of a column More...
	get_current_pos ($p_key)
	get the position of a column More...
	get_current_row ()
	Return the current row printed in display_row. More...
	get_dialog_box ()
	get_dialogbox_style ()
	return the db_style More...
	get_error ($p_col)
	retrieve the error message More...
	get_header_option ($p_key)
	add extra to column Header, normally class , javascript or style More...
	get_icon_del ()
	get_icon_mod ()
	get_js_variable ()
	Get the object name. More...
	get_json ()
	get_object_name ()
	get_order ()
	get_property_updatable ($p_key)
	return True if the column is updatable otherwise false More...
	get_property_visible ($p_key)
	return True if the column is visible otherwise false More...
	get_search_table ()
	Get if we can search in the table. More...
	get_sort_column ()
	return the column to sort More...
	get_table ()
	getCssClass ()
	getTitle ()
	input ()
	display into a dialog box the datarow in order to be appended or modified. More...
	input_custom ($p_key, $p_value)
	this function let you create your own input , for example for a ITEXT , a IRADIO , ... it must be override , there is not default More...
	insert ()
	insert a new value More...
	move ($p_key, $p_idx)
	if we change a column order , the order of the other columns is impacted. More...
	param_set ($p_json)
	Set the parameter of the object (gDossier, ac, plugin_code...) @detail By default , only gDossier will be set . More...
	save ()
	save the Data_SQL Object The noalyss_SQL is not empty More...
	send_header ()
	send the XML headers for the ajax call More...
	set_append_row ($p_value)
	Enable or disable the appending of rows. More...
	set_button_add_top ($button_add_top)
	set_callback ($p_file)
	set the callback function that is passed to javascript More...
	set_col_label ($p_key, $p_display)
	set the name to display for a column More...
	set_col_option ($p_key, $p_value)
	add extra to column, normally class or style More...
	set_col_sort ($p_num)
	When adding an element ,we place it thanks the DOM Attribute sort_value set it to -1 if you want one to append. More...
	set_col_tips ($p_key, $p_comment)
	Set the info for a column, use Icon_Action::infobulle the message are in message_javascript.php. More...
	set_col_type ($p_key, $p_value, $p_array=NULL)
	set the type of a column , it will change in the input db box , the select must supply an array of possible values [val=> , label=>] with the variable $this->key_name->a_value More...
	set_current_row ($current_row)
	set the current row printed in display_row More...
	set_delete_row ($p_value)
	Enable or disable the deletion of rows. More...
	set_dialog_box ($dialog_box)
	set_dialogbox_style ($db_style)
	Dialog box style , by default {position: "fixed", top: '15', width: "auto", "margin-left": "20%"}. More...
	set_error ($p_col, $p_message)
	set the error message for a wrong input More...
	set_header_option ($p_key, $p_value)
	add extra to column Header, normally class or style More...
	set_icon_del ($pString)
	Set the icon to delete at the right or left of the row. More...
	set_icon_mod ($pString)
	Set the icon to modify at the right ,the first col or left of the row, if the mod if custom , you have to override the function display_icon_custom. More...
	set_json ($p_json)
	Set the parameter of the object (gDossier, ac, plugin_code...) @detail By default , only gDossier will be set . More...
	set_object_name ($p_object_name)
	Set the object_name. More...
	set_order ($p_order)
	set_pk ($p_id)
	set the id value of a data row and load from the db More...
	set_property_updatable ($p_key, $p_value)
	set a column of the data row updatable or not More...
	set_property_visible ($p_key, $p_value)
	set a column of the data row visible or not More...
	set_search_table ($search_table)
	Set the table searchable or not. More...
	set_sort_column ($p_col)
	set the column to sort by default More...
	set_table (Data_SQL $p_noalyss_sql)
	set_update_row ($p_value)
	Enable or disable the updating of rows. More...
	set_value ($p_key, $p_value)
	setCssClass ($p_class)
	setTitle ($p_title)
	Set the title of the diabox , default is Donnée. More...
	show_error ($p_col)
	update ()

Private Attributes
	$previous_id
	< previous tva_id, used to know if we update or insert, More...

Additional Inherited Members
Data Fields inherited from Manage_Table_SQL
const	UPDATABLE =1
const	VISIBLE =2
Protected Attributes inherited from Manage_Table_SQL
	$a_col_option
	in display_row and display_custom_row, it is the current row which is used More...
	$a_header_option
	Extra to add to the column Header : CSS Style , CSS class, javascript ,... More...
	$a_info
	Array with the infotip. More...
	$a_label_displaid
	Label of the col. of the datarow. More...
	$a_order
	order of the col More...
	$a_prop
	property for each col. More...
	$a_select
	Possible value if a_type is a SELECT. More...
	$a_type
	Type of the column : date , select ... Only in input. More...
	$aerror
	Array containing the error of the input data. More...
	$button_add_top
	place of the button add on the top, by default true More...
	$callback
	Callback function. More...
	$col_sort
	when inserting, it is the column to sort,-1 to disable it and append only More...
	$cssclass
	< give the title of the diabox , default is Data More...
	$current_row
	CSS class for the dialog box. More...
	$dialog_box
	ID of the dialog box which display the result of the ajax calls. More...
	$dialogbox_style
	style of the dialog box More...
	$icon_del
	place of right or left the icon update or mod, default right, accepted value=left,right More...
	$icon_mod
	place of right or left the icon update or mod, default right, accepted value=left,right,first,custom column for mod More...
	$json_parameter
	Default parameter to add (gDossier...), sent to the ajax callback. More...
	$object_name
	Object_name is used for the javascript , it is the row id to update or delete. More...
	$row_append
	Flag to indicate if rows can be added. More...
	$row_delete
	Flag to indicate if rows can be deleted. More...
	$row_update
	Flag to indicate if rows can be updated. More...
	$search_table
	boolean , by default true ,it is possible to search in the table, More...
	$sort_column
	javascript sort on this column , if empty there is no js sort More...
	$table
	Object Data_SQL. More...
	$title

Detailed Description

Configure the tva : code , rate, label ... When using Manage_Table_SQL.

Examples

tva_parameter.php.

Definition at line 34 of file tva_rate_mtable.class.php.

Constructor & Destructor Documentation

__construct()

Tva_Rate_MTable::__construct

(

V_Tva_rate_SQL

$p_table

)

Definition at line 46 of file tva_rate_mtable.class.php.

    {
        parent::__construct($p_table);
        $this->set_col_label("tva_id", _("id"));
        $this->set_col_label("tva_label", _("label"));
        $this->set_col_label("tva_rate", _("taux"));
        $this->set_col_label("tva_comment", _("Description"));
        $this->set_col_label("tva_both_side", _("Autoliquidation"));
        $this->set_col_label("tva_sale", _("TVA Vente (C)"));
        $this->set_col_label("tva_purchase", _("TVA Achat (D)"));
        $this->set_col_type("tva_both_side", "select",
                array(
            ["value"=>0, "label"=>_("Non")],
            ["value"=>1, "label"=>_("Oui")]
        ));
        $this->set_property_updatable("tva_id", true);
        $this->set_col_label("tva_payment_purchase",_("Exigible achat"));
        $this->set_col_type("tva_payment_purchase","select",
                array(
                    array("value"=>'O',"label"=>"Opération"),
                    array("value"=>'P',"label"=>"Paiement")
                    )
                );
        $this->set_col_label("tva_payment_sale",_("Exigible vente"));
        $this->set_col_type("tva_payment_sale","select",
                array(
                    array("value"=>'O',"label"=>"Opération"),
                    array("value"=>'P',"label"=>"Paiement")
                    )
                );
        $this->a_info=["tva_purchase"=>44,"tva_both_side"=>43,"tva_sale"=>45
            ,"tva_payment_sale"=>74,"tva_payment_purchase"=>74];
        $this->previous_id=null;
    }

References Manage_Table_SQL\set_col_label(), Manage_Table_SQL\set_col_type(), and Manage_Table_SQL\set_property_updatable().

Here is the call graph for this function:

Member Function Documentation

check()

Tva_Rate_MTable::check

(

)

Check data are valid.

1. tva_rate between 0 & 1
2. label is uniq
3. accounting must exist

   Returns

   boolean

Reimplemented from Manage_Table_SQL.

Definition at line 254 of file tva_rate_mtable.class.php.

    {
        $cn=Dossier::connect();
        if ( $this->previous_id == null ) {
            throw new \Exception ("TVA184: no previous TVA id");
        }
        // both accounting can not be empty
        if (trim($this->table->tva_purchase)==""&&trim($this->table->tva_sale)=="")
        {
            $this->set_error("tva_purchase",
                    _("Les 2 postes comptables ne peuvent être nuls"));
            $this->set_error("tva_sale",
                    _("Les 2 postes comptables ne peuvent être nuls"));
        }
 
        // Check the tva rate
        if (trim($this->table->tva_rate)==""||isNumber($this->table->tva_rate)==0||$this->table->tva_rate>1)
        {
            $this->set_error("tva_rate", _("Taux de TVA invalide"));
        }
 
        //Check the label must be unique
        $count=$cn->get_value("select count(*) from tva_rate where tva_id<>$1 and lower(tva_label)=lower($2)",
                [$this->getPreviousId(), $this->table->tva_label]);
        if ($count>0)
        {
            $this->set_error("tva_label", _("Ce nom est déjà utilisé"));
        }
 
        // Check accounting exists for purchase
        if (trim($this->table->tva_purchase)!=""&&$this->table->tva_purchase!="#")
        {
            $count=$cn->get_value("select count(*) from tmp_pcmn where pcm_val = $1",
                    [$this->table->tva_purchase]);
            if ($count==0)
            {
                $this->set_error("tva_purchase", _("Poste comptable inexistant"));
            }
        }
        // Check accounting exists for sale
        if (trim($this->table->tva_sale)!=""&&$this->table->tva_sale!="#")
        {
            $count=$cn->get_value("select count(*) from tmp_pcmn where pcm_val = $1",
                    [$this->table->tva_sale]);
            if ($count==0)
            {
                $this->set_error("tva_sale", _("Poste comptable inexistant"));
            }
        }
 
        // check if tva_both_side is valid
        if ($this->table->tva_both_side!=0&&$this->table->tva_both_side!=1)
        {
            $this->set_error("tva_both_side", _("Choix incorrect"));
        }
        $flag = true;
        if ( isNumber($this->table->tva_id) == 0 || $this->table->tva_id != round($this->table->tva_id) )
        {
            $this->set_error("tva_id",_("Valeur invalide"));
            $flag=false;
        }
        // Check if old tva_id was not overwritting something
        if ( $flag && $this->previous_id != $this->table->tva_id && $cn->get_value("select count(*) from tva_rate where tva_id=$1",[$this->table->tva_id]) > 0)
        {
            $this->set_error("tva_id",_("Code TVA déjà utilisé"));
        }
        // Check that tva_id is a integer not a float
 
        if ($this->count_error()!=0)
            return false;
        return true;
    }

References $cn, $count, $flag, Dossier\connect(), Manage_Table_SQL\count_error(), getPreviousId(), isNumber(), Manage_Table_SQL\set_error(), and table.

Here is the call graph for this function:

delete()

Tva_Rate_MTable::delete

(

)

delete if not used anywhere

Reimplemented from Manage_Table_SQL.

Definition at line 329 of file tva_rate_mtable.class.php.

    {
        $cn=Dossier::connect();
        $count_purchase=$cn->get_value("select count(*) from quant_purchase where qp_vat_code = $1",[$this->table->tva_id]);
        $count_sale=$cn->get_value("select count(*) from quant_sold where qs_vat_code = $1",[$this->table->tva_id]);
        if ( $count_purchase > 0 || $count_sale > 0) {
            throw new Exception(_("Effacement interdit : TVA utilisée"));
        }
        
        // Forbid to remove all tva 
        $count=$cn->get_value("select count(*) from tva_rate");
        if ( $count < 2) {
            throw new Exception(_("Vous ne pouvez pas effacer tous les taux. Si votre société n'utilise pas la TVA, changer dans le menu société"));
        }
        $cn->exec_sql("delete from tva_rate where tva_id=$1", [$this->table->tva_id]);
    }

References $cn, $count, Dossier\connect(), and table.

Here is the call graph for this function:

getPreviousId()

Tva_Rate_MTable::getPreviousId

(

)

Returns

int or null

Definition at line 84 of file tva_rate_mtable.class.php.

    {
        return $this->previous_id;
    }

References $previous_id.

Referenced by check().

input()

Tva_Rate_MTable::input

(

)

display into a dialog box the datarow in order to be appended or modified.

Can be override if you need a more complex form

Reimplemented from Manage_Table_SQL.

Definition at line 104 of file tva_rate_mtable.class.php.

    {
        $nb_order=count($this->a_order);
        echo "<table>";
        for ($i=0; $i<$nb_order; $i++)
        {
            echo "<tr>";
            $key=$this->a_order[$i];
            $label=$this->a_label_displaid[$key];
            $value=$this->table->get($key);
            $error=$this->get_error($key);
            $error=($error=="")?"":HtmlInput::errorbulle($error);
 
            if ($this->get_property_visible($key)===TRUE)
            {
                $info="";
                if ( isset($this->a_info[$key])) {
                    $info=Icon_Action::infobulle($this->a_info[$key]);
                }
                // Label
                echo "<td> {$label} {$info} {$error}</td>";
 
                if ($this->get_property_updatable($key)==TRUE)
                {
                    echo "<td>";
                    if ($this->a_type[$key]=="select")
                    {
                        $select=new ISelect($key);
                        $select->value=$this->a_select[$key];
                        $select->selected=$value;
                        echo $select->input();
                    }
                    elseif ($key=="tva_rate")
                    {
                        $text=new INum($key);
                        $text->value=$value;
                        $text->prec=4;
                        $min_size=(strlen($value??"")<10)?10:strlen($value)+1;
                        $text->size=$min_size;
                        echo $text->input();
                    }
                    elseif ($key=='tva_purchase')
                    {
                        $text=new IPoste("tva_purchase");
                        $text->value=$value;
                        $min_size=10;
                        $text->size=$min_size;
                        $text->set_attribute('gDossier', Dossier::id());
                        $text->set_attribute('jrn', 0);
                        $text->set_attribute('account', 'tva_purchase');
                        echo $text->input();
                        $url="do.php?".http_build_query(array("gDossier"=>Dossier::id(),"ac"=>'CFGPCMN','p_start'=>4));
                        echo HtmlInput::anchor(_("Configuration poste comptable"),$url,"",'target="_blank"');
                    }
                    elseif ($key=='tva_sale')
                    {
                        $text=new IPoste("tva_sale");
                        $text->value=$value;
                        $min_size=10;
                        $text->set_attribute('gDossier', Dossier::id());
                        $text->set_attribute('jrn', 0);
                        $text->set_attribute('account', 'tva_sale');
                        $text->size=$min_size;
                        echo $text->input();
                    }
                    elseif ($this->a_type[$key]=="text")
                    {
                        $text=new IText($key);
                        $text->value=$value;
                        $min_size=(strlen($value??"")<30)?30:strlen($value)+5;
                        $text->size=$min_size;
                        echo $text->input();
                    } elseif ($key == "tva_id") {
                        $inum=new INum($key,$value);
                        echo $inum->input();
                        echo \HtmlInput::hidden("old_tva_id",$value);
 
                    }
                    echo "</td>";
                }
                else
                {
                    printf('<td>%s %s</td>', h($value),
                            HtmlInput::hidden($key, $value)
                    );
                }
            }
            echo "</tr>";
        }
        echo "</table>";
    }

References $error, $i, $label, $select, $text, $url, $value, HtmlInput\anchor(), elseif, HtmlInput\errorbulle(), Manage_Table_SQL\get_error(), Manage_Table_SQL\get_property_updatable(), Manage_Table_SQL\get_property_visible(), h, HtmlInput\hidden(), Dossier\id(), Icon_Action\infobulle(), and table.

Here is the call graph for this function:

save()

Tva_Rate_MTable::save

(

)

save the data in TVA_RATE if tva_both_side is 1 and tva_purchase or tva_sale is empty then it is equal to the other value

Reimplemented from Manage_Table_SQL.

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

    {
        if ( $this->previous_id == null ) {
            throw new \Exception ("TVA184: no previous TVA id");
        }
        $cn=Dossier::connect();
        // if tva_both_side is 1 and tva_purchase or tva_sale is empty then
        // it is equal to the other value
        if ($this->table->tva_both_side==1)
        {
            if ($this->table->tva_purchase=="#"||trim($this->table->tva_purchase)
                    =="#")
            {
                $this->table->tva_purchase=$this->table->tva_sale;
            }
            if ($this->table->tva_sale=="#"||trim($this->table->tva_sale)=="#")
            {
                $this->table->tva_sale=$this->table->tva_purchase;
            }
        }
        $new_tva_id=$this->table->tva_id;
        $tva_rate=new Tva_rate_SQL($cn);
        $tva_rate->setp("tva_id",$new_tva_id);
        $tva_rate->setp("tva_rate", $this->table->tva_rate);
        $tva_rate->setp("tva_label", $this->table->tva_label);
        $tva_rate->setp("tva_comment", $this->table->tva_comment);
        $tva_rate->setp("tva_both_side", $this->table->tva_both_side);
 
        // TVA accounting must be joined and separated with a comma
        $tva_purchase=(trim($this->table->tva_purchase)=="")?"#":$this->table->tva_purchase;
        $tva_sale=(trim($this->table->tva_sale)=="")?"#":$this->table->tva_sale;
        $tva_rate->setp("tva_poste", $tva_purchase.",".$tva_sale);
        $tva_rate->setp("tva_payment_sale", $this->table->tva_payment_sale);
        $tva_rate->setp("tva_payment_purchase", $this->table->tva_payment_purchase);
        if ( $this->previous_id == -1 ) {
            $tva_rate->insert();
        } else {
            $tva_rate->update();
        }
        if ( $this->previous_id != - 1 && $this->previous_id != $new_tva_id) {
            $cn->exec_sql("update tva_rate set tva_id = $1 where tva_id = $2",[$new_tva_id,$this->previous_id]);
            $this->table->setp("tva_id",$new_tva_id);
        }else        $this->table->setp("tva_id",$tva_rate->getp("tva_id"));
 
    }

References $cn, $tva_rate, Dossier\connect(), and table.

Here is the call graph for this function:

setPreviousId()

Tva_Rate_MTable::setPreviousId

(

$previous_id

)

Parameters

int

$previous_id

Definition at line 93 of file tva_rate_mtable.class.php.

                                               : Tva_Rate_MTable
    {
        $this->previous_id = $previous_id;
        return $this;
    }

References $previous_id.

Field Documentation

$previous_id

Tva_Rate_MTable::$previous_id

private

< previous tva_id, used to know if we update or insert,

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

Referenced by getPreviousId(), and setPreviousId().

---

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

• include/class/tva_rate_mtable.class.php