lib/MECON/HTML/Link.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: Thu Aug 21 15:09:10 2003
  22 Autor:  @@author <@@email>
  23 -------------------------------------------------------------------------------
  24 $Id$
  25 -----------------------------------------------------------------------------*/
  26
  27 require_once 'HTML/Common.php';
  28
  29 /**
  30  * HTML Link representation.
  31 When adding GET variables, if the value is an object, it looks for a toString() method, if it doesn't exists or if is an array, it serializes the object/array to get a string value.
  32 This is done in toHtml() method. Object are stored as references.
  33  *
  34  * @package HTML
  35  * @access public
  36  */
  37 class MECON_HTML_Link extends HTML_Common {
  38     /**
  39      * Variables to send via GET HTTP method.
  40      *
  41      * @var    array $getVars
  42      * @access protected
  43      */
  44     var $_getVars = array();
  45
  46     /**
  47      * Link contents.
  48      *
  49      * @var    array $contents
  50      * @access protected
  51      */
  52     var $_contents = array();
  53
  54     /**
  55      * Gets GetVars.
  56      *
  57      * @return array
  58      * @access public
  59      */
  60     function getGetVars()
  61     {
  62         return $this->_getVars;
  63     }
  64
  65     /**
  66      * Sets GetVars.
  67      *
  68      * @param  array $getVars GetVars.
  69      *
  70      * @return void
  71      * @access public
  72      */
  73     function setGetVars($getVars)
  74     {
  75         $this->_getVars = $getVars;
  76     }
  77
  78     /**
  79      * Constructor.
  80      *
  81      * @param  string $href Hypertext reference.
  82      * @param  mixed $contents Link contents.
  83      * @param  array $getVars Array (as key => value pairs) of GET variables to pass to the link.
  84      * @param  array $attrs Other links (A tag) attributes.
  85      *
  86      * @return void
  87      * @access public
  88      */
  89     function MECON_HTML_Link($href = '', $contents = '', $getVars = array(), $attrs = array())
  90     {
  91         if (is_array($attrs)) {
  92             $attrs['href'] = $href;
  93             if (!isset($attrs['class'])){
  94                 $attrs['class'] = 'mecon_html_link';
  95             }
  96         } else {
  97             $attrs .= " href=$href";
  98         }
  99         parent::HTML_Common($attrs);
 100         $this->_getVars = $getVars;
 101         $this->addContents($contents);
 102     }
 103
 104     /**
 105      * Converts to HTML output.
 106      *
 107      * @return string
 108      * @access public
 109      */
 110     function toHtml() // ~X2C
 111     {
 112         $attrs = '';
 113         foreach ($this->getAttributes() as $key => $val) {
 114             if ($key == 'href') {
 115                 $vars = array();
 116                 foreach ($this->_getVars as $var => $v) {
 117                     if (is_object($v) and method_exists($v, 'tostring')) {
 118                         $v = $v->tostring();
 119                     } elseif (is_object($v) or is_array($v)) {
 120                         $v = serialize($v);
 121                     }
 122                     $vars[] = urlencode($var) . '=' . urlencode($v);
 123                 }
 124                 if ($vars) {
 125                     $val .= '?' . join('&', $vars);
 126                 }
 127             } else {
 128                 $val = htmlentities($val);
 129             }
 130             $attrs .= ' ' . $key . '="' . $val . '"';
 131         }
 132         return "<A$attrs>" . $this->getContents() . '</A>';
 133     }
 134
 135     /**
 136      * Gets hypertext reference.
 137      *
 138      * @return string
 139      * @access public
 140      */
 141     function getHref() // ~X2C
 142     {
 143         return $this->getAttribute('href');
 144     }
 145
 146     /**
 147      * Sets hypertext reference.
 148      *
 149      * @param  string $href Hypertext reference.
 150      *
 151      * @return void
 152      * @access public
 153      */
 154     function setHref($href) // ~X2C
 155     {
 156         $this->updateAttributes(array('href' => $href));
 157     }
 158
 159     /**
 160      * Set a GET variable.
 161      *
 162      * @param  string $key Key for the GET variable.
 163      * @param  mixed $value Value for the variable.
 164      *
 165      * @return void
 166      * @access public
 167      */
 168     function setGetVar($key, $value) // ~X2C
 169     {
 170         $this->_getVars[$key] = $value;
 171     }
 172
 173     /**
 174      * Updates GET variables.
 175      *
 176      * @param  array $vars Array (as key => value pairs) of GET variables to update.
 177 If they doesn't exists, they are added, if they exists, they are updated.
 178      *
 179      * @return void
 180      * @access public
 181      */
 182     function updateGetVars($vars) // ~X2C
 183     {
 184         $this->_getVars += $vars;
 185     }
 186
 187     /**
 188      * Unsets (removes) GET variables. This method supports variable arguments.
 189      *
 190      * @param  string $key Key of the GET variable to remove.
 191      *
 192      * @return void
 193      * @access public
 194      */
 195     function unsetGetVars($key) // ~X2C
 196     {
 197         $keys = func_get_args();
 198         foreach ($keys as $key) {
 199             unset($this->_getVars[$key]);
 200         }
 201     }
 202
 203     /**
 204      * Adds contents to the link.
 205      *
 206      * @param  mixed &$contents Contents to add. Can be an object with a toHtml() method.
 207      *
 208      * @return void
 209      * @access public
 210      */
 211     function addContents($contents) // ~X2C
 212     {
 213         $this->_contents[] = $contents;
 214     }
 215
 216     /**
 217      * @return string
 218      * @access public
 219      */
 220     function getContents() // ~X2C
 221     {
 222         $html = '';
 223         foreach ($this->_contents as $c) {
 224             if (is_object($c) and method_exists($c, 'tohtml')) {
 225                 $html .= $c->toHtml();
 226             } else {
 227                 $html .= htmlentities($c);
 228             }
 229         }
 230         return $html;
 231     }
 232
 233     /**
 234      * @param  mixed $contents New link contents.
 235      *
 236      * @return void
 237      * @access public
 238      */
 239     function setContents($contents) // ~X2C
 240     {
 241         $this->_contents = array($contents);
 242     }
 243
 244     /**
 245      * @param  mixed $contents New link contents.
 246      *
 247      * @return void
 248      * @access public
 249      */
 250     function getCSS()
 251     {
 252         return '/MECON/css/html/link.css';
 253     }
 254
 255 }
 256
 257 ?>