Version 5.0.0 beta 1
This commit is contained in:
Neo committed
1 parent
25ddeb65d6
commit
15c7beabc5
6736 files changed
+627902
-497943
No files matched your search
@@ -11,21 +11,34 @@
|
||||
namespace IPS\Helpers\Form;
|
||||
|
||||
/* To prevent PHP errors (extending class does not exist) revealing path */
|
||||
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
||||
|
||||
use DomainException;
|
||||
use InvalidArgumentException;
|
||||
use IPS\Login;
|
||||
use IPS\Member;
|
||||
use IPS\Output;
|
||||
use IPS\Request;
|
||||
use IPS\Session;
|
||||
use IPS\Theme;
|
||||
use function count;
|
||||
use function defined;
|
||||
use function is_array;
|
||||
|
||||
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
||||
{
|
||||
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
|
||||
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stack input class for Form Builder
|
||||
*/
|
||||
class _Stack extends FormAbstract
|
||||
class Stack extends FormAbstract
|
||||
{
|
||||
/**
|
||||
* @brief Default Options
|
||||
*/
|
||||
protected $defaultOptions = array(
|
||||
protected array $defaultOptions = array(
|
||||
'stackFieldType' => 'Text',
|
||||
'removeEmptyValues' => TRUE,
|
||||
'maxItems' => NULL,
|
||||
@@ -35,28 +48,27 @@ class _Stack extends FormAbstract
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param string $name Name
|
||||
* @param mixed $defaultValue Default value
|
||||
* @param bool|NULL $required Required? (NULL for not required, but appears to be so)
|
||||
* @param array $options Type-specific options
|
||||
* @param callback $customValidationCode Custom validation code
|
||||
* @param string $prefix HTML to show before input field
|
||||
* @param string $suffix HTML to show after input field
|
||||
* @param string $id The ID to add to the row
|
||||
* @return void
|
||||
* @param string $name Name
|
||||
* @param mixed $defaultValue Default value
|
||||
* @param bool|null $required Required? (NULL for not required, but appears to be so)
|
||||
* @param array $options Type-specific options
|
||||
* @param callable|null $customValidationCode Custom validation code
|
||||
* @param string|null $prefix HTML to show before input field
|
||||
* @param string|null $suffix HTML to show after input field
|
||||
* @param string|null $id The ID to add to the row
|
||||
*/
|
||||
public function __construct( $name, $defaultValue=NULL, $required=FALSE, $options=array(), $customValidationCode=NULL, $prefix=NULL, $suffix=NULL, $id=NULL )
|
||||
public function __construct( string $name, mixed $defaultValue=NULL, ?bool $required=FALSE, array $options=array(), callable $customValidationCode=NULL, string $prefix=NULL, string $suffix=NULL, string $id=NULL )
|
||||
{
|
||||
parent::__construct( $name, $defaultValue, $required, $options, $customValidationCode, $prefix, $suffix, $id );
|
||||
|
||||
\IPS\Output::i()->jsFiles = array_merge( \IPS\Output::i()->jsFiles, \IPS\Output::i()->js( 'jquery/jquery-ui.js', 'core', 'interface' ) );
|
||||
\IPS\Output::i()->jsFiles = array_merge( \IPS\Output::i()->jsFiles, \IPS\Output::i()->js( 'jquery/jquery-touchpunch.js', 'core', 'interface' ) );
|
||||
\IPS\Output::i()->jsFiles = array_merge( \IPS\Output::i()->jsFiles, \IPS\Output::i()->js( 'jquery/jquery.menuaim.js', 'core', 'interface' ) );
|
||||
Output::i()->jsFiles = array_merge( Output::i()->jsFiles, Output::i()->js( 'jquery/jquery-ui.js', 'core', 'interface' ) );
|
||||
Output::i()->jsFiles = array_merge( Output::i()->jsFiles, Output::i()->js( 'jquery/jquery-touchpunch.js', 'core', 'interface' ) );
|
||||
Output::i()->jsFiles = array_merge( Output::i()->jsFiles, Output::i()->js( 'jquery/jquery.menuaim.js', 'core', 'interface' ) );
|
||||
|
||||
/* Test for javascript disabled add stack */
|
||||
if ( $_SERVER['REQUEST_METHOD'] === 'POST' )
|
||||
{
|
||||
if ( ( \IPS\Request::i()->valueFromArray('form_remove_stack') !== NULL OR isset( \IPS\Request::i()->form_add_stack ) ) and \IPS\Login::compareHashes( (string) \IPS\Session::i()->csrfKey, (string) \IPS\Request::i()->csrfKey ) )
|
||||
if ( ( Request::i()->valueFromArray('form_remove_stack') !== NULL OR isset( Request::i()->form_add_stack ) ) and Login::compareHashes( Session::i()->csrfKey, (string) Request::i()->csrfKey ) )
|
||||
{
|
||||
$this->reloadForm = true;
|
||||
}
|
||||
@@ -68,24 +80,24 @@ class _Stack extends FormAbstract
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function html()
|
||||
public function html(): string
|
||||
{
|
||||
$fields = array();
|
||||
$classType = mb_strpos( $this->options['stackFieldType'], '\\' ) === FALSE ? ( "\\IPS\\Helpers\\Form\\" . $this->options['stackFieldType'] ) : $this->options['stackFieldType'];
|
||||
$remove = \IPS\Request::i()->valueFromArray('form_remove_stack');
|
||||
$remove = Request::i()->valueFromArray('form_remove_stack');
|
||||
|
||||
/* The JS fallback needs a unique key for the field to remove */
|
||||
$remove = ( \is_array( $remove ) ) ? key( $remove ) : null;
|
||||
$remove = ( is_array( $remove ) ) ? key( $remove ) : null;
|
||||
|
||||
if( \count($this->value) )
|
||||
if( count($this->value) )
|
||||
{
|
||||
foreach( $this->value as $k => $v )
|
||||
{
|
||||
$class = ( new $classType( $this->name . '[' . \count($fields) . ']', $v, FALSE, $this->options, $this->customValidationCode, $this->prefix, $this->suffix, $this->htmlId . '_' . \count($fields) ) );
|
||||
$class = ( new $classType( $this->name . '[' . count($fields) . ']', $v, FALSE, $this->options, $this->customValidationCode, $this->prefix, $this->suffix, $this->htmlId . '_' . count($fields) ) );
|
||||
$class->setValue( TRUE );
|
||||
$html = $class->html();
|
||||
|
||||
if( !\IPS\Login::compareHashes( $remove, md5( $html ) ) )
|
||||
if( !Login::compareHashes( $remove, md5( $html ) ) )
|
||||
{
|
||||
$fields[] = $html;
|
||||
}
|
||||
@@ -93,11 +105,11 @@ class _Stack extends FormAbstract
|
||||
}
|
||||
else
|
||||
{
|
||||
$class = ( new $classType( $this->name . '[0]', NULL, FALSE, $this->options, $this->customValidationCode, $this->prefix, $this->suffix, $this->htmlId . '_' . \count($fields) ) );
|
||||
$class = ( new $classType( $this->name . '[0]', NULL, FALSE, $this->options, $this->customValidationCode, $this->prefix, $this->suffix, $this->htmlId . '_' . count($fields) ) );
|
||||
$class->setValue( TRUE );
|
||||
$html = $class->html();
|
||||
|
||||
if( !\IPS\Login::compareHashes( $remove, md5( $html ) ) )
|
||||
if( !Login::compareHashes( $remove, md5( $html ) ) )
|
||||
{
|
||||
$fields[] = $html;
|
||||
}
|
||||
@@ -106,28 +118,28 @@ class _Stack extends FormAbstract
|
||||
/* We hit the add stack button with JS disabled */
|
||||
if ( $this->reloadForm === TRUE AND $remove === NULL )
|
||||
{
|
||||
$class = ( new $classType( $this->name . '[]', NULL, FALSE, $this->options, $this->customValidationCode, $this->prefix, $this->suffix, $this->htmlId . '_' . \count($fields) ) );
|
||||
$class = ( new $classType( $this->name . '[]', NULL, FALSE, $this->options, $this->customValidationCode, $this->prefix, $this->suffix, $this->htmlId . '_' . count($fields) ) );
|
||||
$class->setValue( TRUE );
|
||||
$html = $class->html();
|
||||
$fields[] = $html;
|
||||
}
|
||||
|
||||
return \IPS\Theme::i()->getTemplate( 'forms', 'core', 'global' )->stack( $this->name, $fields, $this->options );
|
||||
return Theme::i()->getTemplate( 'forms', 'core', 'global' )->stack( $this->name, $fields, $this->options );
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Temporarily store if this is the intitial setValue call
|
||||
*/
|
||||
protected $_setValueInitial = NULL;
|
||||
protected mixed $_setValueInitial = NULL;
|
||||
|
||||
/**
|
||||
* Set the value of the element
|
||||
*
|
||||
* @param bool $initial Whether this is the initial call or not. Do not reset default values on subsequent calls.
|
||||
* @param bool $force Set the value even if one was not submitted (done on the final validation when getting values)?
|
||||
* @return void
|
||||
* @return void
|
||||
*/
|
||||
public function setValue( $initial=FALSE, $force=FALSE )
|
||||
public function setValue( bool $initial=FALSE, bool $force=FALSE ): void
|
||||
{
|
||||
$this->_setValueInitial = $initial;
|
||||
|
||||
@@ -141,17 +153,17 @@ class _Stack extends FormAbstract
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function formatValue()
|
||||
public function formatValue(): mixed
|
||||
{
|
||||
$values = array();
|
||||
$classType = mb_strpos( $this->options['stackFieldType'], '\\' ) === FALSE ? ( "\\IPS\\Helpers\\Form\\" . $this->options['stackFieldType'] ) : $this->options['stackFieldType'];
|
||||
$name = $this->name;
|
||||
|
||||
if( mb_substr( $name, 0, 8 ) !== '_new_[x]' and isset( \IPS\Request::i()->$name ) )
|
||||
if( mb_substr( $name, 0, 8 ) !== '_new_[x]' and isset( Request::i()->$name ) )
|
||||
{
|
||||
if( \is_array( \IPS\Request::i()->$name ) AND \count( \IPS\Request::i()->$name ) )
|
||||
if( is_array( Request::i()->$name ) AND count( Request::i()->$name ) )
|
||||
{
|
||||
foreach( \IPS\Request::i()->$name as $k => $v )
|
||||
foreach( Request::i()->$name as $k => $v )
|
||||
{
|
||||
$class = ( new $classType( $this->name . '[' . $k . ']', $v, FALSE, $this->options, $this->customValidationCode, $this->prefix, $this->suffix, $this->htmlId ) );
|
||||
$class->setValue( $this->_setValueInitial, $this->_setValueInitial ? FALSE : TRUE );
|
||||
@@ -161,7 +173,7 @@ class _Stack extends FormAbstract
|
||||
|
||||
return ( $this->options['removeEmptyValues'] ) ? array_filter( $values ) : $values;
|
||||
}
|
||||
else if ( \is_array( $this->value ) AND \count( $this->value ) )
|
||||
else if ( is_array( $this->value ) AND count( $this->value ) )
|
||||
{
|
||||
foreach( $this->value as $k => $v )
|
||||
{
|
||||
@@ -181,24 +193,24 @@ class _Stack extends FormAbstract
|
||||
/**
|
||||
* Validate
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* @throws InvalidArgumentException
|
||||
* @return TRUE
|
||||
*/
|
||||
public function validate()
|
||||
public function validate(): bool
|
||||
{
|
||||
if ( empty( $this->value ) and $this->required )
|
||||
{
|
||||
throw new \InvalidArgumentException('form_required');
|
||||
throw new InvalidArgumentException('form_required');
|
||||
}
|
||||
|
||||
if ( $this->options['maxItems'] !== NULL and \count( $this->value ) > $this->options['maxItems'] )
|
||||
if ( $this->options['maxItems'] !== NULL and count( $this->value ) > $this->options['maxItems'] )
|
||||
{
|
||||
throw new \DomainException( \IPS\Member::loggedIn()->language()->addToStack( 'form_items_max', FALSE, array( 'pluralize' => array( $this->options['maxItems'] ) ) ) );
|
||||
throw new DomainException( Member::loggedIn()->language()->addToStack( 'form_items_max', FALSE, array( 'pluralize' => array( $this->options['maxItems'] ) ) ) );
|
||||
}
|
||||
|
||||
if ( $this->options['minItems'] !== NULL and \count( $this->value ) < $this->options['minItems'] )
|
||||
if ( $this->options['minItems'] !== NULL and count( $this->value ) < $this->options['minItems'] )
|
||||
{
|
||||
throw new \DomainException( \IPS\Member::loggedIn()->language()->addToStack( 'form_items_min', FALSE, array( 'pluralize' => array( $this->options['minItems'] ) ) ) );
|
||||
throw new DomainException( Member::loggedIn()->language()->addToStack( 'form_items_min', FALSE, array( 'pluralize' => array( $this->options['minItems'] ) ) ) );
|
||||
}
|
||||
|
||||
$classType = mb_strpos( $this->options['stackFieldType'], '\\' ) === FALSE ? ( "\\IPS\\Helpers\\Form\\" . $this->options['stackFieldType'] ) : $this->options['stackFieldType'];
|
||||
@@ -209,6 +221,6 @@ class _Stack extends FormAbstract
|
||||
$class->validate();
|
||||
}
|
||||
|
||||
parent::validate();
|
||||
return parent::validate();
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user