Main class for widget. More...

Inheritance diagram for Noalyss\Widget\Widget:

Collaboration diagram for Noalyss\Widget\Widget:

Public Member Functions
	__construct (protected int $user_widget_id=0, protected string $widget_code="", protected $db=null)

	button_zoom ()
	compute the button ZOOM to put in the title

	close_div ()

	display ()
	display the content for the current connected user of the widget with the parameter

	display_parameter ()
	MUST BE overrided if the widget needs extra parameters, display the content of extra-parameter.

	get_div_domid ()
	compute the DIV ID

	get_parameter ()
	get the parameter of the widget and returns an array

	get_user_widget_id ()

	get_var_name ()

	get_widget_code ()

	input ($flnumber=true)
	display a description of the widget and allow to save it for the current user, call input_param function of the widget if it exists

	input_parameter ()
	MUST BE overrided if the widget needs extra parameters, create a FORM to add extra-parameter.

	make_form ($html_input)
	open a form with the DOMID "widget_code"_param, it appears once only for each widget in the dialog box for adding widget to the dashboard

	open_div ()
	output the DIV HTML with class and id for the widget

	set_user_widget_id (int $user_widget_id)

	set_var_name ($var_name)

	set_widget_code (string $widget_code)

	title ( $title)
	display the title and the icon for zooming + refresh if possible

Static Public Member Functions
static	ajax_display (Widget $widget)
	display a box and fills it with the content of an ajax calls , the ajax calls Widget::display

static	build_refresh_js ($widget_code, $widget_id, $var_name)
	build refresh javascript

static	build_user_widget ($user_widget_id, $widget_code)
	Build a widget thank the user_widget_id (SQL :PK : USER_WIDGET.UW_ID) and $widget_code.

static	display_available ()
	@brier display activated widgets

static	get_enabled_widget ()
	returns an array of widget for the connected user, ordered

static	save ($array)
	save widget order from an array

static	scanfolder ()
	scan folder to find install.php file , include them if the code is not in DB

static	select_available ()
	show all the widget that can be added

Protected Attributes
	$var_name
	< $var_name string name of the variable in javascript

Detailed Description

Main class for widget.

Definition at line 31 of file widget.php.

Constructor & Destructor Documentation

◆ __construct()

Noalyss\Widget\Widget::__construct	(	protected int	$user_widget_id = 0,
		protected string	$widget_code = "",
		protected	$db = null )

Definition at line 38 of file widget.php.

    {
        if ($db == null) {
            $this->db=\Dossier::connect();
        }
        $this->var_name='';
    }

References db.

Member Function Documentation

◆ ajax_display()

static Noalyss\Widget\Widget::ajax_display ( Widget $widget )

static

display a box and fills it with the content of an ajax calls , the ajax calls Widget::display

Parameters

Widget $widget

Returns: void

Definition at line 199 of file widget.php.

                                                 {
        $box= sprintf( '%s_%s',$widget->get_widget_code(),$widget->get_user_widget_id());
        $widget->open_div();
        echo h2(_("Un instant, on charge :-)"),' class="title" ');
 
 
        print '<div style="display:flex;justify-content: center">';
        print '<div style="margin-top: 50px;margin-left: 20px;">';
        print '<div class="loading_msg"></div>';
        print '<div class="loading_msg"></div>';
        print '<div class="loading_msg"></div>';
        print '<div class="loading_msg"></div>';
        print '<div class="loading_msg"></div>';
        print '</div>';
        print '</div>';
 
        $widget->close_div();
 
        $dossier_id=\Dossier::id();
        $widgetjs=uniqid('widget');
        echo <<<EOF
<script>
var {$widgetjs}= new Widget('{$dossier_id}') 
{$widgetjs}.display('{$box}',{$widget->get_user_widget_id()},'{$widget->get_widget_code()}','{$widgetjs}')
</script>
 
 
EOF;
 
 
 
    }

References $dossier_id, _, close_div(), display(), get_user_widget_id(), get_widget_code(), h2(), open_div(), and print.

Here is the call graph for this function:

◆ build_refresh_js()

static Noalyss\Widget\Widget::build_refresh_js	(	$widget_code,
		$widget_id,
		$var_name )

static

build refresh javascript

Parameters

$widget_id	int id from DB
$widget_code	string code of the widget
$var_name	string name of the js variable

Definition at line 410 of file widget.php.

    {
        // var $box string DOM ID  of the DIV containing the widget
        $box= sprintf( '%s_%s',$widget_code,$widget_id);
        $refresh=sprintf("%s.display('%s','%s','%s','%s')",
            $var_name,
            $box,
            $widget_id,
            $widget_code,
            $var_name
        );
        return $refresh;
    }

References $refresh, and $var_name.

Referenced by Noalyss\Widget\Agenda\display(), Noalyss\Widget\Last_Operation\display(), and title().

◆ build_user_widget()

static Noalyss\Widget\Widget::build_user_widget	(		$user_widget_id,
			$widget_code )

static

Build a widget thank the user_widget_id (SQL :PK : USER_WIDGET.UW_ID) and $widget_code.

Parameters

$user_widget_id	integer (SQL :PK : USER_WIDGET.UW_ID)
$widget_code	string (SQL WIDGET_DASHBOARD.WD_CODE)

Returns: Widget

Definition at line 159 of file widget.php.

                                                                   :?Widget
    {
        // load the class if file (code/code.php) exists.
        if (file_exists(NOALYSS_INCLUDE."/widget/$widget_code/$widget_code.php")) {
            require_once NOALYSS_INCLUDE."/widget/$widget_code/$widget_code.php";
            $class=sprintf("\\Noalyss\\Widget\\%s",$widget_code);
            $obj= new $class;
            $obj->set_widget_code($widget_code);
            $obj->set_user_widget_id($user_widget_id);
            return $obj;
        }
 
        // return the object
        return null;
    }

References $class, and $obj.

Referenced by display_available(), and select_available().

◆ button_zoom()

Noalyss\Widget\Widget::button_zoom ( )

compute the button ZOOM to put in the title

Returns: \html

Definition at line 379 of file widget.php.

                           {
        $bt = \Icon_Action::zoom(uniqid(), sprintf("widget.toggle_full_size('%s')",$this->get_div_domid()));
        return $bt;
    }

References get_div_domid(), and Icon_Action\zoom().

Referenced by title().

Here is the call graph for this function:

◆ close_div()

Noalyss\Widget\Widget::close_div ( )

Definition at line 190 of file widget.php.

                         {
        echo '</div>';
    }

Referenced by ajax_display(), Noalyss\Widget\Agenda\display(), Noalyss\Widget\Bookmark\display(), Noalyss\Widget\Coming_Event\display(), Noalyss\Widget\Event\display(), Noalyss\Widget\Invoice\display(), Noalyss\Widget\Last_Event\display(), Noalyss\Widget\Last_Operation\display(), and Noalyss\Widget\Mini_Report\display().

◆ display()

Noalyss\Widget\Widget::display ( )

abstract

display the content for the current connected user of the widget with the parameter

Returns: mixed

Reimplemented in Noalyss\Widget\Agenda, Noalyss\Widget\Bookmark, Noalyss\Widget\Coming_Event, Noalyss\Widget\Event, Noalyss\Widget\Invoice, Noalyss\Widget\Last_Event, Noalyss\Widget\Last_Operation, Noalyss\Widget\Mini_Report, and Noalyss\Widget\Todo_List.

Referenced by ajax_display().

◆ display_available()

static Noalyss\Widget\Widget::display_available ( )

static

@brier display activated widgets

Returns: void

Definition at line 236 of file widget.php.

    {
 
        $aWidget=Widget::get_enabled_widget();
        echo '<ul class="list-unstyled" id="contain_widget">';
        foreach ($aWidget as $item) {
            $widget=Widget::build_user_widget($item['uw_id'],$item['wd_code']);
            $widget->input();
        }
        echo '</ul>';
        echo \HtmlInput::hidden("order_widget_hidden", "");
        create_script("widget.create_sortable()");
    }

References $aWidget, build_user_widget(), create_script(), and get_enabled_widget().

Here is the call graph for this function:

◆ display_parameter()

Noalyss\Widget\Widget::display_parameter ( )

MUST BE overrided if the widget needs extra parameters, display the content of extra-parameter.

Parameters

$user_widget_id

Returns: void

Exceptions

Exception

Reimplemented in Noalyss\Widget\Invoice, and Noalyss\Widget\Mini_Report.

Definition at line 333 of file widget.php.

                                 {
        throw new \Exception(__FUNCTION__." not implemented");
    }

Referenced by input().

◆ get_div_domid()

Noalyss\Widget\Widget::get_div_domid ( )

compute the DIV ID

Returns: string

Definition at line 187 of file widget.php.

                             :string {
        return sprintf( "%s_%s",$this->widget_code,$this->user_widget_id);
    }

References return.

Referenced by button_zoom(), Noalyss\Widget\Mini_Report\display(), and open_div().

◆ get_enabled_widget()

static Noalyss\Widget\Widget::get_enabled_widget ( )

static

returns an array of widget for the connected user, ordered

Returns: array [ uw_id,dashboard_widget_id,wd_code,wd_description

Definition at line 137 of file widget.php.

                                        :array
    {
        global $g_user,$cn;
        return $cn->get_array("
        select 
        uw.uw_id,
        uw.dashboard_widget_id ,
        wd.wd_code,
        wd.wd_description
        from user_widget uw 
join widget_dashboard wd on (uw.dashboard_widget_id=wd.wd_id)
where use_login=$1 order by uw.uw_order
",[$g_user->login]);
 
    }

References $cn, and $g_user.

Referenced by display_available().

◆ get_parameter()

Noalyss\Widget\Widget::get_parameter ( )

get the parameter of the widget and returns an array

Returns: array key=>value

Definition at line 367 of file widget.php.

    {
        $param = $this->db->get_value("select uw_parameter from user_widget where uw_id=$1",[$this->user_widget_id]);
        if (empty ($param)) return [];
        parse_str($param,$aParam);
        return $aParam;
    }

References db.

Referenced by Noalyss\Widget\Invoice\display(), Noalyss\Widget\Invoice\display_parameter(), and Noalyss\Widget\Mini_Report\display_parameter().

◆ get_user_widget_id()

Noalyss\Widget\Widget::get_user_widget_id ( )

Definition at line 63 of file widget.php.

                                        : int
    {
        return $this->user_widget_id;
    }

Referenced by ajax_display(), Noalyss\Widget\Agenda\display(), and title().

◆ get_var_name()

Noalyss\Widget\Widget::get_var_name ( )

Returns: mixed

Definition at line 49 of file widget.php.

    {
        return $this->var_name;
    }

References $var_name.

Referenced by Noalyss\Widget\Agenda\display(), Noalyss\Widget\Last_Operation\display(), and title().

◆ get_widget_code()

Noalyss\Widget\Widget::get_widget_code ( )

Definition at line 74 of file widget.php.

                                     : string
    {
        return $this->widget_code;
    }

Referenced by ajax_display(), Noalyss\Widget\Agenda\display(), and title().

◆ input()

Noalyss\Widget\Widget::input ( $flnumber = true )

display a description of the widget and allow to save it for the current user, call input_param function of the widget if it exists

Returns: mixed

Definition at line 96 of file widget.php.

    {
        static $nb=0;
        $nb++;
        //read description from database
        $row=$this->db->get_row("
                    select 
                        wd_code
                        ,wd_name
                        ,wd_parameter,
                        wd_description 
                    from 
                        widget_dashboard 
                    where 
                        wd_code=$1",
        [$this->widget_code]);
        $strNumber="";
        if ( $flnumber) $strNumber="[ $nb ]";
        echo "<li id=\"elt_{$this->user_widget_id}\">  $strNumber <span class='widget-name'>{$row['wd_name']}</span>{$row['wd_description']}";
 
        if ( $this->user_widget_id > 0) {
            if ( $row['wd_parameter'] == 1) {
                $this->display_parameter();
            }
            echo '<span style="float:right;color:red">'.\Icon_Action::trash(uniqid(),sprintf("widget.delete('%s')",$this->user_widget_id));
        }
        else {
            if ( $row['wd_parameter'] == 1) {
                $this->input_parameter();
            }
            echo '<span style="float:right;">'.\Icon_Action::icon_add(uniqid(),sprintf("widget.add('%s')",$this->widget_code));
        }
 
        echo '</span>';
        echo '</li>';
    }

References $nb, $row, db, display_parameter(), and input_parameter().

Here is the call graph for this function:

◆ input_parameter()

Noalyss\Widget\Widget::input_parameter ( )

MUST BE overrided if the widget needs extra parameters, create a FORM to add extra-parameter.

Returns: void

Exceptions

Exception

Reimplemented in Noalyss\Widget\Invoice, and Noalyss\Widget\Mini_Report.

Definition at line 321 of file widget.php.

    {
        throw new \Exception(__FUNCTION__." not implemented");
    }

Referenced by input().

◆ make_form()

Noalyss\Widget\Widget::make_form ( $html_input )

open a form with the DOMID "widget_code"_param, it appears once only for each widget in the dialog box for adding widget to the dashboard

Parameters

$html_input string HTML string with all the HTML INPUT that will be enclosed by the FORM

Returns: void

Definition at line 309 of file widget.php.

    {
        printf ('<form id="%s_param" style="display:inline">',$this->widget_code);
        echo $html_input;
        printf ('</form>');
    }

Referenced by Noalyss\Widget\Invoice\input_parameter(), and Noalyss\Widget\Mini_Report\input_parameter().

◆ open_div()

Noalyss\Widget\Widget::open_div ( )

output the DIV HTML with class and id for the widget

Returns: void

Definition at line 179 of file widget.php.

                        {
        printf( '<div id="%s" class="box widget-box">',$this->get_div_domid());
    }

References get_div_domid().

Referenced by ajax_display(), Noalyss\Widget\Agenda\display(), Noalyss\Widget\Bookmark\display(), Noalyss\Widget\Coming_Event\display(), Noalyss\Widget\Event\display(), Noalyss\Widget\Invoice\display(), Noalyss\Widget\Last_Event\display(), Noalyss\Widget\Last_Operation\display(), and Noalyss\Widget\Mini_Report\display().

Here is the call graph for this function:

◆ save()

static Noalyss\Widget\Widget::save ( $array )

static

save widget order from an array

Parameters

$array array of USER_WIDGET.UW_ID

Returns: void

Exceptions

DatabaseCore fails , cannot update

Definition at line 256 of file widget.php.

                                 {
        global $cn,$g_user;
        if (empty($array)) {
            $cn->exec_sql("delete from user_widget where use_login = $1",[$g_user->getLogin()]);
            return;
        }
        try {
            $cn->start();
            $order=10;
            $cn->exec_sql("create temporary table tmp_widget(user_widget_id integer,tw_order integer )");
            foreach ($array as $item) {
                $cn->exec_sql('insert into tmp_widget(user_widget_id,tw_order ) values ($1,$2)',
                [$item,$order]);
                $order+=20;
            }
            $cn->exec_sql("delete from user_widget where use_login = $1 and uw_id not in (select user_widget_id from tmp_widget)",
                array($g_user->getLogin()));
 
            $cn->exec_sql("update user_widget set uw_order =tw_order from  tmp_widget where user_widget_id=uw_id");
 
            $cn->commit();
 
        } catch (\Exception $e) {
            throw ($e);
        }
 
 
    }

References $array, $cn, $e, $g_user, and $order.

◆ scanfolder()

static Noalyss\Widget\Widget::scanfolder ( )

static

scan folder to find install.php file , include them if the code is not in DB

Returns: void

Definition at line 341 of file widget.php.

    {
        global $cn;
        $handle=opendir(NOALYSS_INCLUDE."/widget");
        while (($dir = readdir($handle)) != false ) {
            $directory=NOALYSS_INCLUDE."/widget".DIRECTORY_SEPARATOR.$dir;
            if (is_dir($directory) && $dir != "." && $dir != "..") {
                // code exists in DB ?
                $cnt=$cn->get_value("select count(*) from widget_dashboard where wd_code = $1",[$dir]);
                if ( $cnt > 0) {
                    continue;
                } else {
                    // include the install.php file if any and install the widget
                    if (file_exists($directory . DIRECTORY_SEPARATOR . "install.php")){
                        include $directory . DIRECTORY_SEPARATOR . "install.php";
                    }
                }
            }
        }
 
    }

References $cn, $cnt, and $directory.

Referenced by select_available().

◆ select_available()

static Noalyss\Widget\Widget::select_available ( )

static

show all the widget that can be added

Returns: void

Definition at line 289 of file widget.php.

    {
        global $cn;
        Widget::scanfolder();
        $aWidget=$cn->get_array("select wd_code,wd_name, wd_description,wd_parameter from widget_dashboard order by wd_name");
        echo '<ul id="widget_add" class="list-unstyled">';
        foreach ($aWidget as $item) {
            $widget=Widget::build_user_widget(-1,$item['wd_code']);
            $widget?->input(false);
 
        }
        echo '</ul>';
    }

References $aWidget, $cn, build_user_widget(), and scanfolder().

Here is the call graph for this function:

◆ set_user_widget_id()

Noalyss\Widget\Widget::set_user_widget_id ( int $user_widget_id )

Definition at line 68 of file widget.php.

                                                           : Widget
    {
        $this->user_widget_id = $user_widget_id;
        return $this;
    }

◆ set_var_name()

Noalyss\Widget\Widget::set_var_name ( $var_name )

Parameters

mixed $var_name

Definition at line 57 of file widget.php.

                                           :Widget
    {
        $this->var_name = $var_name;
        return $this;
    }

References $var_name.

◆ set_widget_code()

Noalyss\Widget\Widget::set_widget_code ( string $widget_code )

Definition at line 79 of file widget.php.

                                                        :  Widget
    {
        $this->widget_code = $widget_code;
        return $this;
    }

◆ title()

Noalyss\Widget\Widget::title ( $title )

display the title and the icon for zooming + refresh if possible

Parameters

$title string title of the widget

Definition at line 387 of file widget.php.

                            {
        // var $refresh string javascript to refresh the widget
        $refresh='';
        if ( $this->get_var_name() !="") {
            $refresh=Widget::build_refresh_js( $this->get_widget_code(),
                $this->get_user_widget_id(),
                $this->get_var_name());
 
        }
 
        $r='<div class="bxbutton">';
        $r.=\Icon_Action::refresh(uniqid(), $refresh);
        $r.='<span  id="span_'.uniqid().'" style="float:right;margin-right:5px">'.$this->button_zoom()."</span>";
        $r.='</div>';
        $r.=sprintf('<h2 class="title">%s</h2>',$title);
        echo $r;
    }

References $r, $refresh, $title, build_refresh_js(), button_zoom(), get_user_widget_id(), get_var_name(), get_widget_code(), and Icon_Action\refresh().

Here is the call graph for this function:

Field Documentation

◆ $var_name

Noalyss\Widget\Widget::$var_name

protected

< $var_name string name of the variable in javascript

Definition at line 34 of file widget.php.

Referenced by build_refresh_js(), get_var_name(), and set_var_name().

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

include/widget/widget.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ ajax_display()

◆ build_refresh_js()

◆ build_user_widget()

◆ button_zoom()

◆ close_div()

◆ display()

◆ display_available()

◆ display_parameter()

◆ get_div_domid()

◆ get_enabled_widget()

◆ get_parameter()

◆ get_user_widget_id()

◆ get_var_name()

◆ get_widget_code()

◆ input()

◆ input_parameter()

◆ make_form()

◆ open_div()

◆ save()

◆ scanfolder()

◆ select_available()

◆ set_user_widget_id()

◆ set_var_name()

◆ set_widget_code()

◆ title()

Field Documentation

◆ $var_name