<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\View\Widget;
use Cake\View\Form\ContextInterface;
/**
* Input widget class for generating a file upload control.
*
* This class is intended as an internal implementation detail
* of Cake\View\Helper\FormHelper and is not intended for direct use.
*/
class FileWidget implements WidgetInterface
{
/**
* Templates
*
* @var \Cake\View\StringTemplate
*/
protected $_templates;
/**
* Constructor
*
* @param \Cake\View\StringTemplate $templates Templates list.
*/
public function __construct($templates)
{
$this->_templates = $templates;
}
/**
* Render a file upload form widget.
*
* Data supports the following keys:
*
* - `name` - Set the input name.
* - `escape` - Set to false to disable HTML escaping.
*
* All other keys will be converted into HTML attributes.
* Unlike other input objects the `val` property will be specifically
* ignored.
*
* @param array $data The data to build a file input with.
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string HTML elements.
*/
public function render(array $data, ContextInterface $context)
{
$data += [
'name' => '',
'escape' => true,
'templateVars' => [],
];
unset($data['val']);
return $this->_templates->format('file', [
'name' => $data['name'],
'templateVars' => $data['templateVars'],
'attrs' => $this->_templates->formatAttributes(
$data,
['name']
),
]);
}
/**
* {@inheritDoc}
*/
public function secureFields(array $data)
{
$fields = [];
foreach (['name', 'type', 'tmp_name', 'error', 'size'] as $suffix) {
$fields[] = $data['name'] . '[' . $suffix . ']';
}
return $fields;
}
}