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