manage simple report More...

Inheritance diagram for Acc_Report_MTable:

Collaboration diagram for Acc_Report_MTable:

Public Member Functions
	__construct (\Data_SQL $p_table)

	check ()

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

	get_form_definition_id ()

	input_custom ($p_key, $p_value)
	this function let you create your own input , for example for a ITEXT , a IRADIO , ... it must be override , there is not default More...

	set_form_definition_id ($form_definition_id)

Public Member Functions inherited from Manage_Table_SQL
	__construct (Data_SQL $p_table)

	add_json_param ($p_attribute, $p_value)
	Add json parameter to the current one. More...

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

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

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

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

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

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

	check ()

	count_error ()
	returns the nb of errors found More...

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

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

	display_error ()
	Display a list of the error collected. More...

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

	display_icon_del ($p_row)

	display_icon_mod ($p_row)

	display_row ($p_row)
	display a data row in the table, with the order defined in a_order and depending of the visibility of the column, all the rows contains the attribute ctl_pk_id , to retrieve in javascript , ie with the function afterSaveFct (see managetable.js) More...

	display_row_custom ($p_key, $p_value, $p_id=0)
	When displaying a row, if a column has the type "custom" , we can call this function to display properly the value including the tag "<td>". More...

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

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

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

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

	get_button_add_top ()

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

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

	get_col_type ($p_key)
	return the type of a column More...

	get_current_pos ($p_key)
	get the position of a column More...

	get_current_row ()
	Return the current row printed in display_row. More...

	get_dialog_box ()

	get_dialogbox_style ()
	return the db_style More...

	get_error ($p_col)
	retrieve the error message More...

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

	get_icon_del ()

	get_icon_mod ()

	get_js_variable ()
	Get the object name. More...

	get_json ()

	get_object_name ()

	get_order ()

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

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

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

	get_sort_column ()
	return the column to sort More...

	get_table ()

	getCssClass ()

	getTitle ()

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

	input_custom ($p_key, $p_value)
	this function let you create your own input , for example for a ITEXT , a IRADIO , ... it must be override , there is not default More...

	insert ()
	insert a new value More...

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

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

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

	send_header ()
	send the XML headers for the ajax call More...

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

	set_button_add_top ($button_add_top)

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

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

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

	set_col_sort ($p_num)
	When adding an element ,we place it thanks the DOM Attribute sort_value set it to -1 if you want one to append. More...

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

	set_col_type ($p_key, $p_value, $p_array=NULL)
	set the type of a column , it will change in the input db box , the select must supply an array of possible values [val=> , label=>] with the variable $this->key_name->a_value More...

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

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

	set_dialog_box ($dialog_box)

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

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

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

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

	set_icon_mod ($pString)
	Set the icon to modify at the right ,the first col or left of the row, if the mod if custom , you have to override the function display_icon_custom. More...

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

	set_object_name ($p_object_name)
	Set the object_name. More...

	set_order ($p_order)

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

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

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

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

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

	set_table (Data_SQL $p_noalyss_sql)

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

	set_value ($p_key, $p_value)

	setCssClass ($p_class)

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

	show_error ($p_col)

	update ()

Static Public Member Functions
static	build ($p_id, $p_form_def_id)
	build an object Acc_Report_MTable More...

Private Attributes
	$form_definition_id

Additional Inherited Members
Data Fields inherited from Manage_Table_SQL
const	UPDATABLE =1

const	VISIBLE =2

Protected Attributes inherited from Manage_Table_SQL
	$a_col_option
	in display_row and display_custom_row, it is the current row which is used More...

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

	$a_info
	Array with the infotip. More...

	$a_label_displaid
	Label of the col. of the datarow. More...

	$a_order
	order of the col More...

	$a_prop
	property for each col. More...

	$a_select
	Possible value if a_type is a SELECT. More...

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

	$aerror
	Array containing the error of the input data. More...

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

	$callback
	Callback function. More...

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

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

	$current_row
	CSS class for the dialog box. More...

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

	$dialogbox_style
	style of the dialog box More...

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

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

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

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

	$row_append
	Flag to indicate if rows can be added. More...

	$row_delete
	Flag to indicate if rows can be deleted. More...

	$row_update
	Flag to indicate if rows can be updated. More...

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

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

	$table
	Object Data_SQL. More...

	$title

Detailed Description

manage simple report

Definition at line 31 of file acc_report_mtable.class.php.

Constructor & Destructor Documentation

◆ __construct()

Acc_Report_MTable::__construct ( \Data_SQL $p_table )

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

    {
        parent::__construct($p_table);
    }

Member Function Documentation

◆ build()

static Acc_Report_MTable::build	(	$p_id,
		$p_form_def_id
	)

static

build an object Acc_Report_MTable

Parameters

int	$p_id	Form_Detail_SQL.id
int	$p_form_def_id	Parent Form

Returns: Acc_Report_MTable

Exceptions

Exception

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

    {
        $cn=Dossier::connect();
        $form_detail=new Form_Detail_SQL($cn, $p_id);
        if ( $p_id == -1) {
            $max=$cn->get_value("select coalesce(max(fo_pos),0) +10 from form_detail where fo_fr_id=$1",
                     [$p_form_def_id]);
            $form_detail->setp("fo_pos",$max);
        }
        $acc_report_mtable=new Acc_Report_MTable($form_detail);
        $acc_report_mtable->set_order(['fo_pos', 'fo_label', 'fo_formula']);
 
        $acc_report_mtable->set_col_label("fo_pos", _("Position"));
        $acc_report_mtable->set_col_label("fo_label", _("Libellé"));
        $acc_report_mtable->set_col_label("fo_formula", _("Formula"));
        $acc_report_mtable->set_form_definition_id($p_form_def_id);
 
        $acc_report_mtable->set_sort_column("fo_pos");
 
        $acc_report_mtable->set_col_type("fo_pos", "numeric");
        $acc_report_mtable->set_col_type("fo_formula", "custom");
        $acc_report_mtable->set_col_tips("fo_formula", 79);
 
        $acc_report_mtable->add_json_param("form_def", $p_form_def_id);
        $acc_report_mtable->add_json_param("op", "report_definition");
        $acc_report_mtable->set_callback("ajax_misc.php");
 
        return $acc_report_mtable;
    }

References $cn, $max, $p_id, and Dossier\connect().

Here is the call graph for this function:

◆ check()

Acc_Report_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 120 of file acc_report_mtable.class.php.

    {
        $obj=$this->get_table();
        $obj->setp("fo_fr_id",$this->form_definition_id);
        $n=0;
        if ( ! Impress::check_formula($obj->getp("fo_formula"))) {
            $this->set_error("fo_formula", _("Formule invalide"));
            $n++;
            
        }
        if ( trim($obj->getp("fo_label")) == "") {
            $n++;
            $this->set_error("fo_label",_("Nom est vide"));
        }
               
        if ($n == 0 ) { return true; }
        return false;
    }

References $obj, Impress\check_formula(), Manage_Table_SQL\get_table(), and Manage_Table_SQL\set_error().

Here is the call graph for this function:

◆ display_row_custom()

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

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

    {
        if ($p_key=='fo_formula')
        {
 
            return td($p_value);
        }
    }

References td().

Here is the call graph for this function:

◆ display_table()

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

Definition at line 115 of file acc_report_mtable.class.php.

    {
 
        return parent::display_table(" where fo_fr_id = $1 order by fo_pos", [$this->get_form_definition_id()]);
    }

References get_form_definition_id().

Here is the call graph for this function:

◆ get_form_definition_id()

Acc_Report_MTable::get_form_definition_id ( )

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

    {
        return $this->form_definition_id;
    }

References $form_definition_id.

Referenced by display_table().

◆ input_custom()

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

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

    {
        if ($p_key=='fo_formula')
        {
            $formula=new ITextarea('fo_formula');
            $formula->id='fo_formula';
            $formula->value=$p_value;
            echo $formula->input();
            
            echo HtmlInput::button_action(_("Cherche poste, fiche , analytique"), 
                                sprintf('search_account_card({gDossier:%s,target:\'%s\'})',Dossier::id(),
                                        "fo_formula")
                    );
            echo HtmlInput::hidden("form_def",$this->form_definition_id);
        }
    }

References HtmlInput\button_action(), HtmlInput\hidden(), and Dossier\id().

Here is the call graph for this function:

◆ set_form_definition_id()

Acc_Report_MTable::set_form_definition_id ( $form_definition_id )

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

                                                               : void
    {
        $this->form_definition_id=$form_definition_id;
    }

References $form_definition_id.

Field Documentation

◆ $form_definition_id

Acc_Report_MTable::$form_definition_id

private

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

Referenced by get_form_definition_id(), and set_form_definition_id().

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

include/class/acc_report_mtable.class.php

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ build()

◆ check()

◆ display_row_custom()

◆ display_table()

◆ get_form_definition_id()

◆ input_custom()

◆ set_form_definition_id()

Field Documentation

◆ $form_definition_id