/usr/share/php/Horde/Form/Variable.php is in php-horde-form 2.0.8-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 | <?php
/**
* This class represents a single form variable that may be rendered as one or
* more form fields.
*
* @author Robert E. Coyle <robertecoyle@hotmail.com>
* @package Form
*/
class Horde_Form_Variable {
/**
* The form instance this variable is assigned to.
*
* @var Horde_Form
*/
var $form;
/**
* A short description of this variable's purpose.
*
* @var string
*/
var $humanName;
/**
* The internally used name.
*
* @var string
*/
var $varName;
/**
* A {@link Horde_Form_Type} instance.
*
* @var Horde_Form_Type
*/
var $type;
/**
* Whether this is a required variable.
*
* @var boolean
*/
var $required;
/**
* Whether this is a readonly variable.
*
* @var boolean
*/
var $readonly;
/**
* A long description of the variable's purpose, special instructions, etc.
*
* @var string
*/
var $description;
/**
* The variable help text.
*
* @var string
*/
var $help;
/**
* Whether this is an array variable.
*
* @var boolean
*/
var $_arrayVal;
/**
* The default value.
*
* @var mixed
*/
var $_defValue = null;
/**
* A {@link Horde_Form_Action} instance.
*
* @var Horde_Form_Action
*/
var $_action;
/**
* Whether this variable is disabled.
*
* @var boolean
*/
var $_disabled = false;
/**
* TODO
*
* @var boolean
*/
var $_autofilled = false;
/**
* Whether this is a hidden variable.
*
* @var boolean
*/
var $_hidden = false;
/**
* TODO
*
* @var array
*/
var $_options = array();
/**
* Variable constructor.
*
* @param string $humanName A short description of the variable's
* purpose.
* @param string $varName The internally used name.
* @param Horde_Form_Type $type A {@link Horde_Form_Type} instance.
* @param boolean $required Whether this is a required variable.
* @param boolean $readonly Whether this is a readonly variable.
* @param string $description A long description of the variable's
* purpose, special instructions, etc.
*/
function Horde_Form_Variable($humanName, $varName, &$type, $required,
$readonly = false, $description = null)
{
$this->humanName = $humanName;
$this->varName = $varName;
$this->type = &$type;
$this->required = $required;
$this->readonly = $readonly;
$this->description = $description;
$this->_arrayVal = (strpos($varName, '[]') !== false);
}
/**
* Assign this variable to the specified form.
*
* @param Horde_Form $form The form instance to assign this variable to.
*/
function setFormOb(&$form)
{
$this->form = &$form;
}
/**
* Sets a default value for this variable.
*
* @param mixed $value A variable value.
*/
function setDefault($value)
{
$this->_defValue = $value;
}
/**
* Returns this variable's default value.
*
* @return mixed This variable's default value.
*/
function getDefault()
{
return $this->_defValue;
}
/**
* Assigns an action to this variable.
*
* Example:
* <code>
* $v = &$form->addVariable('My Variable', 'var1', 'text', false);
* $v->setAction(Horde_Form_Action::factory('submit'));
* </code>
*
* @param Horde_Form_Action $action A {@link Horde_Form_Action} instance.
*/
function setAction($action)
{
$this->_action = $action;
}
/**
* Returns whether this variable has an attached action.
*
* @return boolean True if this variable has an attached action.
*/
function hasAction()
{
return !is_null($this->_action);
}
/**
* Makes this a hidden variable.
*/
function hide()
{
$this->_hidden = true;
}
/**
* Returns whether this is a hidden variable.
*
* @return boolean True if this a hidden variable.
*/
function isHidden()
{
return $this->_hidden;
}
/**
* Disables this variable.
*/
function disable()
{
$this->_disabled = true;
}
/**
* Returns whether this variable is disabled.
*
* @return boolean True if this variable is disabled.
*/
function isDisabled()
{
return $this->_disabled;
}
/**
* Return the short description of this variable.
*
* @return string A short description
*/
function getHumanName()
{
return $this->humanName;
}
/**
* Returns the internally used variable name.
*
* @return string This variable's internal name.
*/
function getVarName()
{
return $this->varName;
}
/**
* Returns this variable's type.
*
* @return Horde_Form_Type This variable's {@link Horde_Form_Type}
* instance.
*/
function &getType()
{
return $this->type;
}
/**
* Returns the name of this variable's type.
*
* @return string This variable's {@link Horde_Form_Type} name.
*/
function getTypeName()
{
return $this->type->getTypeName();
}
/**
* Returns whether this is a required variable.
*
* @return boolean True if this is a required variable.
*/
function isRequired()
{
return $this->required;
}
/**
* Returns whether this is a readonly variable.
*
* @return boolean True if this a readonly variable.
*/
function isReadonly()
{
return $this->readonly;
}
/**
* Returns the possible values of this variable.
*
* @return array The possible values of this variable or null.
*/
function getValues()
{
return $this->type->getValues();
}
/**
* Returns whether this variable has a long description.
*
* @return boolean True if this variable has a long description.
*/
function hasDescription()
{
return !empty($this->description);
}
/**
* Returns this variable's long description.
*
* @return string This variable's long description.
*/
function getDescription()
{
return $this->description;
}
/**
* Returns whether this is an array variable.
*
* @return boolean True if this an array variable.
*/
function isArrayVal()
{
return $this->_arrayVal;
}
/**
* Returns whether this variable is to upload a file.
*
* @return boolean True if variable is to upload a file.
*/
function isUpload()
{
return ($this->type->getTypeName() == 'file');
}
/**
* Assigns a help text to this variable.
*
* @param string $help The variable help text.
*/
function setHelp($help)
{
$this->form->_help = true;
$this->help = $help;
}
/**
* Returns whether this variable has some help text assigned.
*
* @return boolean True if this variable has a help text.
*/
function hasHelp()
{
return !empty($this->help);
}
/**
* Returns the help text of this variable.
*
* @return string This variable's help text.
*/
function getHelp()
{
return $this->help;
}
/**
* Sets a variable option.
*
* @param string $option The option name.
* @param mixed $val The option's value.
*/
function setOption($option, $val)
{
$this->_options[$option] = $val;
}
/**
* Returns a variable option's value.
*
* @param string $option The option name.
*
* @return mixed The option's value.
*/
function getOption($option)
{
return isset($this->_options[$option]) ? $this->_options[$option] : null;
}
/**
* Processes the submitted value of this variable according to the rules of
* the variable type.
*
* @param Variables $vars The {@link Variables} instance of the submitted
* form.
* @param mixed $info A variable passed by reference that will be
* assigned the processed value of the submitted
* variable value.
*
* @return mixed Depending on the variable type.
*/
function getInfo(&$vars, &$info)
{
return $this->type->getInfo($vars, $this, $info);
}
/**
* Returns whether this variable if it had the "trackchange" option set
* has actually been changed.
*
* @param Variables $vars The {@link Variables} instance of the submitted
* form.
*
* @return boolean Null if this variable doesn't have the "trackchange"
* option set or the form wasn't submitted yet. A boolean
* indicating whether the variable was changed otherwise.
*/
function wasChanged(&$vars)
{
if (!$this->getOption('trackchange')) {
return null;
}
$old = $vars->get('__old_' . $this->getVarName());
if (is_null($old)) {
return null;
}
return $old != $vars->get($this->getVarName());
}
/**
* Validates this variable.
*
* @param Variables $vars The {@link Variables} instance of the submitted
* form.
* @param string $message A variable passed by reference that will be
* assigned a descriptive error message if
* validation failed.
*
* @return boolean True if the variable validated.
*/
function validate(&$vars, &$message)
{
if ($this->_arrayVal) {
$vals = $this->getValue($vars);
if (!is_array($vals)) {
if ($this->required) {
$message = Horde_Form_Translation::t("This field is required.");
return false;
} else {
return true;
}
}
foreach ($vals as $i => $value) {
if ($value === null && $this->required) {
$message = Horde_Form_Translation::t("This field is required.");
return false;
} else {
if (!$this->type->isValid($this, $vars, $value, $message)) {
return false;
}
}
}
} else {
$value = $this->getValue($vars);
return $this->type->isValid($this, $vars, $value, $message);
}
return true;
}
/**
* Returns the submitted or default value of this variable.
* If an action is attached to this variable, the value will get passed to
* the action object.
*
* @param Variables $vars The {@link Variables} instance of the submitted
* form.
* @param integer $index If the variable is an array variable, this
* specifies the array element to return.
*
* @return mixed The variable or element value.
*/
function getValue(&$vars, $index = null)
{
if ($this->_arrayVal) {
$name = str_replace('[]', '', $this->varName);
} else {
$name = $this->varName;
}
$value = $vars->getExists($name, $wasset);
if (!$wasset) {
$value = $this->getDefault();
}
if ($this->_arrayVal && !is_null($index)) {
if (!$wasset && !is_array($value)) {
$return = $value;
} else {
$return = isset($value[$index]) ? $value[$index] : null;
}
} else {
$return = $value;
}
if ($this->hasAction()) {
$this->_action->setValues($vars, $return, $this->_arrayVal);
}
return $return;
}
}
|