Source for file Widget.php

Documentation is available at Widget.php

  1. <?php
  2.     /**
  3.      * The base form widget class
  4.      * @copyright Copyright (c) 2006,2007 Mirchev Ideas Ltd. All rights reserved.
  5.      * @package MIPHPF
  6.      */
  7.     
  8.     /**
  9.      * Base class form web form widget
  10.      * One web form widget can handle single data item, or multiple data items
  11.      * @copyright Copyright (c) 2006,2007 Mirchev Ideas Ltd. All rights reserved.
  12.      * @package MIPHPF
  13.      */
  14.     class miWidget {
  15.         /**
  16.          * A reference to the web form that contains this widget
  17.          */
  18.         protected $_webForm;
  19.         
  20.         /**
  21.          * Contains the form widget properties
  22.          */
  23.         protected $_properties;
  24.         
  25.         /**
  26.          * Construct miWidget object
  27.          * 
  28.          * @access public
  29.          * @param miWebForm $webForm 
  30.          * @param array $properties widget properties (optional)
  31.          */
  32.         public function __construct(miWebForm &$webForm, $properties = array())
  33.         {
  34.             $this->_webForm = $webForm;
  35.             $this->_properties = $properties;
  36.         }
  37.         
  38.         /**
  39.          * Returns the widget properties
  40.          *
  41.          * @access public
  42.          * @return array 
  43.          */
  44.         public function getProperties()
  45.         {
  46.             return $this->_properties;
  47.         }
  48.         
  49.         /**
  50.          * Sets a property value
  51.          *
  52.          * @param string $name 
  53.          * @param mixed $value 
  54.          */
  55.         public function setProperty($name, $value)
  56.         {
  57.             $this->_properties[$name] = $value;
  58.         }
  59.         
  60.         /**
  61.          * Returns array with template variables to be displayed for non-editable control
  62.          * 
  63.          * @access public
  64.          * @return array 
  65.          */
  66.         public function getControl()
  67.         {
  68.             return array();
  69.         }
  70.         
  71.         /**
  72.          * Returns array with template variables to be displayed for editable control
  73.          * 
  74.          * @access public
  75.          * @return array 
  76.          */
  77.         public function getEditableControl()
  78.         {
  79.             return array();
  80.         }
  81.         
  82.         /**
  83.          * Process the form submissions and returns the data
  84.          * 
  85.          * @access public
  86.          * @return array 
  87.          */
  88.         public function getData()
  89.         {
  90.             return array();
  91.         }
  92.         
  93.         /**
  94.          * Validates the submitted data for this widget
  95.          * Called upon form submission
  96.          * 
  97.          * @access public
  98.          * @param miWebFormErrorsHandler 
  99.          */
  100.         public function validateData(miWebFormErrorsHandler &$errors)
  101.         {
  102.         }
  103.     }
  104. ?>

Documentation generated on Thu, 08 May 2008 16:58:02 +0300 by phpDocumentor 1.4.1