API Remove use of getEscapedTitle() and deprecated for future removal. Use $Title directly instead.

This commit is contained in:
Robbie Averill 2018-03-21 14:56:16 +13:00
parent 5b68e7bb58
commit 100be38ab1
16 changed files with 24 additions and 26 deletions

View File

@ -635,6 +635,8 @@ class EditableFormField extends DataObject
/** /**
* Returns the Title for rendering in the front-end (with XML values escaped) * Returns the Title for rendering in the front-end (with XML values escaped)
* *
* @deprecated 5.0..6.0 XML is automatically escaped in templates from SS 4 onwards. Please use $Title directly.
*
* @return string * @return string
*/ */
public function getEscapedTitle() public function getEscapedTitle()

View File

@ -44,7 +44,7 @@ class EditableCheckbox extends EditableFormField
public function getFormField() public function getFormField()
{ {
$field = CheckboxField::create($this->Name, $this->EscapedTitle, $this->CheckedDefault) $field = CheckboxField::create($this->Name, $this->Title, $this->CheckedDefault)
->setFieldHolderTemplate(__CLASS__ . '_holder') ->setFieldHolderTemplate(__CLASS__ . '_holder')
->setTemplate(__CLASS__); ->setTemplate(__CLASS__);

View File

@ -25,7 +25,7 @@ class EditableCheckboxGroupField extends EditableMultipleOptionField
public function getFormField() public function getFormField()
{ {
$field = UserFormsCheckboxSetField::create($this->Name, $this->EscapedTitle, $this->getOptionsMap()) $field = UserFormsCheckboxSetField::create($this->Name, $this->Title, $this->getOptionsMap())
->setFieldHolderTemplate(EditableMultipleOptionField::class . '_holder') ->setFieldHolderTemplate(EditableMultipleOptionField::class . '_holder')
->setTemplate(UserFormsCheckboxSetField::class); ->setTemplate(UserFormsCheckboxSetField::class);

View File

@ -35,7 +35,7 @@ class EditableCountryDropdownField extends EditableFormField
public function getFormField() public function getFormField()
{ {
$field = DropdownField::create($this->Name, $this->EscapedTitle) $field = DropdownField::create($this->Name, $this->Title)
->setSource(i18n::getData()->getCountries()) ->setSource(i18n::getData()->getCountries())
->setFieldHolderTemplate(EditableFormField::class . '_holder') ->setFieldHolderTemplate(EditableFormField::class . '_holder')
->setTemplate(EditableDropdown::class); ->setTemplate(EditableDropdown::class);

View File

@ -58,8 +58,8 @@ class EditableDateField extends EditableFormField
? DBDatetime::now()->Format('Y-m-d') ? DBDatetime::now()->Format('Y-m-d')
: $this->Default; : $this->Default;
$field = FormField::create($this->Name, $this->EscapedTitle, $defaultValue) $field = FormField::create($this->Name, $this->Title, $defaultValue)
->setFieldHolderTemplate('UserFormsField_holder') ->setFieldHolderTemplate(EditableFormField::class . '_holder')
->setTemplate(EditableFormField::class); ->setTemplate(EditableFormField::class);
$this->doUpdateFormField($field); $this->doUpdateFormField($field);

View File

@ -60,7 +60,7 @@ class EditableDropdown extends EditableMultipleOptionField
*/ */
public function getFormField() public function getFormField()
{ {
$field = DropdownField::create($this->Name, $this->EscapedTitle, $this->getOptionsMap()) $field = DropdownField::create($this->Name, $this->Title, $this->getOptionsMap())
->setFieldHolderTemplate(EditableFormField::class . '_holder') ->setFieldHolderTemplate(EditableFormField::class . '_holder')
->setTemplate(__CLASS__); ->setTemplate(__CLASS__);

View File

@ -30,8 +30,8 @@ class EditableEmailField extends EditableFormField
public function getFormField() public function getFormField()
{ {
$field = EmailField::create($this->Name, $this->EscapedTitle, $this->Default) $field = EmailField::create($this->Name, $this->Title, $this->Default)
->setFieldHolderTemplate('UserFormsField_holder') ->setFieldHolderTemplate(EditableFormField::class . '_holder')
->setTemplate(EditableFormField::class); ->setTemplate(EditableFormField::class);
$this->doUpdateFormField($field); $this->doUpdateFormField($field);

View File

@ -74,7 +74,7 @@ class EditableFieldGroup extends EditableFormField
public function getFormField() public function getFormField()
{ {
$field = UserFormsGroupField::create() $field = UserFormsGroupField::create()
->setTitle($this->EscapedTitle ?: false) ->setTitle($this->Title ?: false)
->setName($this->Name); ->setName($this->Name);
$this->doUpdateFormField($field); $this->doUpdateFormField($field);
return $field; return $field;

View File

@ -97,11 +97,11 @@ class EditableFileField extends EditableFormField
public function getFormField() public function getFormField()
{ {
$field = FileField::create($this->Name, $this->EscapedTitle) $field = FileField::create($this->Name, $this->Title)
->setFieldHolderTemplate('UserFormsField_holder') ->setFieldHolderTemplate(EditableFormField::class . '_holder')
->setTemplate(__CLASS__); ->setTemplate(__CLASS__);
$field->setFieldHolderTemplate('UserFormsField_holder') $field->setFieldHolderTemplate(EditableFormField::class . '_holder')
->setTemplate(__CLASS__); ->setTemplate(__CLASS__);
$field->getValidator()->setAllowedExtensions( $field->getValidator()->setAllowedExtensions(

View File

@ -68,7 +68,7 @@ class EditableFormHeading extends EditableFormField
public function getFormField() public function getFormField()
{ {
$labelField = HeaderField::create('userforms-header', $this->EscapedTitle) $labelField = HeaderField::create('userforms-header', $this->Title)
->setHeadingLevel($this->Level); ->setHeadingLevel($this->Level);
$labelField->addExtraClass('FormHeading'); $labelField->addExtraClass('FormHeading');
$labelField->setAttribute('data-id', $this->Name); $labelField->setAttribute('data-id', $this->Name);
@ -80,8 +80,7 @@ class EditableFormHeading extends EditableFormField
{ {
// set the right title on this field // set the right title on this field
if ($this->RightTitle) { if ($this->RightTitle) {
// Since this field expects raw html, safely escape the user data prior $field->setRightTitle($this->RightTitle);
$field->setRightTitle(Convert::raw2xml($this->RightTitle));
} }
// if this field has an extra class // if this field has an extra class

View File

@ -46,7 +46,7 @@ class EditableFormStep extends EditableFormField
{ {
$field = UserFormsStepField::create() $field = UserFormsStepField::create()
->setName($this->Name) ->setName($this->Name)
->setTitle($this->EscapedTitle); ->setTitle($this->Title);
$this->doUpdateFormField($field); $this->doUpdateFormField($field);
return $field; return $field;
} }

View File

@ -54,7 +54,7 @@ class EditableMemberListField extends EditableFormField
} }
$members = Member::map_in_groups($this->GroupID); $members = Member::map_in_groups($this->GroupID);
$field = DropdownField::create($this->Name, $this->EscapedTitle, $members); $field = DropdownField::create($this->Name, $this->Title, $members);
$this->doUpdateFormField($field); $this->doUpdateFormField($field);
return $field; return $field;
} }

View File

@ -41,7 +41,7 @@ class EditableNumericField extends EditableFormField
*/ */
public function getFormField() public function getFormField()
{ {
$field = NumericField::create($this->Name, $this->EscapedTitle, $this->Default) $field = NumericField::create($this->Name, $this->Title, $this->Default)
->setFieldHolderTemplate(EditableFormField::class . '_holder') ->setFieldHolderTemplate(EditableFormField::class . '_holder')
->setTemplate(EditableFormField::class) ->setTemplate(EditableFormField::class)
->addExtraClass('number'); ->addExtraClass('number');

View File

@ -2,11 +2,8 @@
namespace SilverStripe\UserForms\Model\EditableFormField; namespace SilverStripe\UserForms\Model\EditableFormField;
use SilverStripe\CMS\Controllers\CMSMain;
use SilverStripe\Control\Controller;
use SilverStripe\Core\Convert; use SilverStripe\Core\Convert;
use SilverStripe\ORM\DataObject; use SilverStripe\ORM\DataObject;
use SilverStripe\UserForms\Model\EditableFormField\EditableMultipleOptionField;
use SilverStripe\Versioned\Versioned; use SilverStripe\Versioned\Versioned;
/** /**
@ -66,12 +63,12 @@ class EditableOption extends DataObject
} }
/** /**
* @deprecated 5.0 Use "$Title.XML" in templates instead * @deprecated 5.0..6.0 Use "$Title" in templates instead
* @return string * @return string
*/ */
public function getEscapedTitle() public function getEscapedTitle()
{ {
return Convert::raw2att($this->Title); return Convert::raw2xml($this->Title);
} }
/** /**

View File

@ -35,7 +35,7 @@ class EditableRadioField extends EditableMultipleOptionField
public function getFormField() public function getFormField()
{ {
$field = OptionsetField::create($this->Name, $this->EscapedTitle, $this->getOptionsMap()) $field = OptionsetField::create($this->Name, $this->Title, $this->getOptionsMap())
->setFieldHolderTemplate(EditableMultipleOptionField::class . '_holder') ->setFieldHolderTemplate(EditableMultipleOptionField::class . '_holder')
->setTemplate('SilverStripe\\UserForms\\FormField\\UserFormsOptionSetField'); ->setTemplate('SilverStripe\\UserForms\\FormField\\UserFormsOptionSetField');

View File

@ -128,12 +128,12 @@ class EditableTextField extends EditableFormField
public function getFormField() public function getFormField()
{ {
if ($this->Rows > 1) { if ($this->Rows > 1) {
$field = TextareaField::create($this->Name, $this->EscapedTitle, $this->Default) $field = TextareaField::create($this->Name, $this->Title, $this->Default)
->setFieldHolderTemplate(EditableFormField::class . '_holder') ->setFieldHolderTemplate(EditableFormField::class . '_holder')
->setTemplate(str_replace('EditableTextField', 'EditableTextareaField', __CLASS__)) ->setTemplate(str_replace('EditableTextField', 'EditableTextareaField', __CLASS__))
->setRows($this->Rows); ->setRows($this->Rows);
} else { } else {
$field = TextField::create($this->Name, $this->EscapedTitle, $this->Default) $field = TextField::create($this->Name, $this->Title, $this->Default)
->setFieldHolderTemplate(EditableFormField::class . '_holder') ->setFieldHolderTemplate(EditableFormField::class . '_holder')
->setTemplate(EditableFormField::class); ->setTemplate(EditableFormField::class);
} }