====== Widget ======
:FINISHED: NOALYSS 9.3
===== Définition =====

Un widget est un élément sur le tableau de bord qui affiche le suivi, des rapports, un agenda,…​




===== Développement =====

le nom code du widget , est toujours le même que celui du sous-répertoire dans noalyss/include/widget, que le nom du fichier principal et aussi, le nom de la CLASS.


|Important|ce nom ne peut pas contenir d’autres caractères que des lettres et des soulignés, de préférence toujours en minuscule.|


Par exemple: le widget avec le code event (voir table widget_dashboard) est le nom du sous-répertoire de noalyss/include/widget


|Note|Les widgets doivent fonctionner dans le namespace Noalyss/Widget|




===== Installation =====

Création d’un fichier appelé "install.php" dans le sous-répertoire noalyss/include/widget qui sera exécuté si le widget n’est pas encore dans la base de données. Quand l’utilisateur est sur le tableau de bord, qu’il clique sur "Personnaliser" puis "Ajouter", le programme va scanner le répertoire noalyss/include/widget à la recherche de fichiers install.php, il va vérifier que chaque fichier est dans la base de données ou l’insère s’il n’y est pas.


Le code du fichier install.php est simplement d’insérer le widget dans la base de données et éventuellement peut initialiser d’autres choses.


  * **structure table WIDGET_DASHBOARD** Contient tous les widgets ,


^Colonne       ^Type de données^Description                                                                                                      ^
|wd_id         |int            |clef primaire (valeur automatique)                                                                               |
|wd_code       |texte          |code du widget (doit être unique , pas de souligné ou de caractères interdit, ce sera aussi le nom de la classe )|
|wd_description|texte          |description du widget , ce qu’il fait                                                                            |
|wd_parameter  |int            |égal à 0, s’il n’y a pas de paramètre, à 1 s’il existe un paramètre (voir Paramètre)                             |

Exemple


<code php>
global $cn;

$cn->exec_sql("insert into widget_dashboard (wd_code,wd_description,wd_parameter,wd_name) values ($1,$2,$3,$4)",
array (
    'event'
    ,'Affiche les 10 actions en retards, celles à venir , les 10 prochaines factures client ou fournisseurs, ou celles en retard '
    ,1
    ,'10 actions ou factures'
    )
);
</code>





===== Ajax =====

Tous les appels Ajax appellent "html/ajax_misc.php" , la requête doit contenir :


  * la variable **op** : "widget"
  * la variable **w** : chaîne qui est le code du widget (nom du sous-répertoire de include/widget)


le fichier Ajax.php du sous-répertoire NOALYSS_INCLUDE/widget/(w)/Ajax.php sera appelé




===== Application =====

La classe s’appelle toujours "nom-du-widget.php" , elle est dérivée de widget et doit avoir les fonctions


  * display : affichage du widget
  * input : affichage de la description et permet son activation (visible dans la box )
  * input-parameter : si des paramètres doivent être sauvées, les paramètres sont par utilisateur et par widget activés,
  * display_parameter


==== Paramètres ====

Certains widgets peuvent être paramétrés, et il est possible d’ajouter plusieurs fois le même widget


Exemple mini-report : choix du mini-report à afficher,


Pour cela, il faut ajouter certaines fonctions :


=== input_parameter() : création du FORM ===

création d’un FORM dont le DOMID sera le code widget (wd_code) suivi de "_param"


exemple pour mini_report, on utilise la fonction Widget->make_form , qui enveloppe le code transmis dans une balise FORM, construisant ainsi le code HTML d’un FORM qui sera envoyé correctement en Ajax. Les paramètres passés seront sauvés dans user_widget et pourront être récupérés dans un tableau associatif avec Widget->get_parameter.


<code php>
    function input_parameter() {

        $select=new \ISelect('simple_report');
        $select->value=$this->db->make_array("select fr_id, fr_label from form_definition order by 2");
        $this->make_form($select->input());
    }
</code>




=== display_parameter : affichage des paramètres ===

Les paramètres sont toujours sauvés "brut" , comme une chaîne URL par la fonction Widget->make_form(), il faut donc pouvoir l’afficher, en la travaillant avec parse_str, pour cela il faut appeler Widget->get_parameter(), le résultat doit être dans un SPAN avec la classe "widget_param".


Exemple pour mini_report


<code php>
    function display_parameter() {
        $aParam=$this->get_parameter();
        $name = $this->db->get_value("select fr_label from form_definition where fr_id=$1",[$aParam['simple_report']]);
        echo " ";
        echo span(_("Rapport") ." ".h($name),' class="widget_param"');


    }
</code>





==== function display ====

Toujours commencer par un DIV (id=code_widget+uw_id), Widget::open_div et Widget::close_div


Puis avoir un titre et un bouton "Agrandissement", avec la fonction Widget::button_zoom ou utiliser la fonction Widget->title()


Example

<code php>
echo HtmlInput::title_box('titre du widget', uniqid(), 'custom', $this->button_zoom(), 'n');

// ou plus simplement

echo $this->title('Titre du widget');
</code>



Ce DIV doit avoir comme classe **box** et **widget-box** , le **widget-box** permet de numéroter les boites.



==== Exemple complet ====

|Tip|Toute la documentation du code source est maintenue avec Doxygen, ici on a un exemple.|


<code php>
/*!
 * \file
 * \brief display the next invoice to  to be paid or late for customer or supplier
 */
namespace Noalyss\Widget;
/*!
 * \class
 * \brief display the next invoice to  to be paid or late for customer or supplier
 */
class Invoice extends Widget
{
    function input_parameter()
    {
        $tiers = new \ISelect('tiers');
        $tiers->value[] = array('value' => 'S', 'label' => _("Fournisseurs"));
        $tiers->value[] = array('value' => 'C', 'label' => _("Clients"));
        $time_limit = new \ISelect('time_limit');
        $time_limit->value[] = array('value' => 'P', 'label' => _("Prochaines factures"));
        $time_limit->value[] = array('value' => 'R', 'label' => _("Factures en retard"));
        $time_limit->value[] = array('value' => 'T', 'label' => _("Factures pour aujourd'hui"));

        $input = _("Factures ") . $tiers->input() . " " . _("échéance") . " " . $time_limit->input();
        $this->make_form($input);

    }

    function display_parameter()
    {
        $aParam = $this->get_parameter();
        $aTiers = ['S' => _("Fournisseurs"), "C" => _("Clients")];
        $aLimit = ['P' => _("Prochaines"), "R" => "Retard",'T'=>_("Aujourd'hui")];
        echo '<span class="widget_param">'.$aTiers[$aParam['tiers']] . " " . $aLimit[$aParam["time_limit"]].'</span>';
    }

    function display()
    {
        $this->open_div();
        $aParam = $this->get_parameter();
        $aTiers = ['S' => _("Fournisseurs"), "C" => _("Clients")];
        $aLimit = ['P' => _("Prochaines factures"), "R" => "facture en retard",'T'=>_("Aujourd'hui")];
        $title = $aTiers[$aParam['tiers']] . " " . $aLimit[$aParam["time_limit"]];
        echo $this->title($title);
        $acc_ledger = new \Acc_Ledger($this->db, 0);

        $ledger_type = 'ACH';
        if ($aParam['tiers'] == 'C') {
            $ledger_type = 'VEN';
        }

        switch ($aParam['time_limit']) {
            case 'P':
                $array = $acc_ledger->get_operation_date(date('d.m.Y'), $ledger_type, '>');
                break;
            case 'R':
                $array = $acc_ledger->get_operation_date(date('d.m.Y'), $ledger_type, '<');
                break;
            case 'T':
                $array = $acc_ledger->get_operation_date(date('d.m.Y'), $ledger_type, '=');
                break;
        }
        include "invoice-display.php";
        $this->close_div();


    }
</code>