protected $_action;
/**
- * the renderer used for this form
+ * The renderer used for this form
*
* @var object
*/
protected $_dateFields = array();
/**
- * cache the smarty template for efficiency reasons
+ * Cache the smarty template for efficiency reasons
*
* @var CRM_Core_Smarty
*/
public $controller;
/**
- * constants for attributes for various form elements
+ * Constants for attributes for various form elements
* attempt to standardize on the number of variations that we
* use of the below form elements
*
/**
* Add one or more css classes to the form
- * @param $className
+ * @param string $className
*/
public function addClass($className) {
$classes = $this->getAttribute('class');
}
/**
- * register all the standard rules that most forms potentially use
+ * Register all the standard rules that most forms potentially use
*
* @return void
* @access private
}
/**
- * getter function for Name
+ * Getter function for Name
*
* @return string
* @access public
}
/**
- * getter function for State
+ * Getter function for State
*
* @return object
* @access public
}
/**
- * getter function for StateType
+ * Getter function for StateType
*
* @return int
* @access public
}
/**
- * getter function for title. Should be over-ridden by derived class
+ * Getter function for title. Should be over-ridden by derived class
*
* @return string
* @access public
}
/**
- * setter function for title.
+ * Setter function for title.
*
* @param string $title the title of the form
*
}
/**
- * getter function for link.
+ * Getter function for link.
*
* @return string
* @access public
}
/**
- * boolean function to determine if this is a one form page
+ * Boolean function to determine if this is a one form page
*
* @return boolean
* @access public
}
/**
- * getter function for Form Action
+ * Getter function for Form Action
*
* @return string
* @access public
}
/**
- * setter function for Form Action
+ * Setter function for Form Action
*
* @param string
*
}
/**
- * render form and return contents
+ * Render form and return contents
*
* @return string
* @access public
}
/**
- * getter function for renderer. If renderer is not set
+ * Getter function for renderer. If renderer is not set
* create one and initialize it
*
* @return object
}
/**
- * getter for action
+ * Getter for action
*
* @return int
* @access public
}
/**
- * setter for action
+ * Setter for action
*
* @param int $action the mode we want to set the form
*
}
/**
- * assign value to name in template
+ * Assign value to name in template
*
* @param string $var name of variable
* @param mixed $value value of variable
}
/**
- * assign value to name in template by reference
+ * Assign value to name in template by reference
*
* @param string $var name of variable
* @param mixed $value value of varaible
}
/**
- * appends values to template variables
+ * Appends values to template variables
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value the value to append
}
/**
- * @param $name
+ * @param string $name
* @param $title
* @param $values
* @param array $attributes
}
/**
- * @param $id
+ * @param int $id
* @param $title
* @param bool $allowClear
* @param null $required
}
/**
- * @param $id
+ * @param int $id
* @param $title
* @param $values
* @param null $other
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
}
/**
- * @param $name
+ * @param string $name
* @param string $from
* @param string $to
* @param string $label
}
/**
- * @param $name
+ * @param string $name
* @param $label
* @param $attributes
* @param bool $forceTextarea
}
/**
- * @param $id
+ * @param int $id
* @param $title
* @param null $required
* @param null $extra
}
/**
- * @param $name
+ * @param string $name
* @param $label
* @param $options
* @param $attributes
}
/**
- * add a currency and money element to the form
+ * Add a currency and money element to the form
*/
function addMoney($name,
$label,
}
/**
- * add currency element to the form
+ * Add currency element to the form
*/
function addCurrency($name = 'currency',
$label = NULL,
}
/**
- * add autoselector field -if user has permission to view contacts
+ * Add autoselector field -if user has permission to view contacts
* If adding this to a form you also need to add to the tpl e.g
*
* {if !empty($selectable)}