manage the table attr_def More...

Inheritance diagram for Card_Attribut_MTable:

Collaboration diagram for Card_Attribut_MTable:

Public Member Functions
	__construct (\Data_SQL $p_table)

	check ()

	delete ()
	delete a datarow , the id must be have set before

	display_row ($row)
	Display row of table attr_def.

	display_row_custom ($p_key, $p_value, $p_id=0)
	For the type custom , we can call a function to display properly the value.

	input_custom ($p_key, $p_value)
	For the type custom , we can call a function to display properly the value.

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.

	ajax_delete ()
	Delete a record and return an XML answer for ajax.

	ajax_input ($p_status="OK")
	send an xml with input of the object, create an xml answer.

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

	can_append_row ()
	return false if the append of the row is forbidden

	can_delete_row ()
	return false if the delete of the row is forbidden

	can_update_row ()
	return false if the update of the row is forbidden

	count_error ()
	returns the nb of errors found

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

	display_error ()
	Display a list of the error collected.

	display_icon_custom ($p_row)
	usually contain a link and calls another page, it must be overriden

	display_icon_del ($p_row)

	display_icon_mod ($p_row)

	display_table ($p_order="", $p_array=NULL)
	display the data of the table

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

	execute_query ($p_order="", $p_array=NULL)
	execute the query (Data_SQL.seek), called by display_table

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

	get_button_add_top ()

	get_col_option ($p_key)
	add extra to column, normally class , javascript or style

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

	get_col_type ($p_key)
	return the type of a column

	get_current_pos ($p_key)
	get the position of a column

	get_current_row ()
	Return the current row printed in display_row.

	get_dialog_box ()

	get_dialogbox_style ()
	return the db_style

	get_error ($p_col)
	retrieve the error message

	get_header_option ($p_key)
	add extra to column Header, normally class , javascript or style

	get_icon_del ()

	get_icon_mod ()

	get_js_variable ()
	Get the object name.

	get_json ()

	get_object_name ()

	get_order ()

	get_property_updatable ($p_key)
	return True if the column is updatable otherwise false

	get_property_visible ($p_key)
	return True if the column is visible otherwise false

	get_search_table ()
	Get if we can search in the table.

	get_sort_column ()
	return the column to sort

	get_table ()

	getCssClass ()

	getTitle ()

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

	insert ()
	insert a new value

	move ($p_key, $p_idx)
	if we change a column order , the order of the other columns is impacted.

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

	save ()
	save the Data_SQL Object The noalyss_SQL is not empty

	send_header ()
	send the XML headers for the ajax call

	set_append_row ($p_value)
	Enable or disable the appending of rows.

	set_button_add_top ($button_add_top)

	set_callback ($p_file)
	set the callback function that is passed to javascript

	set_col_label ($p_key, $p_display)
	set the name to display for a column

	set_col_option ($p_key, $p_value)
	add extra to column, normally class or style

	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.

	set_col_tips ($p_key, $p_comment)
	Set the info for a column, use Icon_Action\infobulle the message are in message_javascript.php.

	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

	set_current_row ($current_row)
	set the current row printed in display_row

	set_delete_row ($p_value)
	Enable or disable the deletion of rows.

	set_dialog_box ($dialog_box)

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

	set_error ($p_col, $p_message)
	set the error message for a wrong input

	set_header_option ($p_key, $p_value)
	add extra to column Header, normally class or style

	set_icon_del ($pString)
	Set the icon to delete at the right or left of the row.

	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.

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

	set_object_name ($p_object_name)
	Set the object_name.

	set_order ($p_order)

	set_pk ($p_id)
	set the id value of a data row and load from the db

	set_property_updatable ($p_key, $p_value)
	set a column of the data row updatable or not

	set_property_visible ($p_key, $p_value)
	set a column of the data row visible or not

	set_search_table ($search_table)
	Set the table searchable or not.

	set_sort_column ($p_col)
	set the column to sort by default

	set_table (Data_SQL $p_noalyss_sql)

	set_update_row ($p_value)
	Enable or disable the updating of rows.

	set_value ($p_key, $p_value)

	setCssClass ($p_class)

	setTitle ($p_title)
	Set the title of the diabox , default is Donnée.

	show_error ($p_col)

	update ()

Data Fields
	$dossier_id

Data Fields inherited from Manage_Table_SQL
const	UPDATABLE =1

const	VISIBLE =2

Additional Inherited Members
Static Public Member Functions inherited from Manage_Table_SQL
static	ajax_error ($p_message)
	returns an XML object for error message as unauthorized access.

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

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

	$a_info
	Array with the infotip.

	$a_label_displaid
	Label of the col. of the datarow.

	$a_order
	order of the col

	$a_prop
	property for each col.

	$a_select
	Possible value if a_type is a SELECT.

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

	$aerror
	Array containing the error of the input data.

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

	$callback
	Callback function.

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

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

	$current_row
	CSS class for the dialog box.

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

	$dialogbox_style
	style of the dialog box

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

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

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

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

	$row_append
	Flag to indicate if rows can be added.

	$row_delete
	Flag to indicate if rows can be deleted.

	$row_update
	Flag to indicate if rows can be updated.

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

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

	$table
	Object Data_SQL.

	$title

Detailed Description

manage the table attr_def

See also: card_attr.inc.php

Definition at line 33 of file card_attribut_mtable.class.php.

Constructor & Destructor Documentation

◆ __construct()

Card_Attribut_MTable::__construct ( \Data_SQL $p_table )

Definition at line 36 of file card_attribut_mtable.class.php.

    {
        parent::__construct($p_table);
        $this->set_property_visible("ad_id", TRUE);
        $this->set_property_updatable("ad_id", FALSE);
        $this->set_col_label("ad_text", _("Nom"));
        $this->set_col_label("ad_type", _("Type"));
        $this->set_col_label("ad_size", _("Taille"));
        $this->set_col_label('ad_default_order', _("Ordre"));
        $this->set_col_label("ad_extra", _("Option sup."));
        $this->set_col_label("ad_search_followup", _("Recherche suivi"));
 
        $this->set_col_type("ad_search_followup", "custom");
        $this->set_col_type("ad_text", "custom");
        $this->set_col_type("ad_size", "numeric");
        $this->set_col_type("ad_extra", "custom");
        $this->set_col_type("ad_type", "select",
                array(
                    ["value"=>"text", "label"=>_("Texte")],
                    ["value"=>"date", "label"=>_("Date")],
                    ["value"=>"numeric", "label"=>_("Nombre")],
                    ["value"=>"select", "label"=>_("Choix")],
                    ["value"=>"card", "label"=>_("Fiche")],
                    ["value"=>"zone", "label"=>_("Zone de texte")],
                    ["value"=>"check", "label"=>_("Coche")],
                    ["value"=>"poste", "label"=>_("Poste comptable")]
        ));
        $this->set_col_tips("ad_search_followup", 77);
        // to prevent a call to this function for each row
        $this->dossier_id=Dossier::id();
        $this->set_order(['ad_id','ad_text',"ad_type","ad_default_order","ad_size","ad_extra","ad_search_followup"]);
        $this->set_col_sort(1);
         $this->setCssClass("inner_box2");
    }

References _, Manage_Table_SQL\set_col_label(), Manage_Table_SQL\set_col_sort(), Manage_Table_SQL\set_col_tips(), Manage_Table_SQL\set_col_type(), Manage_Table_SQL\set_order(), Manage_Table_SQL\set_property_updatable(), Manage_Table_SQL\set_property_visible(), and Manage_Table_SQL\setCssClass().

Here is the call graph for this function:

Member Function Documentation

◆ check()

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

Definition at line 164 of file card_attribut_mtable.class.php.

    {
        $object_sql=$this->get_table();
 
        if ($object_sql->get("ad_id")<9000&&$object_sql->get("ad_id")!=-1)
        {
            $this->set_error("ad_id", _("Bloqué"));
        }
 
        // Duplicate
        $count="select count(*) 
                from attr_def as ad1 
                where 
                upper(trim(ad1.ad_text)) = upper(trim($1))
                and ad1.ad_id != $2
                ";
        $count_duplicate=$object_sql->cn->get_value($count, [$object_sql->ad_text, $object_sql->ad_id]);
        if ($count_duplicate>0)
        {
            $this->set_error("ad_text", _("Doublon"));
        }
        // type
        if (in_array($object_sql->get("ad_type"),
                        array('date', 'text', 'numeric', 'zone', 'poste', 'card', 'select', 'check'))==false)
        {
            $this->set_error("ad_type", _("Type invalide"));
        }
 
        // Name empty
        if (trim($object_sql->ad_text)=="")
        {
            $this->set_error("ad_text", _("Description ne peut pas être vide"));
        }
        // select protect 
        if ($object_sql->ad_size=="")
        {
            $object_sql->ad_size=22;
        }
        if ($object_sql->ad_type=='numeric')
        {
            $object_sql->ad_extra=(trim($object_sql->ad_extra)=='')?'2':$object_sql->ad_extra;
            if (isNumber($object_sql->ad_extra)==0)
            {
                $this->set_error("ad_text", _("La précision doit être un chiffre"));
            }
        }
 
        if ($object_sql->ad_type=='select')
        {
            if (trim($object_sql->ad_extra)=="")
            {
 
                $this->set_error("ad_extra", _("La requête SQL est vide "));
            }
            $cn= $this->get_table()->cn;
            $cn->start();
            try {
                // remove SQL command like insert , delete , update, truncate , drop
                $sql=$object_sql->ad_extra;
                $sql=str_ireplace("delete", "del.ete", $sql);
                $sql=str_ireplace("insert", "del.ete", $sql);
                $sql=str_ireplace("update", "del.ete", $sql);
                $sql=str_ireplace("truncate", "del.ete", $sql);
                $sql=str_ireplace("drop", "del.ete", $sql);
                $cn->exec_sql($sql);
 
            } catch (\Exception $e) {
                $this->set_error("ad_extra", _("ERREUR SQL : ")
                        .$object_sql->ad_extra);
            } finally {
                $cn->rollback();
            }
 
 
            if (preg_match('/^\h*select/i', $object_sql->ad_extra)==0)
            {
 
            }
        }
        if ( $object_sql->ad_default_order < 11 || $object_sql->ad_default_order > 9998) {
            $this->set_error("ad_default_order",_("Valeur entre 11 et 9998"));
        }
        if ($this->count_error()>0)
        {
            return false;
        }
        return true;
    }

References $cn, $count, $e, $sql, _, Manage_Table_SQL\count_error(), Manage_Table_SQL\get_table(), isNumber(), and Manage_Table_SQL\set_error().

Here is the call graph for this function:

◆ delete()

Card_Attribut_MTable::delete ( )

delete a datarow , the id must be have set before

See also: from_request

Reimplemented from Manage_Table_SQL.

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

    {
        $object_sql=$this->get_table();
 
        if ($object_sql->getp("ad_id")<9000)
        {
            throw new Exception(_("Effacement bloqué"));
        }
 
        $db=$object_sql->cn;
        try
        {
            $db->start();
            $sql=$db->exec_sql("delete from fiche_detail  where ad_id=$1 ", array($object_sql->ad_id));
 
            $sql="delete from jnt_fic_attr where ad_id=$1";
            $res=$db->exec_sql($sql, array($object_sql->ad_id));
 
            $sql="delete from attr_def where ad_id=$1";
            $res=$db->exec_sql($sql, array($object_sql->ad_id));
 
            $object_sql=$this->get_table()->delete();
            $db->commit();
        }
        catch (Exception $ex)
        {
            $db->rollback();
            throw new Exception(_("Effacement bloqué : attribut utilisé"));
        }
    }

References $ex, $res, $sql, _, and Manage_Table_SQL\get_table().

Here is the call graph for this function:

◆ display_row()

Card_Attribut_MTable::display_row ( $row )

Display row of table attr_def.

Parameters

array $row

Reimplemented from Manage_Table_SQL.

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

    {
        tracedebug("card_attribute.log", $row);
        if ($row['ad_id']>=9000)
        {
            $this->set_delete_row(TRUE);
            $this->set_update_row(TRUE);
        }
        else
        {
            $this->set_delete_row(FALSE);
            $this->set_update_row(FALSE);
        }
 
        parent::display_row($row);
    }

References $row, Manage_Table_SQL\set_delete_row(), and Manage_Table_SQL\set_update_row().

Here is the call graph for this function:

◆ display_row_custom()

Card_Attribut_MTable::display_row_custom	(	$p_key,
		$p_value,
		$p_id = 0 )

For the type custom , we can call a function to display properly the value.

Parameters

$p_key	string key name
$p_value	string value

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

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

    {
        if ($p_key=="ad_search_followup")
        {
            $ic=new Inplace_Switch(uniqid("search_follow_up"), $p_value);
            $ic->set_callback("ajax_misc.php");
            $ic->add_json_param("op", "card");
            $ic->add_json_param("gDossier", $this->dossier_id);
            $ic->add_json_param("op2", "attribute");
            $ic->add_json_param("action", "enable_search");
            $ic->add_json_param("ad_id", $p_id);
            $ic->add_json_param("ctl", $p_id);
            $ret=$ic->input();
 
            return td($ret);
        }
        if ($p_key=="ad_text")
        {
            return td($p_value);
        }
        if ($p_key=="ad_extra")
        {
            return td($p_value);
        }
        return;
    }

References $p_id, $ret, and td().

Here is the call graph for this function:

◆ input_custom()

Card_Attribut_MTable::input_custom	(		$p_key,
			$p_value )

For the type custom , we can call a function to display properly the value.

Parameters

$p_key	string key name
$p_value	string value

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

Bug in firefox if id=ad_text , the widget is not displaid

Reimplemented from Manage_Table_SQL.

Definition at line 137 of file card_attribut_mtable.class.php.

    {
        if ($p_key=="ad_search_followup")
        {
            $p_id=$this->get_table()->get("ad_id");
            $ic=new InputSwitch("ad_search_followup", $p_value);
            echo $ic->input();
        }
        elseif ($p_key=="ad_text")
        {
            /**
             * Bug in firefox if id=ad_text , the widget is not displaid 
             */
            $text=new IText("ad_text", $p_value);
            $text->id=uniqid();
            echo $text->input();
        }
        elseif ($p_key=="ad_extra")
        {
            $text=new ITextarea("ad_extra", $p_value);
            $text->id=uniqid();
            echo $text->input();
        }
        echo "";
        return;
    }