Chronique : DEFACER

Thu, 24 Jan 2013 08:30:00 +0200

Bonjour,

Comme indiquÃ© il y a quelques temps dÃ©jÃ sur un sujet du forum "Chronique d'Alain01 : Un module sous toutes ses coutures", nous allons commencer cette toute nouvelle chronique avec un objectif d'un module dÃ©taillÃ© par mois.

Utilisation de modÃ¨les / gabarits

Thu, 10 Jan 2013 21:20:00 +0200

Bonjour,

Beaucoup d'entre vous rÃ©alisent des sites web avec un contenu qui, pour certaines rubriques auraient besoin d'uniformisation.

Il s'agit ici de vous indiquer assez simplement comment crÃ©er des modÃ¨les (ou gabarit) de fiches (fiche cuisine, fiche livre, fiche cinÃ©ma, fiche voiture).

Bien dÃ©buter avec xoops

Fri, 27 Jul 2012 17:30:00 +0200

Afin de faciliter la rÃ©alisation et la mise en place d'un site Web rÃ©alisÃ© sous Xoops, je viens de dÃ©velopper ce petit tutoriel qui j'espÃ¨re vous aidera dans vos rÃ©alisations. Bonne lecture

La crÃ©ation d'un site web avec Xoops peut Ãªtre trÃ¨s simple ou plus complexe si l'on veut faire des modifications. MalgrÃ© l'impatience que l'on peut avoir Ã vouloir rapidement publier son site sur le web, il est plus prudent de commencer Ã se familiariser avec Xoops sur son ordinateur personnel.

XOOPS est conÃ§u sur une architecture modulaire, basÃ© sur les droits des utilisateurs. L'une des erreurs communes aux dÃ©butants est de se demander comment rajouter des pages. Le noyau de XOOPS ne se charge en fait que de la gestion des droits d'accÃ¨s, de l'affichage gÃ©nÃ©ral du site et de la gestion des commentaires, des notifications, de la recherche...

Pour toutes les autres fonctionnalitÃ©s (galerie photo, pages HTML...), il vous faudra rajouter des modules, c'est-Ã -dire des scripts qui Ã©tendent les capacitÃ©s initiales du noyau. Les modules sont gÃ©rÃ©s via l'interface administration Ã Modules > SystÃ¨me > Modules. Vous trouverez de nombreux modules Ã tÃ©lÃ©charger dans notre rÃ©fÃ©rentiel.

HÃ©ritage de la class xoopsForm

Wed, 18 Jan 2012 23:30:00 +0200

HÃ©ritage de la class xoopsForm

Qu'est ce que l'hÃ©ritage ?

L'hÃ©ritage est un principe propre Ã la programmation orientÃ©e objet (POO), permettant de crÃ©er une nouvelle classe Ã partir d'une classe existante. La nouvelle classe "hÃ©rite" des propriÃ©tÃ©s et mÃ©thodes de la classe dont elle hÃ©rite, appelÃ©e classe "mÃ¨re". La classe qui hÃ©rite est appelÃ©e classe "fille".

Cette dÃ©finition est trÃ¨s succincte vous pouvez complÃ©ter vos connaissances en programmation orientÃ© objet sur le web, un petit lien concernant l'hÃ©ritage : http://wind.developpez.com/tutoriels/windev/windev-poo-heritage/

Xoops et l'hÃ©ritage

Comme tout bon projet informatique, xoops utilise la POO. En effet ses dÃ©veloppeurs (que je remercie au passage) ont Ã©crit un ensemble de classes qui rÃ©gissent ce projet.
Donc nous pouvons utiliser l'hÃ©ritage pour ajouter, modifier le comportement de XOOPS.

Tout Ã§a, c'est trÃ¨s bien, mais pourquoi faire ?

on peut modifier n'importe quelles classes directement dans le projet.

Ces modifications sont appelÃ©es des "HACKs".

C'est a ce moment prÃ©cis, que vous introduisez dans votre code le grain de sable qui risque de vous miner la vie, pour l'Ã©volution et la maintenance de votre site.
- Que vas t'il se passer Ã la prochaine mise Ã jour ? Dans 1 an.......
Plus rien ne vas fonctionner correctement, il va falloir recommencer toutes les modifica-tions une par une; Comme vous Ãªtes un dÃ©veloppeur compÃ©tent vous avez pris soin de consigner dans un fichier ou sur un "petit cahier" toutes les modifications Ã faire.

Dans le cas contraire : je vous souhaite bon courage !

L'autre solution c'est d'utiliser l'hÃ©ritage, allons y !

Prenons un exemple avec un formulaire dans XOOPS.
Les formulaires dans XOOPS, bien que souvent suffisants, ne peuvent pas rÃ©pondent Ã l'ensemble de vos besoins spÃ©cifiques.

Nous allons ici, voir 2 applications de l'hÃ©ritage avec XOOPS et plus prÃ©cisÃ©ment avec les Ã©lÃ©ments xoopsThemeForm et xoopsElement , ce n'est que des exemples et absolument pas restrictif.

changer l'url de action du formulaire Ã la volÃ©
ajouter un nouvel Ã©lÃ©ment, pas disponible dans le projet initial

Nous partons du principe, que nous avons un module appelÃ© myModule et que ce module tout Ã fait standard contient un rÃ©pertoire class dans lequel nous allons pouvoir placer nos nouvelles classes.

La premiÃ¨re chose, c'est comprendre comment sont hiÃ©rarchisÃ©es les classes qui gÃ©nÃ¨rent le formulaire.

La classe XoopsForm est la classe de base du formulaire, c'est une classe abstraite, ce qui signifie que cette classe ne doit pas Ãªtre utilisÃ©e directement mais qu'elle doit Ãªtre Ã©tendue, gÃ©nÃ©ralisÃ©e. C'est en faite une sorte de gabarit, des propriÃ©tÃ©s et des mÃ©thodes.
Je vous laisse vous plonger dans la POO pour plus de dÃ©tail.

La classe XoopsThemeForm est la classe qui gÃ©nÃ©ralise XoopSForm et qui vas afficher le formulaire sous forme de table, c'est cette classe dont nous hÃ©riterons, pour modifier le comportement gÃ©nÃ©ral du formulaire.

Note : si nous voulons que notre formulaire ne sâaffiche plus sous forme de tableau, alors il nous suffirait de partir directement de XoopsForm et refaire le travail Ã notre sauce; Pour Ã§a, s'en se prendre la tÃªte, il suffit de partir de xoopsThemeForm et de modifiÃ© la mÃ©thode render() qui est responsable de l'affichage.

Comme vous l'aurez remarquÃ©, dans XoopsForm (voir API) la mÃ©thode render() est vide, et oui ! C'est Ã§a une classe abstraite; Elle nous dit juste que cette mÃ©thode doit Ãªtre redÃ©-finie dans la classe qui l'Ã©tend.

Donc dans XoopsThemeForm la mÃ©thode est redÃ©finie pour affichÃ© un formulaire sous forme de table :


function render()

    {

        $ele_name = $this->getName();

        $ret = '<form name="' . $ele_name . '" id="' . $ele_name . '" action="' . $this->getAction() . '" method="' . $this->getMethod() . '" onsubmit="return xoopsFormValidate_' . $ele_name . '();"' . $this->getExtra() . '>

            <table width="100%" class="outer" cellspacing="1">

            <tr><th colspan="2">' . $this->getTitle() . '</th></tr>

        ';

        $hidden = '';

        $class = 'even';

        foreach ($this->getElements() as $ele) {

            if (!is_object($ele)) {

                $ret .= $ele;

            } else if (!$ele->isHidden()) {

                if (!$ele->getNocolspan()) {

                    $ret .= '<tr valign="top" align="left"><td class="head">';

                    if (($caption = $ele->getCaption()) != '') {

                        $ret .= '<div class="xoops-form-element-caption' . ($ele->isRequired() ? '-required' : '') . '">';

                        $ret .= '<span class="caption-text">' . $caption . '</span>';

                        $ret .= '<span class="caption-marker">*</span>';

                        $ret .= '</div>';

                    }

                    if (($desc = $ele->getDescription()) != '') {

                        $ret .= '<div class="xoops-form-element-help">' . $desc . '</div>';

                    }

                    $ret .= '</td><td class="' . $class . '">' . $ele->render() . '</td></tr>' . NWLINE;

                } else {

                    $ret .= '<tr valign="top" align="left"><td class="head" colspan="2">';

                    if (($caption = $ele->getCaption()) != '') {

                        $ret .= '<div class="xoops-form-element-caption' . ($ele->isRequired() ? '-required' : '') . '">';

                        $ret .= '<span class="caption-text">' . $caption . '</span>';

                        $ret .= '<span class="caption-marker">*</span>';

                        $ret .= '</div>';

                    }

                    $ret .= '</td></tr><tr valign="top" align="left"><td class="' . $class . '" cols-pan="2">' . $ele->render() . '</td></tr>';

                }

            } else {

                $hidden .= $ele->render();

            }

        }

        $ret .= '</table>' . NWLINE . ' ' . $hidden . '</form>' . NWLINE;

        $ret .= $this->renderValidationJS(true);

        return $ret;

    }

Mise en pratique

Dans notre premier exemple nous souhaitons envoyer notre formulaire Ã un traitement diffÃ©rent en fonction d'une action utilisateur.

Notre formulaire est le suivant :


// CrÃ©ation de l'objet formulaire

$my_form = new ThemeForm("mon formulaire", 'Form_bien', "han-dle_bien.php?action=save");



// CrÃ©ation des Ã©lÃ©ments de formulaire

$reference = new XoopsFormText("RÃ©fÃ©rence", "reference", 50, 100);



$prix= new XoopsFormText("Prix","prix",50,100);



// Ajout des Ã©lÃ©ments au formulaire

$my_form->addElement($reference,true);

$my_form->addElement($prix, true);



// Idem pour un bouton

$button = new XoopsFormButton('', 'post', _SEND, 'submit');

$my_form->addElement($button);

// Affichage du formulaire

$my_form->display();

Jusqu'ici rien de bien sorcier ! Nous allons donc modifier le comportement de XoopsThemeForm pour cela,nous crÃ©ons un fichier php dans le rÃ©pertoire class, que nous nommons de maniÃ¨re trÃ¨s original : my_form.php

Nous obtenons maintenant la sÃ©quence dâhÃ©ritage suivante :

Pour que cette classe hÃ©rite de XoopsThemeForm, on dit aussi pour qu'elle Ã©tend, ou en-core qu'elle gÃ©nÃ©ralise, on Ã©crit en php :


<?php

class MyForm extends XoopsThemeForm{



}

?>

Bien sÃ»r pour que cela fonctionne, il faut que la classe "fille" trouve sa classe "mÃ¨re", donc il faut inclure la classe XoopsThemeForm ce qui donne :


<?php

include_once(./../XoopsThemeForm.php)



class MyForm extends XoopsThemeForm{



}

?>

Vous pouvez aussi utiliser xoops_load de la maniÃ¨re suivante :


<?php



defined('XOOPS_ROOT_PATH') or die('Restricted access');



xoops_load('XoopsThemeForm');



class MyForm extends XoopsThemeForm {}

Ensuite on peut soit ajouter de nouvelles propriÃ©tÃ©s ou de nouvelles mÃ©thodes ou bien redÃ©finir des mÃ©thodes existantes, on dit dans ce cas "Que l'on surcharge (override) la mÃ©thode".

Nous allons ajouter Ã notre formulaire une nouvelle mÃ©thode, actuellement la classe XoopsThemeForm ne permet pas de changer le paramÃ¨tre action du formulaire aprÃ¨s avoir dÃ©clarÃ© le constructeur, ce paramÃ¨tre est passÃ© au constructeur une fois pour toute; Mais on veut le modifier en fonction des actions utilisateurs et diriger le formulaire vers des traitement diffÃ©rents.


<?php

xoops_load('XoopsThemeForm');



class MyForm extends XoopsThemeForm {



    private $newAction;



     public function setNewAction($url=null){

        

        $url===null?$this->newAction=$this->getAction():  $this->newAction=$action;

  

        }

}

?>

Cette nouvelle mÃ©thode (appelÃ© aussi "setter") affecte l'url a la nouvelle propriÃ©tÃ© $newAc-tion si le paramÃ¨tre de la fonction est passÃ©.

Note importante :
La classe xoopsForm, n'a pas Ã©tait optimisÃ©e pour Ãªtre gÃ©nÃ©ralisÃ©e de maniÃ¨re a donner a ux dÃ©veloppeurs la possibilitÃ© de faire ce qu'ils veulent, Ã mon grand regret. Pour cela il aurait fallu que les propriÃ©tÃ©s de la classe xoopsForm soit "protected" et non "private" (je vous renvois Ã la POO) ou alors que : chaque propriÃ©tÃ© soit associÃ©e Ã un "setter" et Ã un "getter". j'ignore les raisons de cette absence.
Ceci vas nous obliger a redÃ©finir la fonction render(). Ceux qui n'aurait pas Ã©tÃ© obligatoire si nous avions eu des "setter" ou que les propriÃ©tÃ©s eÃ»t Ã©tÃ©es "protected"

La classe avec la fonction render() redÃ©finie, on remplace $this->getAction par notre nouvelle propriÃ©tÃ© $newAction, ce qui donne :


<?php

xoops_load('XoopsThemeForm');



class MyForm extends XoopsThemeForm {



    private $newAction;



     public function setNewAction($url=null){

        

            $url===null?$this->newAction=$this->getAction():  $this->newAction=$action;

  

        }



    function render()

    {

        $ele_name = $this->getName();

        $ret = '<form name="' . $ele_name . '" id="' . $ele_name . '" action="' . $this->newAction. '" method="' . $this->getMethod() . '" onsubmit="return xoopsFormValidate_' . $ele_name . '();"' . $this->getExtra() . '>

            <table width="100%" class="outer" cellspacing="1">

            <tr><th colspan="2">' . $this->getTitle() . '</th></tr>

        ';

        $hidden = '';

        $class = 'even';

        foreach ($this->getElements() as $ele) {

            if (!is_object($ele)) {

                $ret .= $ele;

            } else if (!$ele->isHidden()) {

                if (!$ele->getNocolspan()) {

                    $ret .= '<tr valign="top" align="left"><td class="head">';

                    if (($caption = $ele->getCaption()) != '') {

                        $ret .= '<div class="xoops-form-element-caption' . ($ele->isRequired() ? '-required' : '') . '">';

                        $ret .= '<span class="caption-text">' . $caption . '</span>';

                        $ret .= '<span class="caption-marker">*</span>';

                        $ret .= '</div>';

                    }

                    if (($desc = $ele->getDescription()) != '') {

                        $ret .= '<div class="xoops-form-element-help">' . $desc . '</div>';

                    }

                    $ret .= '</td><td class="' . $class . '">' . $ele->render() . '</td></tr>' . NWLINE;

                } else {

                    $ret .= '<tr valign="top" align="left"><td class="head" colspan="2">';

                    if (($caption = $ele->getCaption()) != '') {

                        $ret .= '<div class="xoops-form-element-caption' . ($ele->isRequired() ? '-required' : '') . '">';

                        $ret .= '<span class="caption-text">' . $caption . '</span>';

                        $ret .= '<span class="caption-marker">*</span>';

                        $ret .= '</div>';

                    }

                    $ret .= '</td></tr><tr valign="top" align="left"><td class="' . $class . '" cols-pan="2">' . $ele->render() . '</td></tr>';

                }

            } else {

                $hidden .= $ele->render();

            }

        }

        $ret .= '</table>' . NWLINE . ' ' . $hidden . '</form>' . NWLINE;

        $ret .= $this->renderValidationJS(true);

        return $ret;

    }



}

?>

Maintenant nous pouvons l'utiliser de la maniÃ¨re suivante :


$my_form=new MyForm(paramÃ¨tres);



If(condition){

// maintenant on change l'url du formulaire

   $MyForm->setNewAction('test.php')

}

Vous pouvez faire une mise Ã jour s'en risque......

DeuxiÃ¨me exemple on souhaite ajouter un Ã©lÃ©ment qui n'existe pas dans les classes de XOOPS, par exemple on veut que notre formulaire affiche des images prÃ©cÃ©demment tÃ©lÃ©chargÃ©es sur le serveur, pour informer l'utilisateur.

Il n'y a pas d'Ã©lÃ©ment, affiche image, dans les formulaires de XOOPS. Nous allons donc le crÃ©er en Ã©tendant la classe XoopsFormElement, qui est la classe chargÃ©e de crÃ©er un Ã©lÃ©ment de formulaire, comme formcolorpicker etc....

classe :


<?php



defined('XOOPS_ROOT_PATH') or die('Restricted access');



class MyElement extends XoopsFormElement

{

    

    var $_content;

    

    function __construct($caption = '', $value = '', $name = '')

    {

        $this->setCaption($caption);

        $this->setName($name);

        $this->_value = $value;

    }

    

    function setContent($content)

    {

        $this->_content=$content;

        

    }

    

    function getContent($encode=false){

        

        return $encode ? htmlspecialchars($this->_content, ENT_QUOTES) : $this->_content;

        

    }

    

    function render()

    {

        return $this->getContent();

    }

}

?>

Utilisation :


$planchePhoto=new myElement();

$planchePhoto->setContent('<div class="photos">vos photos</div>');


$my_form->addElement($planchePhoto);

Thu, 12 Feb 2009 13:30:00 +0200

Pour rÃ©aliser votre logo Xoops, vous devez disposer du logiciel Adobe Photoshop et tÃ©lÃ©charger le fichier .psd (document attachÃ©)

CommunautÃ© Francophone des Utilisateurs de Xoops

Chronique : DEFACER

Utilisation de modÃ¨les / gabarits

Bien dÃ©buter avec xoops

HÃ©ritage de la class xoopsForm

HÃ©ritage de la class xoopsForm

Qu'est ce que l'hÃ©ritage ?

Xoops et l'hÃ©ritage

Tout Ã§a, c'est trÃ¨s bien, mais pourquoi faire ?

L'autre solution c'est d'utiliser l'hÃ©ritage, allons y !

La premiÃ¨re chose, c'est comprendre comment sont hiÃ©rarchisÃ©es les classes qui gÃ©nÃ¨rent le formulaire.

Mise en pratique

Comment crÃ©er votre logo Xoops ?