Purpose is to propose a librairy to display a table content and allow to update and delete row , handle also the ajax call thanks the script managetable.js. More...

Inheritance diagram for Manage_Table_SQL:

Collaboration diagram for Manage_Table_SQL:

Public Member Functions
	__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_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 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 , ... 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. 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 ()

Data Fields
const	UPDATABLE =1

const	VISIBLE =2

Protected Attributes
	$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...

	$col_sort
	when inserting, it is the column to sort,-1 to disable it and append only More...

	$dialog_box
	ID of the dialog box which display the result of the ajax calls. 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

Private Attributes
	$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...

	$button_add_top
	place of the button add on the top, by default true More...

	$cssclass
	< give the title of the diabox , default is Data More...

	$current_row
	CSS class for the dialog box. 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 column for mod More...

Detailed Description

Purpose is to propose a librairy to display a table content and allow to update and delete row , handle also the ajax call thanks the script managetable.js.

Code for ajax , here we see the ajax_input for creating a dg box

 $objet->set_pk($p_id);
// It is very important to set the name of the javascript variable 
// Contained in the http_input variable "ctl"
 $objet->set_object_name($objet_name);
 
 // Set the ajax to call
 $objet->set_callback("ajax.php");
 
 // Build the json object for JS
 $http=new HttpInput();
 $plugin_code=$http->request("plugin_code");
 $ac=$http->request("ac");
 $sa=$http->request("sa");
 $aJson=array("gDossier"=>Dossier::id(),
 "ac"=>$ac,
 "plugin_code"=>$plugin_code,
 "sa"=>$sa,
 "sb"=>$sb
 );
 $json=json_encode($aJson);
 $objet->param_set($json);
 
 // Display the box
   header('Content-type: text/xml; charset=UTF-8');
   $xml=$objet->ajax_input();
   echo $xml->save_XML();

See also: ManageTable.js; ajax_accounting.php; sorttable.js

Examples: ajax_manage_table_sql.php, and test_manage_table_sql.php.

Definition at line 65 of file manage_table_sql.class.php.

Constructor & Destructor Documentation

◆ __construct()

Manage_Table_SQL::__construct ( Data_SQL $p_table )

Reimplemented in Forecast_Item_MTable, Anc_Account_Table, and Forecast_Category_MTable.

Definition at line 106 of file manage_table_sql.class.php.

     {
         $this->table=$p_table;
         $order=0;
         foreach ($this->table->name as $key=> $value)
         {
  
             $this->a_label_displaid[$value]=$key;
             $this->a_order[$order]=$value;
             $this->a_prop[$value]=self::UPDATABLE|self::VISIBLE;
             $this->a_type[$value]=$this->table->type[$value];
             $this->a_select[$value]=null;
             $this->a_col_option[$value]="";
             $this->a_header_option[$value]="";
             $order++;
         }
         $this->object_name=uniqid("tbl");
         $this->row_delete=TRUE;
         $this->row_update=TRUE;
         $this->row_append=TRUE;
         $this->callback="ajax.php";
         $this->json_parameter=json_encode(array("gDossier"=>Dossier::id(),
             "op"=>"managetable"));
         $this->aerror=[];
         $this->icon_mod="right";
         $this->icon_del="right";
         $this->col_sort=0;
         // By default no js sort
         $this->sort_column="";
         $this->dialog_box="dtr";
         $this->dialogbox_style=array();
         $this->search_table=true;
         $this->button_add_top=true;
         $this->title=_("Donnée");
         $this->cssclass="inner_box";
         
     }

References $order, $value, Dossier\id(), table, title, and VISIBLE.

Here is the call graph for this function:

Member Function Documentation

◆ add_json_param()

Manage_Table_SQL::add_json_param	(	$p_attribute,
		$p_value
	)

Add json parameter to the current one.

Definition at line 468 of file manage_table_sql.class.php.

                                                    {
         $x=json_decode($this->json_parameter,TRUE);
         $x[$p_attribute]=$p_value;
         $this->json_parameter=json_encode($x, JSON_UNESCAPED_UNICODE|JSON_UNESCAPED_SLASHES|JSON_NUMERIC_CHECK);
     }

Referenced by Mobile_Device_MTable\__construct(), Forecast_Category_MTable\set_forecast_id(), Forecast_Item_MTable\set_forecast_id(), and Mobile_Device_MTable\set_profile_id().

◆ ajax_delete()

Manage_Table_SQL::ajax_delete ( )

Delete a record and return an XML answer for ajax.

If a check is needed before deleting you can override this->delete and throw an exception if the deleting is not allowed

Returns: \DOMDocument

Definition at line 1396 of file manage_table_sql.class.php.

     {
         $status="NOK";
         $xml=new DOMDocument('1.0', "UTF-8");
         try
         {
             $this->delete();
             $status="OK";
             $s1=$xml->createElement("status", $status);
             $ctl=$this->object_name."_".$this->table->get_pk_value();
             $s2=$xml->createElement("ctl_row", $ctl);
             $s3=$xml->createElement("html", _("Effacé"));
             $s4=$xml->createElement("ctl", $this->object_name);
  
             $root=$xml->createElement("data");
             $root->appendChild($s1);
             $root->appendChild($s2);
             $root->appendChild($s3);
             $root->appendChild($s4);
         }
         catch (Exception $ex)
         {
             $s1=$xml->createElement("status", "NOK");
             $s2=$xml->createElement("ctl",
                     $this->object_name."_".$this->table->get_pk_value());
             $s3=$xml->createElement("html", $ex->getMessage());
             $s4=$xml->createElement("ctl", $this->object_name);
  
             $root=$xml->createElement("data");
             $root->appendChild($s1);
             $root->appendChild($s2);
             $root->appendChild($s3);
             $root->appendChild($s4);
         }
         $xml->appendChild($root);
         return $xml;
     }

References $ctl, $ex, $root, $status, $xml, and table.

◆ ajax_input()

Manage_Table_SQL::ajax_input ( $p_status = "OK" )

send an xml with input of the object, create an xml answer.

It will call Manage_Table_SQL.input to display the input , but if that function returns false, the "save" button will disappear but the form can be submitted with enter.

See also

input XML tag

status : OK , NOK
ctl : Dom id to update
content : Html answer

Returns: DomDocument

Definition at line 1308 of file manage_table_sql.class.php.

     {
         $xml=new DOMDocument("1.0", "UTF-8");
         $xml->createElement("status", $p_status);
         try
         {
             $status=$p_status;
  
             ob_start();
  
             echo HtmlInput::title_box($this->getTitle(), $this->dialog_box,"close","","y","y");
             printf('<form id="frm%s_%s"  method="POST" onsubmit="%s.save(\'frm%s_%s\');return false;">',
                     $this->object_name, $this->table->get_pk_value(),
                     $this->object_name, $this->object_name,
                     $this->table->get_pk_value());
             $can_update=$this->input();
             $can_update =(  $can_update===false) ? false:true;
             // JSON param to hidden
             echo HtmlInput::json_to_hidden($this->json_parameter);
             echo HtmlInput::hidden("p_id", $this->table->get_pk_value());
             // button Submit and cancel
             $close=sprintf("\$('%s').remove()", $this->dialog_box);
             // display error if any
             $this->display_error();
             echo '<ul class="aligned-block">';
             // form readonly
             if ( $can_update ) {
                 echo '<li>',
                     HtmlInput::submit('update', _("Sauver")),
                '</li>';
             }
             echo '<li>',
             HtmlInput::button_action(_("Annuler"), $close, "", "smallbutton"),
             '</li>',
             '</ul>';
             echo "</form>";
             
  
             $html=ob_get_contents();
             ob_end_clean();
  
             $s1=$xml->createElement("status", $status);
             $ctl=$this->object_name."_".$this->table->get_pk_value();
             $s2=$xml->createElement("ctl_row", $ctl);
             $s4=$xml->createElement("ctl", $this->object_name);
             $s3=$xml->createElement("html");
             $t1=$xml->createTextNode($html);
             $s3->appendChild($t1);
  
             $root=$xml->createElement("data");
             $root->appendChild($s1);
             $root->appendChild($s2);
             $root->appendChild($s3);
             $root->appendChild($s4);
         }
         catch (Exception $ex)
         {
             $s1=$xml->createElement("status", "NOK");
             $s3=$xml->createElement("ctl", $this->object_name);
             $s2=$xml->createElement("ctl_row",
             $this->object_name."_".$this->table->get_pk_value());
             $s4=$xml->createElement("html", $ex->getTraceAsString());
             
             $root=$xml->createElement("data");
             $root->appendChild($s1);
             $root->appendChild($s2);
             $root->appendChild($s3);
             $root->appendChild($s4);
         }
         $xml->appendChild($root);
         return $xml;
     }

References $close, $ctl, $ex, $html, $root, $status, $xml, HtmlInput\button_action(), display_error(), getTitle(), HtmlInput\hidden(), input(), HtmlInput\json_to_hidden(), HtmlInput\submit(), table, and HtmlInput\title_box().

Referenced by ajax_save().

Here is the call graph for this function:

◆ ajax_save()

Manage_Table_SQL::ajax_save ( )

Save the record from Request into the DB and returns an XML to update the Html Element.

The function check() will be called before saving

See also: check

Returns: \DOMDocument

Definition at line 1234 of file manage_table_sql.class.php.

     {
  
         $status="NOK";
         $xml=new DOMDocument('1.0', "UTF-8");
         try
         {
             // fill up object with $_REQUEST
             $this->from_request();
             // Check if the data are valid , if not then display the
             // input values with the error message 
             //
             if ($this->check()==false)
             {
                 $xml=$this->ajax_input("NOK");
                 return $xml;
             }
             else
             {
                 // Data are valid so we can save them
                 $this->save();
                 // compose the answer
                 $status="OK";
                 $s1=$xml->createElement("status", $status);
                 $ctl=$this->object_name."_".$this->table->get_pk_value();
                 $s2=$xml->createElement("ctl_row", $ctl);
                 $s4=$xml->createElement("ctl", $this->object_name);
                 ob_start();
                 $this->table->load();
                 $array=$this->table->to_array();
                 $this->display_row($array);
                 $html=ob_get_contents();
                 ob_end_clean();
                 $s3=$xml->createElement("html");
                 $t1=$xml->createTextNode($html);
                 $s3->appendChild($t1);
             }
  
             $root=$xml->createElement("data");
             $root->appendChild($s1);
             $root->appendChild($s2);
             $root->appendChild($s3);
             $root->appendChild($s4);
             $xml->appendChild($root);
         }
         catch (Exception $ex)
         {
             $s1=$xml->createElement("status", "NOK");
             $s2=$xml->createElement("ctl_row",
             $this->object_name."_".$this->table->get_pk_value());
             $s4=$xml->createElement("ctl", $this->object_name);
             $s3=$xml->createElement("html", $ex->getTraceAsString());
             $root=$xml->createElement("data");
             $root->appendChild($s1);
             $root->appendChild($s2);
             $root->appendChild($s3);
             $root->appendChild($s4);
             $xml->appendChild($root);
         }
         return $xml;
     }

References $array, $ctl, $ex, $html, $root, $status, $xml, ajax_input(), check(), display_row(), from_request(), save(), and table.

Here is the call graph for this function:

◆ can_append_row()

Manage_Table_SQL::can_append_row ( )

return false if the append of the row is forbidden

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

     {
  
         return $this->row_append;
     }

References $row_append.

Referenced by display_table().

◆ can_delete_row()

Manage_Table_SQL::can_delete_row ( )

return false if the delete of the row is forbidden

Definition at line 641 of file manage_table_sql.class.php.

     {
         return $this->row_delete;
     }

References $row_delete.

Referenced by display_icon_del(), and display_table_header().

◆ can_update_row()

Manage_Table_SQL::can_update_row ( )

return false if the update of the row is forbidden

Definition at line 570 of file manage_table_sql.class.php.

     {
  
         return $this->row_update;
     }

References $row_update.

Referenced by display_icon_mod(), display_row(), and display_table_header().

◆ check()

Manage_Table_SQL::check ( )

   @brief This function can be overrided to check the data before 
   inserting , updating or removing, above an example of an overidden check.

   Usually , you get the row of the table (get_table) , you check the conditions
   if an condition is not met then you set the error with $this->set_error 

   if there are error (returns false otherwise true

   @see set_error get_error count_error
   @return boolean

function check()
    {
        global $cn;
        $table=$this->get_table();
        $is_error=0;
        $insert=false;
        // sect_codename must be unique 
        if ( $table->exist() > 0) {
            $insert=1;
        }
        $count=$cn->get_value(" select count(*) from syndicat.treasurer where tr_login=$1 and sect_id=$2 and tr_id<>$3",
                array(
                    $table->tr_login,
                    $table->section_full_name,
                    $table->tr_id
                ));
        if ($count > 0 ) {
            $this->set_error("section_full_name",_("Ce trésorier a déjà accès à cette section"));
            $is_error++;
        }
        if ( $is_error > 0 ) return false;
        return true;
    }    

Reimplemented in Tva_Rate_MTable, Forecast_Item_MTable, Acc_Plan_MTable, Card_Attribut_MTable, Mobile_Device_MTable, Currency_MTable, Acc_Report_MTable, Action_Document_Type_MTable, Forecast_Category_MTable, Anc_Account_Table, Payment_Method_MTable, Template_Card_Category, and Parameter_Extra_MTable.

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

     {
         return true;
     }

Referenced by ajax_save().

◆ count_error()

Manage_Table_SQL::count_error ( )

returns the nb of errors found

Definition at line 296 of file manage_table_sql.class.php.

     {
         return count($this->aerror);
     }

Referenced by Mobile_Device_MTable\check(), Card_Attribut_MTable\check(), Forecast_Item_MTable\check(), and Tva_Rate_MTable\check().

◆ create_js_script()

Manage_Table_SQL::create_js_script ( )

we must create first the javascript if we want to update, insert or delete rows.

It is the default script .

Definition at line 516 of file manage_table_sql.class.php.

     {
         $style=json_encode($this->dialogbox_style);
         echo "
                 <script>
                 var {$this->object_name}=new ManageTable(\"{$this->table->table}\");
                 {$this->object_name}.set_callback(\"{$this->callback}\");
                 {$this->object_name}.param_add({$this->json_parameter});
                 {$this->object_name}.set_sort({$this->get_col_sort()});
                 {$this->object_name}.set_control(\"{$this->get_dialog_box()}\");
                 {$this->object_name}.set_style($style);
                 {$this->object_name}.cssclass=\"{$this->cssclass}\";
                 </script>
  
         ";
     }

References $style.

◆ delete()

Manage_Table_SQL::delete ( )

delete a datarow , the id must be have set before

See also: from_request

Reimplemented in Currency_MTable, Tva_Rate_MTable, Card_Attribut_MTable, Action_Document_Type_MTable, Anc_Account_Table, and Template_Card_Category.

Definition at line 1385 of file manage_table_sql.class.php.

     {
         $this->table->delete();
     }

References table.

◆ display_error()

Manage_Table_SQL::display_error ( )

Display a list of the error collected.

See also: get_error set_error

Definition at line 1486 of file manage_table_sql.class.php.

     {
         $nb_order=count($this->a_order);
         if (count($this->aerror)==0)
             return;
         echo "<span class=\"notice\">Liste erreurs :</span>";
         for ($i=0; $i<$nb_order; $i++)
         {
             $key=$this->a_order[$i];
             $label=$this->a_label_displaid[$key];
             $error=$this->get_error($key);
             $error=($error=="")?"":"<span class=\"notice\" style=\"font-weight:normal;font-style:normal;display:block\">".h($label)." : ".h($this->get_error($key))."</span>";
  
             echo $error;
         }
         echo "</ul>";
     }

References $error, $i, $label, get_error(), and h.

Referenced by ajax_input().

Here is the call graph for this function:

◆ display_icon_del()

Manage_Table_SQL::display_icon_del ( $p_row )

Definition at line 956 of file manage_table_sql.class.php.

     {
         if ($this->can_delete_row())
         {
             echo "<td>";
             $js=sprintf("%s.remove('%s','%s');", $this->object_name,
                     $p_row[$this->table->primary_key], $this->object_name
             );
             echo Icon_Action::trash(uniqid(), $js);
             echo "</td>";
         }
     }

References $js, can_delete_row(), table, and Icon_Action\trash().

Referenced by display_row().

Here is the call graph for this function:

◆ display_icon_mod()

Manage_Table_SQL::display_icon_mod ( $p_row )

Definition at line 943 of file manage_table_sql.class.php.

     {
         if ($this->can_update_row())
         {
             echo "<td>";
             $js=sprintf("%s.input('%s','%s');", $this->object_name,
                     $p_row[$this->table->primary_key], $this->object_name
             );
             echo Icon_Action::modify(uniqid(), $js);
             echo "</td>";
         }
     }

References $js, can_update_row(), Icon_Action\modify(), and table.

Referenced by display_row().

Here is the call graph for this function:

◆ display_row()

Manage_Table_SQL::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

Parameters

array $p_row contains a row from the database

See also: set_col_type; input_custom; display_table; display_row_custom

From database

Reimplemented in Card_Attribut_MTable, Currency_MTable, Forecast_Item_MTable, Anc_Account_Table, and Acc_Plan_MTable.

Definition at line 978 of file manage_table_sql.class.php.

     {
         
         $pk_id=$p_row[$this->table->primary_key];
         printf('<tr id="%s_%s">', $this->object_name,
                 $pk_id)
         ;
         
         if ($this->icon_mod=="left")
             $this->display_icon_mod($p_row);
         if ($this->icon_del=="left")
             $this->display_icon_del($p_row);
         
         $nb_order=count($this->a_order);
         for ($i=0; $i<$nb_order; $i++)
         {
             $this->current_row=$p_row;
             $v=$this->a_order[$i];
             
             if ($i==0&&$this->icon_mod=="first"&&$this->can_update_row())
             {
                 $js=sprintf("onclick=\"%s.input('%s','%s');\"", $this->object_name,
                         $pk_id, $this->object_name);
                 $td=($i == $this->col_sort ) ? sprintf('<td sorttable_customkey="X%s" class="%s">',
                         $p_row[$v],$this->a_col_option[$v]):"<td>";
                 echo $td.HtmlInput::anchor($p_row[$v], "", $js).'</td>';
             }
             elseif ( $i == $this->col_sort && $this->get_property_visible($v) )
             {
                 if (  $this->get_col_type($v) == 'text') {
                     echo td($p_row[$v],sprintf(' sorttable_customkey="X%s" ',$p_row[$v]));
                 } elseif ( $this->get_col_type($v) == 'numeric') {
                     echo td($p_row[$v],$this->a_col_option[$v],$p_row[$v]);
                 }  elseif ($this->get_col_type($v)=="custom") {
                     // For custom col
                     echo $this->display_row_custom($v,$p_row[$v],$pk_id);
                 }else {
                     echo td($p_row[$v],sprintf(' sorttable_customkey="X%s" ',$p_row[$v]),$this->a_col_option[$v]);
                     
                 }
             }
             elseif ( ! $this->get_property_visible($v)) { 
                 continue;
             }
             else
             {
                 if ($this->get_col_type($v)=="select")
                 {
                     /**
                      * From database
                      */
                     $idx=$p_row[$v];
                     /*
                      * Check if index exists
                      */
                     $array_to_search=$this->a_select[$v];
                     $value=$p_row[$v];
                     
                     $nb_search=(is_array($array_to_search))?count($array_to_search):0;
                     $found=FALSE;
                     for ($e=0; $e<$nb_search; $e++)
                     {
                         if (isset($array_to_search[$e]['value'])&&$array_to_search[$e]['value']==$value)
                         {
                             $found=TRUE;
                             echo td($array_to_search[$e]['label'],$this->a_col_option[$v]);
                         }
                     }
  
                     if (!$found)
                     {
                         echo td("--");
                     }
                 } elseif ($this->get_col_type($v)=="custom") {
                     // For custom col
                     echo $this->display_row_custom($v,$p_row[$v],$pk_id);
                 }
                 else {
                     echo td($p_row[$v],  $this->a_col_option[$v]);
                 }
             }
         }
         if ($this->icon_mod=="right")
             $this->display_icon_mod($p_row);
         if ($this->icon_del=="right")
             $this->display_icon_del($p_row);
  
  
  
         echo '</tr>';
     }

References $col_sort, $e, $i, $idx, $js, $value, can_update_row(), display_icon_del(), display_icon_mod(), display_row_custom(), get_col_type(), get_property_visible(), table, and td().

Referenced by ajax_save(), and display_table().

Here is the call graph for this function:

◆ display_row_custom()

Manage_Table_SQL::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>".

You can get the full array from display_row via get_current_row() or reload from db thanks $p_id

Parameters

	$p_key	string key name
	$p_value	string value
int	$p_id	id of the row , usually the pk of Data_SQL (optional default 0)

See also: input_custom; set_type

Note: must return a string which will be in surrounded by td in the function display_row

Returns: string

Reimplemented in Mobile_Device_MTable, Acc_Report_MTable, and Card_Attribut_MTable.

Definition at line 1101 of file manage_table_sql.class.php.

                                                          {
         return td($p_value);
     }

References td().

Referenced by display_row().

Here is the call graph for this function:

◆ display_table()

Manage_Table_SQL::display_table	(	$p_order = `""`,
		$p_array = `NULL`
	)

display the data of the table

Parameters

$p_order	is the cond or order of the rows, if empty the primary key will be used
$p_array	array of the bind variables

Note: the function create_js_script MUST be called before this function

Reimplemented in Forecast_Item_MTable, and Acc_Report_MTable.

Definition at line 798 of file manage_table_sql.class.php.

     {
        $ret=$this->execute_query($p_order,$p_array);
         $nb=Database::num_row($ret);
         if ($this->can_append_row()==TRUE && $this->button_add_top == true)
         {
             echo HtmlInput::button_action(" "._("Ajout"),
                     sprintf("%s.input('-1','%s')", 
                             $this->object_name,
                             $this->object_name), "xx", "smallbutton", BUTTONADD);
         }
         $nb_order=count($this->a_order);
         $virg=""; $result="";
         // filter only on visible column
         $visible=0;
         for ($e=0; $e<$nb_order; $e++)
         {
             if ($this->get_property_visible($this->a_order[$e])==TRUE)
             {
                 $result.=$virg."$visible";
                 $virg=",";
                 $visible++;
             }
         }
         if ( $this->get_search_table() )
         {
             echo _('Cherche')." ".HtmlInput::filter_table("tb".$this->object_name, $result, 1);
         }
         
         // Set a sort on a column if sort_column is not empty
         if ( $this->sort_column =="")
         {
             printf('<table class="result" id="tb%s">', $this->object_name); 
         } else {
            printf('<table class="result sortable" id="tb%s">', $this->object_name);
         }
         $this->display_table_header();
         echo '<tbody>';
         for ($i=0; $i<$nb; $i++)
         {
             $row=Database::fetch_array($ret, $i);
             $this->display_row($row);
         }
         echo '</tbody>';
         echo "</table>";
         if ($this->can_append_row()==TRUE)
         {
             echo HtmlInput::button_action(" "._("Ajout"),
                     sprintf("%s.input('-1','%s')", 
                             $this->object_name,
                             $this->object_name), "xx", "smallbutton", BUTTONADD);
         }
         printf('<script> alternate_row_color("tb%s");</script>',
                 $this->object_name);
     }

References $e, $i, $nb, $p_array, $p_order, $result, $ret, $row, HtmlInput\button_action(), BUTTONADD, can_append_row(), display_row(), display_table_header(), execute_query(), DatabaseCore\fetch_array(), HtmlInput\filter_table(), get_property_visible(), get_search_table(), and DatabaseCore\num_row().

Here is the call graph for this function:

◆ display_table_header()

Manage_Table_SQL::display_table_header ( )

display the column header excepted the not visible one and in the order defined with $this->a_order

Definition at line 858 of file manage_table_sql.class.php.

     {
         $nb=count($this->a_order);
         echo '<thead>';
         echo "<tr>";
  
         if ($this->can_update_row() && $this->icon_mod=="left")
         {
             echo th("  ", 'style="width:40px"  class="sorttable_nosort"');
         }
         if ($this->can_delete_row() && $this->icon_del=="left")
         {
             echo th(" ", 'style="width:40px"  class="sorttable_nosort"');
         }
         for ($i=0; $i<$nb; $i++)
         {
  
             $key=$this->a_order[$i];
             $sorted="";
             if ( $key == $this->sort_column) {
                 $sorted=' class="sorttable_sorted"';
             }
  
             $style=$this->a_header_option[$key];
             if ($this->get_property_visible($key)==true  ) {
                 echo th("", $sorted.$style, $this->a_label_displaid[$key]);
             }
         }
         if ($this->can_update_row() && $this->icon_mod=="right")
         {
             echo th("  ", 'style="width:40px"  class="sorttable_nosort"');
         }
         if ($this->can_delete_row() && $this->icon_del=="right")
         {
             echo th(" ", 'style="width:40px"  class="sorttable_nosort" ');
         }
         echo "</tr>";
         echo '</thead>';
     }

References $i, $nb, $style, can_delete_row(), can_update_row(), get_property_visible(), and th().

Referenced by display_table().

Here is the call graph for this function:

◆ execute_query()

Manage_Table_SQL::execute_query	(	$p_order = `""`,
		$p_array = `NULL`
	)

execute the query (Data_SQL.seek), called by display_table

Parameters

string	(default empty) $p_order SQL string added to DatabaseCore::seek
array	(default null) $p_array Array for the SQL string

See also: Data_SQL.seek

Returns: pgsql resource

Definition at line 782 of file manage_table_sql.class.php.

     {
          if ($p_order=="")
         {
             $p_order="order by {$this->table->primary_key}";
         }
         $ret=$this->table->seek($p_order, $p_array);
         return $ret;
     }

References $p_array, $p_order, $ret, and table.

Referenced by display_table().

◆ from_request()

Manage_Table_SQL::from_request ( )

get the data from http request strip the not update or not visible data to their initial value.

Before saving , it is important to set the pk and load from db

See also: set_pk

Reimplemented in Currency_MTable, Forecast_Item_MTable, Operation_Predef_MTable, and Action_Document_Type_MTable.

Definition at line 926 of file manage_table_sql.class.php.

     {
         $nb=count($this->a_order);
         $http=new HttpInput();
         for ($i=0; $i<$nb; $i++)
         {
             
             $key=$this->a_order[$i];
             if ($this->get_property_visible($key)==TRUE&&$this->get_property_updatable($key)
                     ==TRUE)
             {
                 $v=$http->request($this->a_order[$i],"string","");
                 $this->table->$key=strip_tags($v);
             }
         }
     }

References $http, $i, $nb, get_property_updatable(), get_property_visible(), and table.

Referenced by ajax_save().

Here is the call graph for this function:

◆ get_button_add_top()

Manage_Table_SQL::get_button_add_top ( )

Definition at line 765 of file manage_table_sql.class.php.

     {
         return $this->button_add_top;
     }

References $button_add_top.

◆ get_col_option()

Manage_Table_SQL::get_col_option ( $p_key )

add extra to column, normally class , javascript or style

Parameters

string $p_key column name

See also: set_col_option

Definition at line 360 of file manage_table_sql.class.php.

     {
         if (!isset($this->a_type[$p_key]))
             throw new Exception("invalid key $p_key");
  
         return $this->a_col_option[$p_col];
     }

◆ get_col_sort()

Manage_Table_SQL::get_col_sort ( )

When adding an element , it is column we checked to insert before,.

Returns: none

Definition at line 231 of file manage_table_sql.class.php.

                             {
         return $this->col_sort;
     }

References $col_sort.

◆ get_col_type()

Manage_Table_SQL::get_col_type ( $p_key )

return the type of a column

Parameters

$p_key col name

See also: set_col_type

Definition at line 447 of file manage_table_sql.class.php.

     {
         if (!isset($this->a_type[$p_key]))
             throw new Exception("invalid key");
  
         return $this->a_type[$p_key];
     }

Referenced by display_row().

◆ get_current_pos()

Manage_Table_SQL::get_current_pos ( $p_key )

get the position of a column

Parameters

$p_key data column

Definition at line 705 of file manage_table_sql.class.php.

     {
         $nb_order=count($this->a_order);
         for ($i=0; $i<$nb_order; $i++)
                 if ($this->a_order[$i]==$p_key)
                 return $i;
         throw new Exception("COL INVAL ".$p_key);
     }

References $i.

Referenced by move().

◆ get_current_row()

Manage_Table_SQL::get_current_row ( )

Return the current row printed in display_row.

Returns: array

Definition at line 1073 of file manage_table_sql.class.php.

     {
         return $this->current_row;
     }

References $current_row.

◆ get_dialog_box()

Manage_Table_SQL::get_dialog_box ( )

Returns: mixed

Definition at line 212 of file manage_table_sql.class.php.

     {
         return $this->dialog_box;
         return $this;
     }

References $dialog_box.

◆ get_dialogbox_style()

Manage_Table_SQL::get_dialogbox_style ( )

return the db_style

Returns: array

Definition at line 193 of file manage_table_sql.class.php.

     {
         return $this->dialogbox_style;
     }

References $dialogbox_style.

◆ get_error()

Manage_Table_SQL::get_error ( $p_col )

retrieve the error message

Parameters

$p_col column name

Returns: string with message or empty if no error

See also: input

Definition at line 306 of file manage_table_sql.class.php.

     {
         if (isset($this->aerror[$p_col]))
             return $this->aerror[$p_col];
         return "";
     }

Referenced by display_error(), Tva_Rate_MTable\input(), Template_Card_Category\input(), input(), and show_error().

◆ get_header_option()

Manage_Table_SQL::get_header_option ( $p_key )

add extra to column Header, normally class , javascript or style

Parameters

string $p_key column name

See also: set_col_option

Definition at line 393 of file manage_table_sql.class.php.

     {
         if (!isset($this->a_type[$p_key]))
             throw new Exception("invalid key $p_key");
  
         return $this->a_header_option[$p_col];
     }

◆ get_icon_del()

Manage_Table_SQL::get_icon_del ( )

Definition at line 260 of file manage_table_sql.class.php.

     {
         return $this->icon_del;
     }

References $icon_del.

◆ get_icon_mod()

Manage_Table_SQL::get_icon_mod ( )

Definition at line 256 of file manage_table_sql.class.php.

     {
         return $this->icon_mod;
     }

References $icon_mod.

◆ get_js_variable()

Manage_Table_SQL::get_js_variable ( )

Get the object name.

: return the object name , it is useful it the javascript will return coded without the create_js_script function

See also: create_js_script

Definition at line 461 of file manage_table_sql.class.php.

     {
         return $this->object_name;
     }

References $object_name.

◆ get_json()

Manage_Table_SQL::get_json ( )

Definition at line 473 of file manage_table_sql.class.php.

     {
         return $this->json_parameter;
     }

References $json_parameter.

◆ get_object_name()

Manage_Table_SQL::get_object_name ( )

Definition at line 477 of file manage_table_sql.class.php.

                                {
         return $this->object_name;
     }

References $object_name.

Referenced by Operation_Predef_MTable\display_button_add(), and Template_Card_Category\input().

◆ get_order()

Manage_Table_SQL::get_order ( )

Definition at line 273 of file manage_table_sql.class.php.

     {
         return $this->a_order;
     }

References $a_order.

◆ get_property_updatable()

Manage_Table_SQL::get_property_updatable ( $p_key )

return True if the column is updatable otherwise false

Parameters

$p_key data column

Examples: test_manage_table_sql.php.

Definition at line 650 of file manage_table_sql.class.php.

     {
         $val=$this->a_prop[$p_key]&self::UPDATABLE;
         if ($val==self::UPDATABLE)
             return true;
         return false;
     }

References $val, and UPDATABLE.

Referenced by from_request(), Tva_Rate_MTable\input(), input(), and set_property_updatable().

◆ get_property_visible()

Manage_Table_SQL::get_property_visible ( $p_key )

return True if the column is visible otherwise false

Parameters

$p_key data column

Examples: test_manage_table_sql.php.

Definition at line 682 of file manage_table_sql.class.php.

     {
         $val=$this->a_prop[$p_key]&self::VISIBLE;
         if ($val===self::VISIBLE)
             return true;
         return false;
     }

References $val, and VISIBLE.

Referenced by display_row(), display_table(), display_table_header(), from_request(), Tva_Rate_MTable\input(), input(), and set_property_visible().

◆ get_search_table()

Manage_Table_SQL::get_search_table ( )

Get if we can search in the table.

Returns: boolean

Definition at line 165 of file manage_table_sql.class.php.

     {
         return $this->search_table;
     }

References $search_table.

Referenced by display_table().

◆ get_sort_column()

Manage_Table_SQL::get_sort_column ( )

return the column to sort

Definition at line 907 of file manage_table_sql.class.php.

     {
         return $this->sort_column;
     }

References $sort_column.

◆ get_table()

Manage_Table_SQL::get_table ( )

Definition at line 264 of file manage_table_sql.class.php.

     {
         return $this->table;
     }

References $table.

Referenced by Template_Card_Category\add_mandatory_attr(), Parameter_Extra_MTable\check(), Payment_Method_MTable\check(), Anc_Account_Table\check(), Forecast_Category_MTable\check(), Action_Document_Type_MTable\check(), Acc_Report_MTable\check(), Currency_MTable\check(), Mobile_Device_MTable\check(), Card_Attribut_MTable\check(), Forecast_Item_MTable\check(), Forecast_Item_MTable\count_category(), Action_Document_Type_MTable\delete(), Card_Attribut_MTable\delete(), Currency_MTable\delete(), Forecast_Item_MTable\display_row(), Forecast_Item_MTable\display_table(), Operation_Predef_MTable\from_request(), Forecast_Item_MTable\from_request(), Currency_MTable\input(), Forecast_Category_MTable\input(), Operation_Predef_MTable\input(), Template_Card_Category\input(), Forecast_Item_MTable\input(), Action_Document_Type_MTable\input(), Mobile_Device_MTable\input_custom(), Card_Attribut_MTable\input_custom(), Payment_Method_MTable\input_custom(), Tag_Group_MTable\input_tag(), Currency_MTable\save(), Action_Document_Type_MTable\save(), Forecast_Category_MTable\set_forecast_id(), and Mobile_Device_MTable\set_profile_id().

◆ getCssClass()

Manage_Table_SQL::getCssClass ( )

Definition at line 146 of file manage_table_sql.class.php.

                                {
                 return $this->cssclass;
         }

References $cssclass.

◆ getTitle()

Manage_Table_SQL::getTitle ( )

Definition at line 157 of file manage_table_sql.class.php.

     {
         return $this->title;
     }

References $title.

Referenced by ajax_input().

◆ input()

Manage_Table_SQL::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 or add elements with "set_order" before calling this function. This function does not add the form , only the table.

It returns true , if it is not readyonly and the form will have a "save" button, if it returns nothing or false then there is no save button, nor form, the content is then readonly

See also: get_error , set_error

Reimplemented in Acc_Plan_MTable, Action_Document_Type_MTable, Forecast_Item_MTable, Template_Card_Category, Operation_Predef_MTable, Currency_MTable, Forecast_Category_MTable, Tva_Rate_MTable, and Tag_Group_MTable.

Definition at line 1117 of file manage_table_sql.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)
             {
                 // Label
                 $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 ($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 ($this->a_type[$key]=="numeric") // number 2 decimale
                     {
                         $text=new INum($key);
                         $text->value=$value;
                         $min_size=(strlen($value)<10)?10:strlen($value)+1;
                         $text->size=$min_size;
                         echo $text->input();
                     }
                     elseif ($this->a_type[$key]=="numeric4") // number 4 decimale
                     {
                         $text=new INum($key);
                         $text->prec=4;
                         $text->value=$value;
                         $min_size=(strlen($value)<10)?10:strlen($value)+1;
                         $text->size=$min_size;
                         echo $text->input();
                     }
                     elseif ($this->a_type[$key]=="numeric6") // number 6 decimale
                     {
                         $text=new INum($key);
                         $text->prec=6;
                         $text->value=$value;
                         $min_size=(strlen($value)<10)?10:strlen($value)+1;
                         $text->size=$min_size;
                         echo $text->input();
                     }
                     elseif ($this->a_type[$key]=="date")
                     {
                         $text=new IDate($key);
                         $text->value=$value;
                         $min_size=10;
                         $text->size=$min_size;
                         echo $text->input();
                     } elseif ($this->a_type[$key]=="custom")
                     {
                         $this->input_custom($key,$value);
                     }
                     echo "</td>";
                 }
                 else
                 {
                     printf('<td>%s %s</td>', h($value),
                             HtmlInput::hidden($key, $value)
                     );
                 }
             }
             echo "</tr>";
         }
         echo "</table>";
         return true;
     }

References $error, $i, $label, $select, $text, $value, HtmlInput\errorbulle(), get_error(), get_property_updatable(), get_property_visible(), h, HtmlInput\hidden(), Icon_Action\infobulle(), input_custom(), and table.

Referenced by ajax_input().

Here is the call graph for this function:

◆ input_custom()

Manage_Table_SQL::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

function input_custom($p_key,$p_value) {
  switch ($p_key) {
     case 'name':
         $w=new ICard($p_key,$p_value);
         $w->input();
         break;
  }
}

Parameters

string	$p_key	name of the column
string	$p_value	current value

Returns: nothing

Reimplemented in Acc_Plan_MTable, Payment_Method_MTable, Card_Attribut_MTable, Mobile_Device_MTable, and Acc_Report_MTable.

Definition at line 1225 of file manage_table_sql.class.php.

                                            {
      throw new Exception(__FILE__.":".__LINE__."-"._("non implémenté"));
     }

Referenced by input().

◆ insert()

Manage_Table_SQL::insert ( )

insert a new value

See also: set_pk_value; from_request

Definition at line 1456 of file manage_table_sql.class.php.

     {
         $this->table->insert();
     }

References table.

◆ move()

Manage_Table_SQL::move	(	$p_key,
		$p_idx
	)

if we change a column order , the order of the other columns is impacted.

With a_order[0,1,2,3]=[x,y,z,a] if we move the column x (idx=0) to 2
we must obtain [y,z,x,a]

Parameters

string	$p_key	data column
integer	$p_idx	new location

Definition at line 724 of file manage_table_sql.class.php.

     {
         // get current position of p_key
         $cur_pos=$this->get_current_pos($p_key);
  
         if ($cur_pos==$p_idx)
             return;
  
         if ($cur_pos<$p_idx)
         {
             $nb_order=count($this->a_order);
             for ($i=0; $i<$nb_order; $i++)
             {
                 // if col_name is not the searched one we continue              
                 if ($this->a_order[$i]!=$p_key)
                     continue;
                 if ($p_idx==$i)
                     continue;
                 // otherwise we swap with i+1
                 $old=$this->a_order[$i+1];
                 $this->a_order[$i]=$this->a_order[$i+1];
                 $this->a_order[$i+1]=$p_key;
             }
         } else
         {
  
             $nb_order=count($this->a_order)-1;
             for ($i=$nb_order; $i>0; $i--)
             {
                 // if col_name is not the searched one we continue              
                 if ($this->a_order[$i]!=$p_key)
                     continue;
                 if ($p_idx==$i)
                     continue;
                 // otherwise we swap with i+1
                 $old=$this->a_order[$i-1];
                 $this->a_order[$i]=$this->a_order[$i-1];
                 $this->a_order[$i-1]=$p_key;
             }
         }
     }

References $i, $old, and get_current_pos().

Here is the call graph for this function:

◆ param_set()

Manage_Table_SQL::param_set ( $p_json )

Set the parameter of the object (gDossier, ac, plugin_code...) @detail By default , only gDossier will be set .

The default value is given in the constructor

Parameters

string with json format $p_json

Deprecated:: since version 692

See also: set_json

Definition at line 488 of file manage_table_sql.class.php.

     {
         $this->set_json($p_json);
     }

References set_json().

Here is the call graph for this function:

◆ save()

Manage_Table_SQL::save ( )

save the Data_SQL Object The noalyss_SQL is not empty

See also: from_request

Reimplemented in Action_Document_Type_MTable, Currency_MTable, Tva_Rate_MTable, and Operation_Predef_MTable.

Definition at line 1439 of file manage_table_sql.class.php.

     {
         if ($this->table->exist()==0)
         {
             $this->table->insert();
         }
         else
         {
             $this->table->update();
         }
     }

References table.

Referenced by ajax_save().

◆ send_header()

Manage_Table_SQL::send_header ( )

send the XML headers for the ajax call

Definition at line 184 of file manage_table_sql.class.php.

     {
         header('Content-type:text/xml;charset="UTF-8"');
     }

◆ set_append_row()

Manage_Table_SQL::set_append_row ( $p_value )

Enable or disable the appending of rows.

Parameters

$p_value Boolean : true enable the row to be appended

Definition at line 620 of file manage_table_sql.class.php.

     {
         if ($p_value!==True&&$p_value!==False)
             throw new Exception("Valeur invalide set_append_row [$p_value]");
         $this->row_append=$p_value;
     }

Referenced by Mobile_Device_MTable\__construct(), and Operation_Predef_MTable\__construct().

◆ set_button_add_top()

Manage_Table_SQL::set_button_add_top ( $button_add_top )

Definition at line 770 of file manage_table_sql.class.php.

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

References $button_add_top.

◆ set_callback()

Manage_Table_SQL::set_callback ( $p_file )

set the callback function that is passed to javascript

Parameters

$p_file : callback file by default ajax.php

Definition at line 507 of file manage_table_sql.class.php.

     {
         $this->callback=$p_file;
     }

Referenced by Mobile_Device_MTable\__construct(), and Operation_Predef_MTable\__construct().

◆ set_col_label()

Manage_Table_SQL::set_col_label	(	$p_key,
		$p_display
	)

set the name to display for a column

Parameters

string	$p_key	data column
string	$p_display	Label to display

Definition at line 696 of file manage_table_sql.class.php.

     {
         $this->a_label_displaid[$p_key]=$p_display;
     }

Referenced by Card_Attribut_MTable\__construct(), Mobile_Device_MTable\__construct(), Contact_Option_Ref_MTable\__construct(), Template_Card_Category\__construct(), Payment_Method_MTable\__construct(), Anc_Account_Table\__construct(), Action_Document_Type_MTable\__construct(), Tag_Group_MTable\__construct(), Operation_Predef_MTable\__construct(), Tva_Rate_MTable\__construct(), and Currency_MTable\__construct().

◆ set_col_option()

Manage_Table_SQL::set_col_option	(	$p_key,
		$p_value
	)

add extra to column, normally class or style

Parameters

string	$p_key	column name
string	$p_value	extra info for this column (CSS, js, ...)

 $manage_table->set_col_option("pcm_lib",'style="color:red;text-align:center"');
 
$manage_table->set_col_option("pcm_val", "onclick=\"alert('toto')\" style=\"text-decoration:underline\" onmouseover=\"this.style.cursor='pointer'\"");

Definition at line 380 of file manage_table_sql.class.php.

     {
         
         if (!isset($this->a_type[$p_key]))
             throw new Exception("invalid key $p_key");
         $this->a_col_option[$p_key]=$p_value;
         return $this;
     }

◆ set_col_sort()

Manage_Table_SQL::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.

Parameters

numeric $pn_num

Note: you must be aware that the icon_mod or icon_del is in the first col, this column is skipped

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

                                   {
         $this->col_sort=$p_num;
     }

Referenced by Card_Attribut_MTable\__construct(), Mobile_Device_MTable\__construct(), Anc_Account_Table\__construct(), and Operation_Predef_MTable\__construct().

◆ set_col_tips()

Manage_Table_SQL::set_col_tips	(	$p_key,
		$p_comment
	)

Set the info for a column, use Icon_Action::infobulle the message are in message_javascript.php.

Parameters

string	$p_key	Column name
integer	$p_comment	comment idx

See also: message_javascript.php; Icon_Action::infobulle()

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

                                              {
         $this->a_info[$p_key]=$p_comment;
     }

Referenced by Card_Attribut_MTable\__construct(), Mobile_Device_MTable\__construct(), and Payment_Method_MTable\__construct().

◆ set_col_type()

Manage_Table_SQL::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

Parameters

$p_key	col name
$p_type	is "text", "numeric", "date", "select", "timestamp","custom"
$p_array	if type is SELECT an array is expected

Note: if $p_type is custom then a function named input_custom($p_key,$p_value) must be implemented in the class

See also: Manage_Table_SQL:input_custom

Definition at line 425 of file manage_table_sql.class.php.

     {
         if (!isset($this->a_type[$p_key]))
             throw new Exception("invalid key $p_key");
  
         if (!in_array($p_value,
                         array("text", "numeric", "date", "select", "timestamp","custom")))
             throw new Exception("invalid type $p_value");
  
         $this->a_type[$p_key]=$p_value;
         $this->a_select[$p_key]=$p_array;
         if ( $p_value == "numeric" && $this->a_col_option[$p_key]=="") {
             $this->a_col_option[$p_key]=' class="num" ';
         }
          
     }

References $p_array.

Referenced by Card_Attribut_MTable\__construct(), Mobile_Device_MTable\__construct(), Contact_Option_Ref_MTable\__construct(), Anc_Account_Table\__construct(), Payment_Method_MTable\__construct(), Operation_Predef_MTable\__construct(), Tva_Rate_MTable\__construct(), and Currency_MTable\__construct().

◆ set_current_row()

Manage_Table_SQL::set_current_row ( $current_row )

set the current row printed in display_row

Parameters

type $current_row

Returns: this;

Definition at line 1082 of file manage_table_sql.class.php.

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

References $current_row.

◆ set_delete_row()

Manage_Table_SQL::set_delete_row ( $p_value )

Enable or disable the deletion of rows.

Parameters

$p_value Boolean : true enable the row to be deleted

Definition at line 609 of file manage_table_sql.class.php.

     {
         if ($p_value!==True&&$p_value!==False)
             throw new Exception("Valeur invalide set_delete_row [$p_value]");
         $this->row_delete=$p_value;
     }

Referenced by Mobile_Device_MTable\__construct(), Currency_MTable\__construct(), Card_Attribut_MTable\display_row(), and Currency_MTable\display_row().

◆ set_dialog_box()

Manage_Table_SQL::set_dialog_box ( $dialog_box )

Parameters

mixed $dialog_box

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

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

References $dialog_box.

Referenced by Operation_Predef_MTable\__construct().

◆ set_dialogbox_style()

Manage_Table_SQL::set_dialogbox_style ( $db_style )

Dialog box style , by default {position: "fixed", top: '15', width: "auto", "margin-left": "20%"}.

Parameters

array $db_style,will be transformed into a json object

Definition at line 203 of file manage_table_sql.class.php.

     {
         $this->dialogbox_style = $db_style;
         return $this;
     }

◆ set_error()

Manage_Table_SQL::set_error	(	$p_col,
		$p_message
	)

set the error message for a wrong input

Parameters

$p_col	the column name
$p_message	the error message

See also: check

Definition at line 289 of file manage_table_sql.class.php.

     {
         $this->aerror[$p_col]=$p_message;
     }

Referenced by Parameter_Extra_MTable\check(), Payment_Method_MTable\check(), Template_Card_Category\check(), Anc_Account_Table\check(), Forecast_Category_MTable\check(), Action_Document_Type_MTable\check(), Acc_Report_MTable\check(), Currency_MTable\check(), Mobile_Device_MTable\check(), Card_Attribut_MTable\check(), Acc_Plan_MTable\check(), Forecast_Item_MTable\check(), and Tva_Rate_MTable\check().

◆ set_header_option()

Manage_Table_SQL::set_header_option	(	$p_key,
		$p_value
	)

add extra to column Header, normally class or style

Parameters

string	$p_key	column name
string	$p_value	extra info for this column (CSS, js, ...)

See also: set_col_option

Definition at line 406 of file manage_table_sql.class.php.

     {
         if (!isset($this->a_type[$p_key]))
             throw new Exception("invalid key $p_key");
         $this->a_header_option[$p_key]=$p_value;
         return $this;
     }

Referenced by Mobile_Device_MTable\__construct().

◆ set_icon_del()

Manage_Table_SQL::set_icon_del ( $pString )

Set the icon to delete at the right or left of the row.

Parameters

type $pString

Exceptions

Exception

Definition at line 591 of file manage_table_sql.class.php.

                                     {
         if ($pString != "right" && $pString != "left" ) 
             throw new Exception('set_icon_del invalide '.$pString);
         $this->icon_del=$pString;
     }

◆ set_icon_mod()

Manage_Table_SQL::set_icon_mod ( $pString )

Set the icon to modify at the right ,the first col or left of the row.

Parameters

type $pString

Exceptions

Exception

Definition at line 581 of file manage_table_sql.class.php.

                                     {
         if ($pString != "right" && $pString != "left" && $pString!="first") 
             throw new Exception('set_icon_mod invalide '.$pString);
         $this->icon_mod=$pString;
     }

Referenced by Currency_MTable\__construct().

◆ set_json()

Manage_Table_SQL::set_json ( $p_json )

Set the parameter of the object (gDossier, ac, plugin_code...) @detail By default , only gDossier will be set .

The default value is given in the constructor

Parameters

string with json format $p_json

Definition at line 498 of file manage_table_sql.class.php.

     {
         $this->json_parameter=$p_json;
         
     }

Referenced by param_set().

◆ set_object_name()

Manage_Table_SQL::set_object_name ( $p_object_name )

Set the object_name.

Parameters

string $p_object_name name of the JS var, used in ajax response,id of the part of the id DOMElement to modify

Definition at line 543 of file manage_table_sql.class.php.

     {
         $this->object_name=$p_object_name;
     }

Referenced by Mobile_Device_MTable\__construct(), and Anc_Account_Table\__construct().

◆ set_order()

Manage_Table_SQL::set_order ( $p_order )

Definition at line 277 of file manage_table_sql.class.php.

     {
         if (! is_array($p_order) )            
                 throw new Exception("set_order, parameter is not an array");
         $this->a_order=$p_order;
     }

References $p_order.

Referenced by Mobile_Device_MTable\__construct(), Payment_Method_MTable\__construct(), Action_Document_Type_MTable\__construct(), and Operation_Predef_MTable\__construct().

◆ set_pk()

Manage_Table_SQL::set_pk ( $p_id )

set the id value of a data row and load from the db

Definition at line 915 of file manage_table_sql.class.php.

     {
         $this->table->set_pk_value($p_id);
         $this->table->load();
     }

References $p_id, and table.

Referenced by Operation_Predef_MTable\save().

◆ set_property_updatable()

Manage_Table_SQL::set_property_updatable	(	$p_key,
		$p_value
	)

set a column of the data row updatable or not

Parameters

string	$p_key	data column
bool	$p_value	Boolean False or True

Examples: test_manage_table_sql.php.

Definition at line 553 of file manage_table_sql.class.php.

     {
         if (! isset($this->a_prop[$p_key]))
             throw new Exception(__FILE__.":".__LINE__."$p_key invalid index");
         // if already done returns 
         if ( $this->get_property_updatable($p_key) == $p_value)return;
         if ($p_value==False)
             $this->a_prop[$p_key]=$this->a_prop[$p_key]-self::UPDATABLE;
         elseif ($p_value==True)
             $this->a_prop[$p_key]=$this->a_prop[$p_key]|self::UPDATABLE;
         else
             throw new Exception("set_property_updatable [ $p_value ] incorrect");
     }

References get_property_updatable(), and UPDATABLE.

Referenced by Card_Attribut_MTable\__construct(), Template_Card_Category\__construct(), Anc_Account_Table\__construct(), Action_Document_Type_MTable\__construct(), Operation_Predef_MTable\__construct(), Tag_Group_MTable\__construct(), and Tva_Rate_MTable\__construct().

Here is the call graph for this function:

◆ set_property_visible()

Manage_Table_SQL::set_property_visible	(	$p_key,
		$p_value
	)

set a column of the data row visible or not

Parameters

string	$p_key	data column
bool	$p_value	Boolean False or True

Examples: test_manage_table_sql.php.

Definition at line 663 of file manage_table_sql.class.php.

     {
         if (!isset ($this->a_prop[$p_key]) )
             throw new Exception(__FILE__.":".__LINE__."$p_key invalid index");
         // if already done return
         if ( $this->get_property_visible($p_key) == $p_value)return;
         
         if ($p_value==False)
             $this->a_prop[$p_key]=$this->a_prop[$p_key]-self::VISIBLE;
         elseif ($p_value==True)
             $this->a_prop[$p_key]=$this->a_prop[$p_key]|self::VISIBLE;
         else
             throw new Exception("set_property_updatable [ $p_value ] incorrect");
     }

References get_property_visible(), and VISIBLE.

Referenced by Card_Attribut_MTable\__construct(), Mobile_Device_MTable\__construct(), Contact_Option_Ref_MTable\__construct(), Payment_Method_MTable\__construct(), Anc_Account_Table\__construct(), Action_Document_Type_MTable\__construct(), Operation_Predef_MTable\__construct(), Tag_Group_MTable\__construct(), and Currency_MTable\__construct().

Here is the call graph for this function:

◆ set_search_table()

Manage_Table_SQL::set_search_table ( $search_table )

Set the table searchable or not.

Parameters

boolean : true we can search

Returns: $this

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

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

References $search_table.

◆ set_sort_column()

Manage_Table_SQL::set_sort_column ( $p_col )

set the column to sort by default

Definition at line 900 of file manage_table_sql.class.php.

     {
         $this->sort_column=$p_col;
     }

Referenced by Mobile_Device_MTable\__construct(), Operation_Predef_MTable\__construct(), and Currency_MTable\__construct().

◆ set_table()

Manage_Table_SQL::set_table ( Data_SQL $p_noalyss_sql )

Definition at line 269 of file manage_table_sql.class.php.

     {
         $this->table=$p_noalyss_sql;
     }

References table.

◆ set_update_row()

Manage_Table_SQL::set_update_row ( $p_value )

Enable or disable the updating of rows.

Parameters

$p_value Boolean : true enable the row to be updated

Definition at line 631 of file manage_table_sql.class.php.

     {
         if ($p_value!==True&&$p_value!==False)
             throw new Exception("Valeur invalide set_update_row [$p_value]");
         $this->row_update=$p_value;
     }

Referenced by Card_Attribut_MTable\display_row(), and Currency_MTable\display_row().

◆ set_value()

Manage_Table_SQL::set_value	(	$p_key,
		$p_value
	)

See also: set_pk_value; from_request

Definition at line 1476 of file manage_table_sql.class.php.

     {
         $this->table->set($p_key, $p_value);
     }

References table.

◆ setCssClass()

Manage_Table_SQL::setCssClass ( $p_class )

Definition at line 143 of file manage_table_sql.class.php.

                                    {
                 $this->cssclass=$p_class;
         }

◆ setTitle()

Manage_Table_SQL::setTitle ( $p_title )

Set the title of the diabox , default is Donnée.

Parameters

type $p_title

Definition at line 153 of file manage_table_sql.class.php.

     {
         $this->title=$p_title;
     }

References title.

◆ show_error()

Manage_Table_SQL::show_error ( $p_col )

Definition at line 532 of file manage_table_sql.class.php.

     {
         $error=$this->get_error($p_col);
         if ($error == "") { return "";}
         return HtmlInput::errorbulle($error);
     }

References $error, HtmlInput\errorbulle(), and get_error().

Here is the call graph for this function:

◆ update()

Manage_Table_SQL::update ( )

See also: set_pk_value; from_request

Definition at line 1466 of file manage_table_sql.class.php.

     {
         $this->table->update();
     }

References table.

Field Documentation

◆ $a_col_option

Manage_Table_SQL::$a_col_option

private

in display_row and display_custom_row, it is the current row which is used

Extra to add to the column : CSS Style , CSS class, javascript ,...

Definition at line 95 of file manage_table_sql.class.php.

◆ $a_header_option

Manage_Table_SQL::$a_header_option

private

Extra to add to the column Header : CSS Style , CSS class, javascript ,...

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

◆ $a_info

Manage_Table_SQL::$a_info

protected

Array with the infotip.

Definition at line 81 of file manage_table_sql.class.php.

◆ $a_label_displaid

Manage_Table_SQL::$a_label_displaid

protected

Label of the col. of the datarow.

Definition at line 69 of file manage_table_sql.class.php.

◆ $a_order

Manage_Table_SQL::$a_order

protected

order of the col

Definition at line 70 of file manage_table_sql.class.php.

Referenced by get_order().

◆ $a_prop

Manage_Table_SQL::$a_prop

protected

property for each col.

Definition at line 71 of file manage_table_sql.class.php.

◆ $a_select

Manage_Table_SQL::$a_select

protected

Possible value if a_type is a SELECT.

Definition at line 73 of file manage_table_sql.class.php.

◆ $a_type

Manage_Table_SQL::$a_type

protected

Type of the column : date , select ... Only in input.

Definition at line 72 of file manage_table_sql.class.php.

◆ $aerror

Manage_Table_SQL::$aerror

protected

Array containing the error of the input data.

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

◆ $button_add_top

Manage_Table_SQL::$button_add_top

private

place of the button add on the top, by default true

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

Referenced by get_button_add_top(), and set_button_add_top().

◆ $col_sort

Manage_Table_SQL::$col_sort

protected

when inserting, it is the column to sort,-1 to disable it and append only

Definition at line 80 of file manage_table_sql.class.php.

Referenced by display_row(), and get_col_sort().

◆ $cssclass

Manage_Table_SQL::$cssclass

private

< give the title of the diabox , default is Data

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

Referenced by getCssClass().

◆ $current_row

Manage_Table_SQL::$current_row

private

CSS class for the dialog box.

Definition at line 94 of file manage_table_sql.class.php.

Referenced by get_current_row(), and set_current_row().

◆ $dialog_box

Manage_Table_SQL::$dialog_box

protected

ID of the dialog box which display the result of the ajax calls.

Definition at line 83 of file manage_table_sql.class.php.

Referenced by get_dialog_box(), and set_dialog_box().

◆ $dialogbox_style

Manage_Table_SQL::$dialogbox_style

private

style of the dialog box

Definition at line 90 of file manage_table_sql.class.php.

Referenced by get_dialogbox_style().

◆ $icon_del

Manage_Table_SQL::$icon_del

private

place of right or left the icon update or mod, default right, accepted value=left,right

Definition at line 89 of file manage_table_sql.class.php.

Referenced by get_icon_del().

◆ $icon_mod

Manage_Table_SQL::$icon_mod

private

place of right or left the icon update or mod, default right, accepted value=left,right,first column for mod

Definition at line 88 of file manage_table_sql.class.php.

Referenced by get_icon_mod().

◆ $json_parameter

Manage_Table_SQL::$json_parameter

protected

Default parameter to add (gDossier...), sent to the ajax callback.

Definition at line 78 of file manage_table_sql.class.php.

Referenced by get_json().

◆ $object_name

Manage_Table_SQL::$object_name

protected

Object_name is used for the javascript , it is the row id to update or delete.

Definition at line 74 of file manage_table_sql.class.php.

Referenced by get_js_variable(), and get_object_name().

◆ $row_append

Manage_Table_SQL::$row_append

protected

Flag to indicate if rows can be added.

Definition at line 77 of file manage_table_sql.class.php.

Referenced by can_append_row().

◆ $row_delete

Manage_Table_SQL::$row_delete

protected

Flag to indicate if rows can be deleted.

Definition at line 75 of file manage_table_sql.class.php.

Referenced by can_delete_row().

◆ $row_update

Manage_Table_SQL::$row_update

protected

Flag to indicate if rows can be updated.

Definition at line 76 of file manage_table_sql.class.php.

Referenced by can_update_row().

◆ $search_table

Manage_Table_SQL::$search_table

protected

boolean , by default true ,it is possible to search in the table,

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

Referenced by get_search_table(), and set_search_table().

◆ $sort_column

Manage_Table_SQL::$sort_column

protected

javascript sort on this column , if empty there is no js sort

Definition at line 82 of file manage_table_sql.class.php.

Referenced by get_sort_column().

◆ $table

Manage_Table_SQL::$table

protected

Object Data_SQL.

Definition at line 68 of file manage_table_sql.class.php.

Referenced by Payment_Method_MTable\check(), Anc_Account_Table\check(), Action_Document_Type_MTable\check(), Currency_MTable\check(), Action_Document_Type_MTable\delete(), get_table(), and Action_Document_Type_MTable\input().

◆ $title

Manage_Table_SQL::$title

protected

Definition at line 92 of file manage_table_sql.class.php.

Referenced by getTitle().

◆ UPDATABLE

const Manage_Table_SQL::UPDATABLE =1

Definition at line 85 of file manage_table_sql.class.php.

Referenced by get_property_updatable(), and set_property_updatable().

◆ VISIBLE

const Manage_Table_SQL::VISIBLE =2

Definition at line 86 of file manage_table_sql.class.php.

Referenced by __construct(), get_property_visible(), and set_property_visible().

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

include/lib/manage_table_sql.class.php

Public Member Functions

Data Fields

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add_json_param()

◆ ajax_delete()

◆ ajax_input()

◆ ajax_save()

◆ can_append_row()

◆ can_delete_row()

◆ can_update_row()

◆ check()

◆ count_error()

◆ create_js_script()

◆ delete()

◆ display_error()

◆ display_icon_del()

◆ display_icon_mod()

◆ display_row()

◆ display_row_custom()

◆ display_table()

◆ display_table_header()

◆ execute_query()

◆ from_request()

◆ get_button_add_top()

◆ get_col_option()

◆ get_col_sort()

◆ get_col_type()

◆ get_current_pos()

◆ get_current_row()

◆ get_dialog_box()

◆ get_dialogbox_style()

◆ get_error()

◆ get_header_option()

◆ get_icon_del()

◆ get_icon_mod()

◆ get_js_variable()

◆ get_json()

◆ get_object_name()

◆ get_order()

◆ get_property_updatable()

◆ get_property_visible()

◆ get_search_table()

◆ get_sort_column()

◆ get_table()

◆ getCssClass()

◆ getTitle()

◆ input()

◆ input_custom()

◆ insert()

◆ move()

◆ param_set()

◆ save()

◆ send_header()

◆ set_append_row()

◆ set_button_add_top()

◆ set_callback()

◆ set_col_label()

◆ set_col_option()

◆ set_col_sort()

◆ set_col_tips()

◆ set_col_type()

◆ set_current_row()

◆ set_delete_row()

◆ set_dialog_box()

◆ set_dialogbox_style()

◆ set_error()

◆ set_header_option()

◆ set_icon_del()

◆ set_icon_mod()

◆ set_json()

◆ set_object_name()

◆ set_order()

◆ set_pk()

◆ set_property_updatable()

◆ set_property_visible()