Common functions. More...

Functions
	check_parameter ($p_array, $p_needed)
	Check that all the index are in the array, used by function to check if the array contains the needed variables before an extract.

	clean_filename ($p_filename)
	sanitize the filename remove character which could be a problem,

	CleanUrl ()
	Clean the url, remove the $_GET offset,step, page and size.

	isValid_deprecrated ($p_cn, $p_grpt_id)
	test if a jrn op is valid

	navigation_bar ($p_offset, $p_line, $p_size=0, $p_page=1, $p_javascript="")
	Create a navigation_bar (pagesize)

	redirect ($p_string, $p_time=0)

	toNumber ($p_num)
	remove the useless space, change comma by period and try to return a number

Detailed Description

Common functions.

Definition in file user_common.php.

Function Documentation

◆ check_parameter()

check_parameter	(		$p_array,
			$p_needed )

Check that all the index are in the array, used by function to check if the array contains the needed variables before an extract.

Parameters

type	$p_array	array to check
type	$needed	string containing variable separated by comma

Exceptions

Exception

Definition at line 209 of file user_common.php.

{
    $needed =explode(',',$p_needed);
    for ($e=0;$e<count($needed);$e++) {
            if ( ! isset($p_array[$needed[$e]])) {
                throw new Exception (_('Paramètre manquant')." ".$needed[$e]);
            }
        }
}

References $e, $p_array, and _.

Referenced by Acc_Ledger_Fin\verify_operation(), Acc_Ledger_Purchase\verify_operation(), and Acc_Ledger_Sale\verify_operation().

◆ clean_filename()

clean_filename ( $p_filename )

sanitize the filename remove character which could be a problem,

Parameters

string $p_filename the filename to clean

Returns: string Filename without bad char.

Definition at line 223 of file user_common.php.

{
    $filename=$p_filename;
    foreach (array('/','*','<','>',';',',','\\',':','(',')',' ','[',']') as $i) {
            $filename= noalyss_str_replace($i, "-",$filename);
    }
    $filename=str_replace(search: ['é','è','ê','ë'],replace:['e'], subject: $filename);
    $filename=str_replace(search: ['à','â','ä','æ'],replace:['a'], subject: $filename);
    $filename=str_replace(search: ['ù','ü','û'],replace:['u'], subject: $filename);
    $filename=str_replace(search: ['ù','ü','û'],replace:['a'], subject: $filename);
    $filename=str_replace(search: ['ç'],replace:['c'], subject: $filename);
    $filename=str_replace(search: ['ô','ö'],replace:['o'], subject: $filename);
    $filename=str_replace(search: ['î','ï'],replace:['i'], subject: $filename);
    $filename=iconv('utf-8','ascii//IGNORE',$filename);
    return $filename;
 
}

References $i, and noalyss_str_replace().

Referenced by Document_Export\export_receipt().

Here is the call graph for this function:

◆ CleanUrl()

CleanUrl ( )

Clean the url, remove the $_GET offset,step, page and size.

Parameters

none

Returns: the cleaned url

Definition at line 175 of file user_common.php.

{
    // Compute the url
    $url=http_build_query($_GET);
    return $url;
}

References $_GET, and $url.

◆ isValid_deprecrated()

isValid_deprecrated	(		$p_cn,
			$p_grpt_id )

test if a jrn op is valid

Parameters

$p_cn	db
$p_grpt_id

Returns

:

1 is valid
0 is not valid

Definition at line 39 of file user_common.php.

{
    $Res=$p_cn->exec_sql("select jr_valid from jrn where jr_grpt_id=$p_grpt_id");
 
    if ( ( $M = Database::num_row($Res)) == 0 ) return 0;
 
    $a=Database::fetch_array($Res,0);
 
    if ( $a['jr_valid'] == 't') return 1;
    if ( $a['jr_valid'] == 'f') return 0;
 
    echo_error ("Invalid result = ".$a['result']);
 
}

References $a, $Res, echo_error(), DatabaseCore\fetch_array(), and DatabaseCore\num_row().

Here is the call graph for this function:

◆ navigation_bar()

navigation_bar	(	$p_offset,
		$p_line,
		$p_size = 0,
		$p_page = 1,
		$p_javascript = "" )

Create a navigation_bar (pagesize)

Parameters

$p_offset	first record number
$p_line	total of returned row
$p_size	current g_pagesize user's preference
$p_page	number of the page where the user is
$p_javascript	javascript code to add

Note

example :

   $step=$_SESSION[SESSION_KEY.'g_pagesize'];
   $page=(isset($_GET['offset']))?$_GET['page']:1;
   $offset=(isset($_GET['offset']))?$_GET['offset']:0;

   list ($max_ligne,$list)=ListJrn($cn,$_GET['p_jrn'],$sql,null,$offset,1);
   $bar=navigation_bar($offset,$max_ligne,$step,$page);

Returns: string with the nav. bar

Definition at line 76 of file user_common.php.

{
    // if the pagesize is unlimited return ""
    // in that case there is no nav. bar
    if ( $_SESSION[SESSION_KEY.'g_pagesize'] == -1  ) return "";
    if ( $p_size==0)
    {
        $p_size= $_SESSION[SESSION_KEY.'g_pagesize'];
    }
    // if there is no row return an empty string
    if ( $p_line == 0 ) return "";
 
    // Clean url, cut away variable coming frm here
    $url=cleanUrl();
    // action to clean
    $url=noalyss_str_replace('&p_action=delete','',$url);
 
    // compute max of page
    $nb_page=($p_line-($p_line%$p_size))/$p_size;
    // if something remains
    if ( $p_line % $p_size != 0 ) $nb_page+=1;
 
    // if max page == 1 then return a empty string
    if ( $nb_page == 1) return "";
 
    // restore the sort
    if ( isset($_GET['o']))
        $url=$url.'&o='.$_GET['o'];
 
    $r="";
    // previous
    if ($p_page !=1)
    {
        $e=$p_page-1;
        $step=$p_size;
        $offset=($e-1)*$step;
 
        $r='<A class="mtitle" href="'.basename($_SERVER['PHP_SELF'])."?".$url."&offset=$offset&step=$step&page=$e&size=$step".'" '.$p_javascript.'>';
        $r.="         &larr;";
        // $r.='<INPUT TYPE="IMAGE" width="12" SRC="image/go-previous.png">';
        $r.="</A>&nbsp;&nbsp;";
    }
    //----------------------------------------------------------------------
    // Create a partial bar
    // if current page < 11 show 1 to 20
    // otherwise            show $p_page -10 to $p_page + 10
    //----------------------------------------------------------------------
    $start_bar=($p_page < 11 )?1:$p_page-10;
    $end_bar  =($p_page < 11 )?20:$p_page+10;
    $end_bar  =($end_bar > $nb_page )?$nb_page:$end_bar;
 
        $sep="";
    // Create the bar
    for ($e=$start_bar;$e<=$end_bar;$e++)
    {
        // do not included current page
        if ( $e != $p_page )
        {
            $step=$p_size;
            $offset=($e-1)*$step;
 
            $go=$_SERVER['PHP_SELF']."?".$url."&offset=$offset&step=$step&page=$e&size=$step";
                        $r.=$sep;
            $r.=sprintf('<A class="nav" HREF="%s"  %s >%d</A>&nbsp;',$go,$p_javascript,$e);
                        $sep=" &#8231;  ";
        }
        else
        {
                        $r.=$sep;
            $r.="<b> [ $e ] </b>";
                        $sep=" &#8231;  ";
        } //else
    } //for
    // next
 
    if ($p_page !=$nb_page)
    {
        // If we are not at the last page show the button next
        $e=$p_page+1;
        $step=$p_size;
        $offset=($e-1)*$step;
 
        $r.='&nbsp;<A class="mtitle" href="'.$_SERVER['PHP_SELF']."?".$url."&offset=$offset&step=$step&page=$e&size=$step".'" '.$p_javascript.' >';
        $r.="&rarr;";
        //$r.='<INPUT TYPE="IMAGE" width="12" SRC="image/go-next.png">';
        $r.="</A>";
    }
 
 
    return $r;
}

References $_GET, $e, $offset, $r, $sep, $step, $url, and noalyss_str_replace().

Referenced by Stock\history(), Anc_Operation\html_table(), Fiche_Def\myList(), Follow_Up\myList(), contact\Summary(), and Fiche\Summary().

Here is the call graph for this function:

◆ redirect()

redirect	(		$p_string,
			$p_time = 0 )

Definition at line 181 of file user_common.php.

{
    if (strpos( $p_string,'?') == 0 ) {
        $p_string = $p_string.'?v='.microtime(true);
    }
    echo '<HTML><head><META HTTP-EQUIV="REFRESH" content="'.$p_time.'; url='.$p_string.'"></head><body> Connecting... </body></html>';
}

◆ toNumber()

toNumber ( $p_num )

remove the useless space, change comma by period and try to return a number

Parameters

$p_num number to format

Returns: the formatted number

Definition at line 194 of file user_common.php.

{
    $p_num=trim($p_num);
    if ($p_num=='') return 0;
    $p_num=noalyss_str_replace("'",'',$p_num);
    $p_num=noalyss_str_replace(',','.',$p_num);
    return $p_num;
}

References noalyss_str_replace().

Here is the call graph for this function:

Functions

Detailed Description

Function Documentation

◆ check_parameter()

◆ clean_filename()

◆ CleanUrl()

◆ isValid_deprecrated()

◆ navigation_bar()

◆ redirect()

◆ toNumber()