* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Form\Field;
// phpcs:disable PSR1.Files.SideEffects
\defined('JPATH_PLATFORM') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* The Field to load the form inside current form
*
* @since 4.0.0
*/
class AccessiblemediaField extends SubformField
{
/**
* The form field type.
*
* @var string
* @since 4.0.0
*/
protected $type = 'Accessiblemedia';
/**
* The preview.
*
* @var string
* @since 4.0.0
*/
protected $preview;
/**
* The directory.
*
* @var string
* @since 4.0.0
*/
protected $directory;
/**
* The previewWidth.
*
* @var integer
* @since 4.0.0
*/
protected $previewWidth;
/**
* The previewHeight.
*
* @var integer
* @since 4.0.0
*/
protected $previewHeight;
/**
* Layout to render
*
* @var string
* @since 4.0.0
*/
protected $layout;
/**
* Method to get certain otherwise inaccessible properties from the form field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 4.0.0
*/
public function __get($name)
{
switch ($name) {
case 'directory':
case 'preview':
case 'previewHeight':
case 'previewWidth':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 4.0.0
*/
public function __set($name, $value)
{
switch ($name) {
case 'directory':
case 'preview':
$this->$name = (string) $value;
break;
case 'previewHeight':
case 'previewWidth':
$this->$name = (int) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a Form object to the field.
*
* @param \SimpleXMLElement $element The SimpleXMLElement object representing the tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control value.
*
* @return boolean True on success.
*
* @since 4.0.0
*/
public function setup(\SimpleXMLElement $element, $value, $group = null)
{
/**
* When you have subforms which are not repeatable (i.e. a subform custom field with the
* repeat attribute set to 0) you get an array here since the data comes from decoding the
* JSON into an associative array, including the media subfield's data.
*
* However, this method expects an object or a string, not an array. Typecasting the array
* to an object solves the data format discrepancy.
*/
$value = is_array($value) ? (object) $value : $value;
/**
* If the value is not a string, it is
* most likely within a custom field of type subform
* and the value is a stdClass with properties
* imagefile and alt_text. So it is fine.
*/
if (\is_string($value)) {
json_decode($value);
// Check if value is a valid JSON string.
if ($value !== '' && json_last_error() !== JSON_ERROR_NONE) {
/**
* If the value is not empty and is not a valid JSON string,
* it is most likely a custom field created in Joomla 3 and
* the value is a string that contains the file name.
*/
if (is_file(JPATH_ROOT . '/' . $value)) {
$value = '{"imagefile":"' . $value . '","alt_text":""}';
} else {
$value = '';
}
}
} elseif (
!is_object($value)
|| !property_exists($value, 'imagefile')
|| !property_exists($value, 'alt_text')
) {
return false;
}
if (!parent::setup($element, $value, $group)) {
return false;
}
$this->directory = (string) $this->element['directory'];
$this->preview = (string) $this->element['preview'];
$this->previewHeight = isset($this->element['preview_height']) ? (int) $this->element['preview_height'] : 200;
$this->previewWidth = isset($this->element['preview_width']) ? (int) $this->element['preview_width'] : 200;
$xml = <<
XML;
$this->formsource = $xml;
$this->layout = 'joomla.form.field.media.accessiblemedia';
return true;
}
}