silverstripe-framework/Forms/TextField.php
Damian Mooyman 8dd644d25d
API Namespace all classes
Namespace all templates
Move difflib and BBCodeParser2 to thirdparty
Remove deprecated API marked for removal in 4.0
2016-09-08 10:23:17 +12:00

112 lines
2.0 KiB
PHP

<?php
namespace SilverStripe\Forms;
use SilverStripe\Dev\Deprecation;
/**
* Text input field.
*/
class TextField extends FormField {
/**
* @var int
*/
protected $maxLength;
protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_TEXT;
/**
* Returns an input field.
*
* @param string $name
* @param null|string $title
* @param string $value
* @param null|int $maxLength
* @param null|Form $form
*/
public function __construct($name, $title = null, $value = '', $maxLength = null, $form = null) {
if($maxLength) {
$this->setMaxLength($maxLength);
}
if($form) {
$this->setForm($form);
}
parent::__construct($name, $title, $value);
}
/**
* @param int $maxLength
*
* @return static
*/
public function setMaxLength($maxLength) {
$this->maxLength = $maxLength;
return $this;
}
/**
* @return null|int
*/
public function getMaxLength() {
return $this->maxLength;
}
/**
* @return array
*/
public function getAttributes() {
$maxLength = $this->getMaxLength();
$attributes = array();
if($maxLength) {
$attributes['maxLength'] = $maxLength;
$attributes['size'] = min($maxLength, 30);
}
return array_merge(
parent::getAttributes(),
$attributes
);
}
/**
* @return string
*/
public function InternallyLabelledField() {
Deprecation::notice('4.0', 'Please use ->setValue() instead');
if(!$this->value) {
$this->value = $this->Title();
}
return $this->Field();
}
/**
* Validate this field
*
* @param Validator $validator
* @return bool
*/
public function validate($validator) {
if(!is_null($this->maxLength) && mb_strlen($this->value) > $this->maxLength) {
$validator->validationError(
$this->name,
_t(
'TextField.VALIDATEMAXLENGTH',
'The value for {name} must not exceed {maxLength} characters in length',
array('name' => $this->getName(), 'maxLength' => $this->maxLength)
),
"validation"
);
return false;
}
return true;
}
}