sydney/IPB
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Version 5.0.0 beta 1

Browse Source
This commit is contained in:
Neo committed 2025-12-19 16:27:35 -08:00
1 parent 25ddeb65d6
commit 15c7beabc5
6736 files changed
+627902 -497943
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

system/Helpers/Form/Translatable.php
+44 -34
View File
@@ -11,16 +11,27 @@
namespace IPS\Helpers\Form;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use InvalidArgumentException;
use IPS\Db;
use IPS\Lang;
use IPS\Output;
use IPS\Theme;
use ValueError;
use function defined;
use function is_array;
use function is_string;
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;
}
/**
* Translatable text input class for Form Builder
*/
class _Translatable extends FormAbstract
class Translatable extends FormAbstract
{
/**
* @brief Default Options
@@ -34,7 +45,7 @@ class _Translatable extends FormAbstract
);
* @endcode
*/
protected $defaultOptions = array(
protected array $defaultOptions = array(
'key' => NULL,
'editor' => NULL,
'textArea' => FALSE,
@@ -45,22 +56,21 @@ class _Translatable extends FormAbstract
/**
* @brief Editors
*/
protected $editors = NULL;
protected ?array $editors = NULL;
/**
* 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 )
{
/* Call parent constructor */
parent::__construct( $name, $defaultValue, $required, $options, $customValidationCode, $prefix, $suffix, $id );
@@ -71,18 +81,18 @@ class _Translatable extends FormAbstract
$values = array();
if ( $this->options['key'] )
{
foreach( \IPS\Db::i()->select( '*', 'core_sys_lang_words', array( 'word_key=?', $this->options['key'] ) )->setKeyField('lang_id') as $k => $v )
foreach( Db::i()->select( '*', 'core_sys_lang_words', array( 'word_key=?', $this->options['key'] ) )->setKeyField('lang_id') as $k => $v )
{
$v = $v['word_custom'];
$v = $v['word_custom'] ?? $v['word_default'];
if ( $v or !isset( $values[ $k ] ) )
{
if ( \is_array( $this->options['sprintf'] ) )
if ( is_array( $this->options['sprintf'] ) )
{
try
{
$values[ $k ] = vsprintf( $v, $this->options[ 'sprintf' ] );
}
catch ( \ValueError $e )
catch ( ValueError $e )
{
/* Note in pre-PHP8, vsprintf() returns FALSE */
$values[ $k ] = FALSE;
@@ -98,10 +108,10 @@ class _Translatable extends FormAbstract
$this->value = $values;
}
elseif ( \is_string( $this->value ) )
elseif ( is_string( $this->value ) )
{
$values = array();
foreach ( \IPS\Lang::getEnabledLanguages() as $lang )
foreach ( Lang::getEnabledLanguages() as $lang )
{
$values[ $lang->id ] = $this->value;
}
@@ -109,26 +119,26 @@ class _Translatable extends FormAbstract
}
/* Add flags.css */
\IPS\Output::i()->cssFiles = array_merge( \IPS\Output::i()->cssFiles, \IPS\Theme::i()->css( 'flags.css', 'core', 'global' ) );
Output::i()->cssFiles = array_merge( Output::i()->cssFiles, Theme::i()->css( 'flags.css', 'core', 'global' ) );
}
/**
* Get editors
*
* @return array
* @return array|null
*/
protected function _getEditors()
protected function _getEditors(): ?array
{
if ( isset( $this->options['editor'] ) )
{
if ( $this->editors === NULL )
{
foreach ( \IPS\Lang::getEnabledLanguages() as $lang )
foreach ( Lang::getEnabledLanguages() as $lang )
{
$options = $this->options['editor'];
$options['autoSaveKey'] .= $lang->id;
$options['attachIdsLang'] = $lang->id;
$this->editors[ $lang->id ] = new Editor( "{$this->name}[{$lang->id}]", isset( $this->value[ $lang->id ] ) ? $this->value[ $lang->id ] : NULL, $this->required, $options );
$this->editors[ $lang->id ] = new Editor( "{$this->name}[{$lang->id}]", $this->value[$lang->id] ?? NULL, $this->required, $options );
}
}
return $this->editors;
@@ -144,9 +154,9 @@ class _Translatable extends FormAbstract
*
* @return string
*/
public function html()
public function html(): string
{
return \IPS\Theme::i()->getTemplate( 'forms', 'core', 'global' )->translatable( $this->name, \IPS\Lang::getEnabledLanguages(), $this->value, $this->_getEditors(), $this->options['placeholder'], $this->options['textArea'], $this->required );
return Theme::i()->getTemplate( 'forms', 'core', 'global' )->translatable( $this->name, Lang::getEnabledLanguages(), $this->value, $this->_getEditors(), $this->options['placeholder'], $this->options['textArea'], $this->required );
}
@@ -155,7 +165,7 @@ class _Translatable extends FormAbstract
*
* @return mixed
*/
public function getValue()
public function getValue(): mixed
{
if ( isset( $this->options['editor'] ) )
{
@@ -175,18 +185,18 @@ class _Translatable extends FormAbstract
/**
* Validate
*
* @throws \InvalidArgumentException
* @throws InvalidArgumentException
* @return TRUE
*/
public function validate()
public function validate(): bool
{
parent::validate();
if ( $this->required )
{
if ( ! trim( $this->value[ \IPS\Lang::defaultLanguage() ] ) )
if ( ! trim( $this->value[ Lang::defaultLanguage() ] ) )
{
throw new \InvalidArgumentException('form_required');
throw new InvalidArgumentException('form_required');
}
}