lib/MECON/HTML/Icon.php

   1 <?php /* vim: set binary expandtab tabstop=4 shiftwidth=4 textwidth=80:
   2 -------------------------------------------------------------------------------
   3                              Ministerio de Economía
   4                                     meconlib
   5 -------------------------------------------------------------------------------
   6 This file is part of meconlib.
   7
   8 meconlib is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 2 of the License, or (at your option)
  11 any later version.
  12
  13 meconlib is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License; if not,
  18 write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  19 Boston, MA  02111-1307  USA
  20 -------------------------------------------------------------------------------
  21 Creado:  mar mar 16 15:55:32 ART 2004
  22 Author:  Leandro Lucarella <llucar@mecon.gov.ar>
  23 -------------------------------------------------------------------------------
  24 $Id$
  25 -----------------------------------------------------------------------------*/
  26
  27 require_once 'MECON/HTML/Link.php';
  28 require_once 'MECON/HTML/Image.php';
  29
  30 /**
  31  * Ícono.
  32  *
  33  * Básicamente es una imágen con un link.
  34  * Ejemplo:
  35  * @code
  36  * require_once 'MECON/HTML/Icon.php';
  37  * require_once 'MECON/HTML/Link.php';
  38  * // Crea un ícono de IR sin link.
  39  * $icono1 = new MECON_HTML_Icon('ir');
  40  * // Crea un ícono de ELIMINAR que apunta a 'algun/lugar'.
  41  * $icono2 = new MECON_HTML_Icon('eliminar', 'algun/lugar');
  42  * // Crea un ícono de NUEVO que apunta a 'algun/lugar?id=3&cant=10', tiene el
  43  * // texto alternativo '>>' y 1 píxel de borde.
  44  * $icono3 = new MECON_HTML_Icon('nuevo',
  45  *     new MECON_HTML_Link('algun/lugar', '', array('id' => 3, $cant => 10)),
  46  *     '>>', array('border' => 1));
  47  * // Muestra todos los íconos.
  48  * $icon1->display();
  49  * echo $icon2->toHtml();
  50  * $icon3->display();
  51  * @endcode
  52  *
  53  * @access public
  54  */
  55 class MECON_HTML_Icon extends MECON_HTML_Image {
  56
  57     /**
  58      * Link a donde apunta la imagen.
  59      * @private
  60      */
  61     var $_link;
  62
  63     /**
  64      * Alineacion de la imagen con respecto al texto.
  65      * @private
  66      */
  67     var $_align;
  68
  69     /**
  70      * Constructor.
  71      *
  72      * @param $nombre Nombre de la imágen.
  73      * @param $link   Link a donde apunta. Si es null, no tiene un link.
  74                       Puede ser un link o un MECON_HTML_Link.
  75      * @param $alt    Texto alternativo para la imagen.
  76      * @param $attrs  Atributos de la imágen.
  77      * @param $align  Alineación de la imagen con respecto al texto.
  78      */
  79     function MECON_HTML_Icon($nombre, $link = null, $alt = null, $attrs =
  80             array(), $align = 'right')
  81     {
  82         switch ($nombre) {
  83             default:
  84                 $src = "/MECON/images/general_$nombre";
  85         }
  86         if (is_null($alt)) {
  87             $alt = '(' . strtoupper($nombre{0}) . ')';
  88         }
  89         parent::MECON_HTML_Image($src, $alt, $attrs);
  90         $this->setLink($link);
  91         $this->_align = $align;
  92     }
  93
  94     /**
  95      * Converts to HTML output.
  96      *
  97      * @return string
  98      */
  99     function toHtml()
 100     {
 101         if (is_null($this->_link)) {
 102             return parent::toHtml();
 103         } else {
 104             $link = $this->getLink();
 105             return $link->toHtml();
 106         }
 107     }
 108
 109     /**
 110      * Gets image location.
 111      */
 112     function getSrc()
 113     {
 114         return $this->getAttribute('src');
 115     }
 116
 117     /**
 118      * Sets image location.
 119      *
 120      * @param  string $src Image location.
 121      */
 122     function setSrc($src)
 123     {
 124         $this->updateAttributes(array('src' => $src));
 125     }
 126
 127     /**
 128      * Gets image alternate text.
 129      */
 130     function getAlt()
 131     {
 132         return $this->getAttribute('alt');
 133     }
 134
 135     /**
 136      * Establece el link a donde apunta el ícono.
 137      *
 138      * @param $link Nuevo link.
 139      */
 140     function setLink($link)
 141     {
 142         if (!is_a($link, 'mecon_html_link') and !is_null($link)) {
 143             $this->_link = new MECON_HTML_Link($link);
 144         } else {
 145             $this->_link = $link;
 146         }
 147     }
 148
 149     /**
 150      * Obtiene el link a donde apunta el ícono.
 151      * @param $full Si es true, devuelve el link con la imagen incluida, si
 152      *              es false devuelve solo el link.
 153      */
 154     function getLink($full = true)
 155     {
 156         $link = $this->_link;
 157         if (!$full or is_null($link)) {
 158             return $link;
 159         }
 160
 161         if ($this->_align == 'left') {
 162             $link->addContents(new MECON_HTML_Image($this->getSrc(),
 163                         $this->getAlt(), $this->getAttributes()), true);
 164         }
 165         elseif ($this->_align == 'right') {
 166             $link->addContents(new MECON_HTML_Image($this->getSrc(),
 167                         $this->getAlt(), $this->getAttributes()));
 168         }
 169         return $link;
 170     }
 171
 172 }
 173
 174 ?>