formelement.php

Go to the documentation of this file.

<?php
// $Id: formelement.php 1158 2007-12-08 06:24:20Z phppp $
//  ------------------------------------------------------------------------ //
//                XOOPS - PHP Content Management System                      //
//                    Copyright (c) 2000 XOOPS.org                           //
//                       <http://www.xoops.org/>                             //
//  ------------------------------------------------------------------------ //
//  This program is free software; you can redistribute it and/or modify     //
//  it under the terms of the GNU General Public License as published by     //
//  the Free Software Foundation; either version 2 of the License, or        //
//  (at your option) any later version.                                      //
//                                                                           //
//  You may not change or alter any portion of this comment or credits       //
//  of supporting developers from this source code or any supporting         //
//  source code which is considered copyrighted (c) material of the          //
//  original comment or credit authors.                                      //
//                                                                           //
//  This program is distributed in the hope that it will be useful,          //
//  but WITHOUT ANY WARRANTY; without even the implied warranty of           //
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            //
//  GNU General Public License for more details.                             //
//                                                                           //
//  You should have received a copy of the GNU General Public License        //
//  along with this program; if not, write to the Free Software              //
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA //
//  ------------------------------------------------------------------------ //
// Author: Kazumi Ono (AKA onokazu)                                          //
// URL: http://www.myweb.ne.jp/, http://www.xoops.org/, http://jp.xoops.org/ //
// Project: The XOOPS Project                                                //
// ------------------------------------------------------------------------- //
if (!defined('XOOPS_ROOT_PATH')) {
     die("XOOPS root path not defined");
}
class XoopsFormElement {

     var $customValidationCode = array();

     var $_name;

     var $_caption;

     var $_accesskey = '';

     var $_class = array();

     var $_hidden = false;

     var $_extra = array();

     var $_required = false;

     var $_description = "";
     function XoopsFormElement(){
          exit("This class cannot be instantiated!");
     }

     function isContainer()
     {
          return false;
     }

     function setName($name) {
          $this->_name = trim($name);
     }

     function getName($encode = true) {
          if (false != $encode) {
               return str_replace("&amp;", "&", htmlspecialchars($this->_name, ENT_QUOTES));
          }
          return $this->_name;
     }

     function setAccessKey($key) {
          $this->_accesskey = trim($key);
     }
     function getAccessKey() {
          return $this->_accesskey;
     }
     function getAccessString( $str ) {
          $access = $this->getAccessKey();
          if ( !empty($access) && ( false !== ($pos = strpos($str, $access)) ) ) {
               return htmlspecialchars(substr($str, 0, $pos), ENT_QUOTES) . '<span style="text-decoration:underline">' . htmlspecialchars(substr($str, $pos, 1), ENT_QUOTES) . '</span>' . htmlspecialchars(substr($str, $pos+1), ENT_QUOTES);
          }
          return htmlspecialchars($str, ENT_QUOTES);
     }

     function setClass($class) {
          $class = trim($class);
          if ( !empty($class) ) {
            $this->_class[] = $class;
          }
     }
     function getClass() {
     if( empty($this->_class) ) return '';
     $class = array();
     foreach ($this->_class as $class) {
          $class[] = htmlspecialchars($class, ENT_QUOTES);
     }
          return implode(" ", $class);
     }

     function setCaption($caption) {
          $this->_caption = trim($caption);
     }

     function getCaption($encode = false) {
          return $encode ? htmlspecialchars($this->_caption, ENT_QUOTES) : $this->_caption;
     }

     function setDescription($description) {
          $this->_description = trim($description);
     }

     function getDescription($encode = false) {
          return $encode ? htmlspecialchars($this->_description, ENT_QUOTES) : $this->_description;
     }

     function setHidden() {
          $this->_hidden = true;
     }

     function isHidden() {
          return $this->_hidden;
     }

     function isRequired() {
          return $this->_required;
     }

     function setExtra($extra, $replace = false) {
          if ( $replace) {
               $this->_extra = array( trim($extra) );
          } else {
               $this->_extra[] = trim($extra);
          }
          return $this->_extra;
     }

     function getExtra($encode = false) {
     if (!$encode) {
          return implode(' ', $this->_extra);
     }
     $value = array();
     foreach ($this->_extra as $val) {
              $value[] = str_replace('>', '&gt;', str_replace('<', '&lt;', $val));
     }
     return empty($value) ? "" : " ".implode(' ', $value);
     }

     function renderValidationJS() {
     // render custom validation code if any
          if ( !empty( $this->customValidationCode ) ) {
               return implode( "\n", $this->customValidationCode );
          // generate validation code if required 
          } elseif ($this->isRequired()) {
               $eltname    = $this->getName();
               $eltcaption = $this->getCaption();
               $eltmsg = empty($eltcaption) ? sprintf( _FORM_ENTER, $eltname ) : sprintf( _FORM_ENTER, $eltcaption );
               $eltmsg = str_replace('"', '\"', stripslashes( $eltmsg ) );
               return "if ( myform.{$eltname}.value == \"\" ) { window.alert(\"{$eltmsg}\"); myform.{$eltname}.focus(); return false; }";
          }
          return ''; 
     }

     function render(){
     }
}
?>

---