Class contact (customer, supplier...) More...

Inheritance diagram for contact:

Collaboration diagram for contact:

Public Member Functions
	__construct ($p_cn, $p_id=0)
	constructor

	build_sql ($array)
	Build the SQL query thanks the parameter.

	filter_active (bool $p_active)

	filter_category ($pn_category)

	filter_company ($p_company=null)

	filter_search ($p_search="")

	getFilter ()

	Summary ($p_search="", $p_action="", $p_sql="", $p_nothing=false)
	display a summary of the contact card,

Public Member Functions inherited from Fiche
	__toString ()

	belong_ledger ($p_jrn, $p_type="")
	Check if a fiche is used by a jrn return 1 if the fiche is in the range otherwise 0, the quick_code or the id must be set.

	blank ($p_fiche_def)
	insert a new record show a blank card to be filled

	button_csv ($p_from, $p_to)
	Return a string with the HTML code to display a button to export the history in CSV.

	button_pdf ($p_from, $p_to)
	Return a string with the HTML code to display a button to export the history in PDF.

	count_by_modele ($p_frd_id, $p_search="", $p_sql="")
	Count the nb of card with the reference card id frd_id.

	delete ()

	Display ($p_readonly, $p_in="")
	Display object instance, getAttribute sort the attribute and add missing ones.

	display_row ()
	display card as a table row , the tag TR must be added

	empty_attribute ($p_attr)
	check if an attribute is empty

	filter_history ($p_table_id)
	Filter in javascript the table with the history.

	Get ()
	Synonum of fiche::getAttribut.

	get_all_account ()

	get_amount_side ($p_amount)
	return the letter C if amount is > 0, D if < 0 or =

	get_bank_ledger ()
	Returns the Acc_Ledger_Fin ledger for which the card is the default bank account or null if no ledger is found.

	get_bk_account ()
	get the available bank_account filtered by the security

	get_bk_balance ($p_cond="")
	get the bank balance with receipt or not in Euro

	get_bk_balance_currency ($p_cond="")
	Get the sum in Currency.

	get_by_category ($p_offset=-1, $p_search="", $p_order='')
	get all the card thanks the fiche_def_ref

	get_by_qcode ($p_qcode=null, $p_all=true)
	Retrieve a card thx his quick_code complete the object,, set the id member of the object or set it to 0 if no card is found.

	get_categorie ()
	get the fd_id of the card : fd_id, it set the attribute fd_id

	get_f_enable ()

	get_fiche_def_ref ()

	get_fiche_def_ref_id ()
	retrieve the frd_id of the fiche it is the type of the card (bank, purchase...) (fiche_def_ref primary key)

	get_gestion_title ()

	get_id ()

	get_quick_code ()
	return the quick_code of a card

	get_row ($p_from, $p_to)
	Get data for poste.

	get_row_date ($p_from, $p_to, $op_let=0)
	Get data for poste.

	get_solde_detail ($p_cond="")
	give the balance of an card

	getAttribut ()
	get all the attribute of a card, add missing ones and sort the array ($this->attribut) by ad_id

	GetByDef ($p_frd_id, $p_offset=-1, $p_search="", $p_order='')
	Return array of card from the frd family deprecated , use insert get_by_category_id.

	getDisplayMode ()

	getLabelCategory ()

	getName ()
	return the name of a card

	HtmlTable ($p_array=null, $op_let=0, $from_div=1)
	HtmlTable, display a HTML of a card for the asked period.

	HtmlTableDetail ($p_array=null, $op_let=0)
	HtmlTable, display a HTML of a card for the asked period.

	HtmlTableHeader ($p_array=null)
	Display HTML Table Header (button)

	insert ($p_fiche_def, $p_array=null, $transaction=true)
	insert a new record thanks an array , either as parameter or $_POST

	is_used ()
	check if a card is used

	load ()
	Synonum of fiche::getAttribut.

	move_to ($p_fdid)
	move a card to another cat.

	remove ($silent=false)
	remove a card, check if not used first, must be synchro with is_used

	save ($p_fiche_def=0)
	Save a card, call insert or update.

	seek ($p_attribut, $p_value)
	find the card with the p_attribut equal to p_value, it is not case sensitive

	set_f_enable ($f_enable)

	set_fiche_def ($p_fiche_def)

	set_fiche_def_ref ($fiche_def_ref)

	set_id ($id)

	setAttribut ($p_ad_id, $p_value)
	set an attribute by a value, if the attribut array is empty a call to getAttribut is performed

	setDisplayMode ($p_mode)
	how the card is display : either in a window or a greated container

	ShowTable ()

	strAttribut ($p_ad_id, $p_return=1)

	to_array ()
	turn a card into an array , then it can be saved thanks update or insert

	update ($p_array=null)
	update a card with an array

Private Member Functions
	fetch ($ps_sql)
	Fetch all rows from view, ordered by by contact_name, with offset and limit.

Private Attributes
	$filter

Additional Inherited Members
Static Public Member Functions inherited from Fiche
static	cmp_name (Fiche $o1, Fiche $o2)
	used with a usort function, to sort an array of Fiche on the name

static	from_qcode ($p_qcode)
	create a card from a qcode and returns a card

static	get_fiche_def ($p_cn, $pFd_id, $p_order='')
	get all the card from a categorie

static	test_me ()

Data Fields inherited from Fiche
	$attribut

	$cn

	$fiche_def

	$fiche_def_ref

	$id

	$ledger_description
	!< this variable is a mistake, it shouldn't exist, need code rewrite

	$ledger_name

	$quick_code

	$row

	$tot_cred

	$tot_deb

Detailed Description

Class contact (customer, supplier...)

Definition at line 30 of file contact.class.php.

Constructor & Destructor Documentation

◆ __construct()

contact::__construct	(		$p_cn,
			$p_id = 0 )

constructor

Reimplemented from Fiche.

Definition at line 35 of file contact.class.php.

    {
        $this->fiche_def_ref=FICHE_TYPE_CONTACT;
        parent::__construct($p_cn,$p_id) ;
        $this->filter=[];
    }

References $p_id, and FICHE_TYPE_CONTACT.

Member Function Documentation

◆ build_sql()

contact::build_sql ( $array )

Build the SQL query thanks the parameter.

Parameters

array $array if empty , we use $this->filter , otherwise $array will override it

Returns: string

Reimplemented from Fiche.

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

    {
        if ( empty($array) ) $array=$this->filter;
 
        $sql_query='
        SELECT f_id,
               contact_fname, 
               contact_name, 
               contact_qcode, 
               contact_company, 
               contact_mobile, 
               contact_phone, 
               contact_email, 
               contact_fax
        FROM public.v_contact
        ';
        $where=' where ';$and='';
        if ( isset ($array['company'])) {
            $sql_query.=$where.sprintf(" contact_company ilike '%%%s%%'",
                    sql_string($array['company']));
            $where='';$and=' and ';
        }
        if ( isset($array['search'])) {
            $sql_query.=$where.$and.sprintf(" f_id in (select distinct f_id from fiche_detail where ad_value ilike '%%%s%%')",
                    sql_string($array['search']));
            $where='';$and=' and ';
 
        }
        if ( isset($array['category'])) {
            $sql_query.=$where.$and.sprintf(" fd_id = %s",
                    sql_string($array['category']));
            $where='';$and=' and ';
        }
        if ( isset ($array['active']) && $array['active'] == true) {
            $sql_query .= $where.$and.sprintf("  f_enable='1'  ");
            $where='';$and=' and ';
        }
        return $sql_query;
    }

References $array, $filter, and sql_string().

Referenced by Summary().

Here is the call graph for this function:

◆ fetch()

contact::fetch ( $ps_sql )

private

Fetch all rows from view, ordered by by contact_name, with offset and limit.

See also: Contact::build_sql()

Parameters

$ps_string

Returns: array

Definition at line 167 of file contact.class.php.

                                   {
        $http=new HttpInput();
        // Get offset and page variable
        $offset=$http->request('offset','number',0);
        $nb_pagesize=$_SESSION[SESSION_KEY.'g_pagesize'];
        $limit = '';
        $ps_sql.=' order by contact_name ';
        if ( $nb_pagesize <0 ) {$limit='';} else {
            $limit=sprintf(' limit %s offset %s',$nb_pagesize,$offset);
        }
        $ps_sql .=  $limit ;
        if (DEBUGNOALYSS > 1) {
            var_export("Contact::fetch ($ps_sql)");
        }
        return $this->cn->get_array($ps_sql);
    }

References $http, $limit, $offset, and cn.

Referenced by Summary().

◆ filter_active()

contact::filter_active ( bool $p_active )

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

                                           {
        if ( $p_active) {
            $this->filter['active']=true;
        } else {
             $this->filter['active']=false;
        }
    }

◆ filter_category()

contact::filter_category ( $pn_category )

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

                                           {
        unset($this->filter['category']);
        if ( !empty($pn_category)
            && isNumber($pn_category)==1
            && $pn_category != -1){
            $this->filter['category']=$pn_category;
        }
    }

References isNumber().

Here is the call graph for this function:

◆ filter_company()

contact::filter_company ( $p_company = null )

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

                                             {
        unset($this->filter['company']);
        if ( ! empty($p_company) && $p_company != "-1")  {
            $this->filter['company']= strtoupper($p_company);
        }
        return $this;
    }

◆ filter_search()

contact::filter_search ( $p_search = "" )

Definition at line 108 of file contact.class.php.

                                         {
        unset($this->filter['search']);
        if ( ! empty($p_search) ){
            $this->filter['search']=$p_search;
        }
    }

Referenced by Summary().

◆ getFilter()

contact::getFilter ( )

Returns: array

Definition at line 118 of file contact.class.php.

                               : array
    {
        return $this->filter;
    }

References $filter.

◆ Summary()

contact::Summary	(	$p_search = "",
		$p_action = "",
		$p_sql = "",
		$p_nothing = false )

display a summary of the contact card,

Parameters

string	p_search : filter on card name, if empty , contact->filter will be used
string	p_action : not used
string	p_sql : extra SQL command not used
string	p_nothing (filter) not used

Returns: string to display

Reimplemented from Fiche.

Definition at line 133 of file contact.class.php.

    {
        $http=new HttpInput();
        if ( !empty ($p_search) ) { $this->filter_search($p_search);}
 
        $sql=$this->build_sql($this->filter);
        \Noalyss\Dbg::echo_var(1,"Contact::summary ($sql)");
        // Creation of the nav bar
        // Get the max numberRow
        $all_contact=$this->cn->get_value("select count(*) from ($sql) as m");
            if ( $all_contact == 0 ) return "";
 
        // Get offset and page variable
        $offset=$http->request('offset','number',0);
        $page=$http->request('page','number',1);
 
        $bar=navigation_bar($offset,$all_contact,$_SESSION[SESSION_KEY.'g_pagesize'],$page);
 
 
        // Get The result Array
        $step_contact=$this->fetch($sql);
 
 
        $contact=$this;
        require NOALYSS_TEMPLATE.'/contact-summary.php';
 
    }

References $bar, $http, $offset, $p_action, $sql, build_sql(), cn, Noalyss\Dbg\echo_var(), fetch(), filter_search(), and navigation_bar().

Here is the call graph for this function:

Field Documentation

◆ $filter

contact::$filter

private

Definition at line 32 of file contact.class.php.

Referenced by build_sql(), and getFilter().

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

include/class/contact.class.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ build_sql()

◆ fetch()

◆ filter_active()

◆ filter_category()

◆ filter_company()

◆ filter_search()

◆ getFilter()

◆ Summary()

Field Documentation

◆ $filter