Version 5.0.0 beta 1

applications/cms/sources/Fields/Soundcloud.php

@@ -12,55 +12,64 @@
 namespace IPS\cms\Fields;
 
 /* To prevent PHP errors (extending class does not exist) revealing path */
-if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
+
+use DomainException;
+use InvalidArgumentException;
+use IPS\cms\Fields;
+use IPS\Helpers\Form\Text;
+use IPS\Http\Url;
+use IPS\Member;
+use IPS\Theme;
+use function defined;
+
+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;
 }
 
 /**
  * Soundcloud input class for Form Builder
  */
-class _Soundcloud extends \IPS\Helpers\Form\Text
+class Soundcloud extends Text
 {
 	/**
 	 * @brief	Default Options
 	 */
-	public $childDefaultOptions = array(
+	public array $childDefaultOptions = array(
 		'parameters' => array()
 	);
-	
+
 	/**
 	 * 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 )
 	{
-		$this->childDefaultOptions['placeholder'] = \IPS\Member::loggedIn()->language()->addToStack('field_placeholder_soundcloud');
+		$this->childDefaultOptions['placeholder'] = Member::loggedIn()->language()->addToStack('field_placeholder_soundcloud');
 		
 		/* Call parent constructor */
 		parent::__construct( $name, $defaultValue, $required, $options, $customValidationCode, $prefix, $suffix, $id );
 		
 		$this->formType = 'text';
 	}
-	
+
 	/**
 	 * Get the display value
-	 * 
-	 * @param	mixed			$value			Stored value from form
-	 * @param	\IPS\cms\Field	$customField	Custom Field Object
-	 * @return	string
+	 *
+	 * @param mixed $value Stored value from form
+	 * @param Fields $customField Custom Field Object
+	 * @return string|null
 	 */
-	public static function displayValue( $value, $customField )
+	public static function displayValue( mixed $value, Fields $customField ): ?string
 	{
 		if( !$value )
 		{
@@ -79,34 +88,36 @@ class _Soundcloud extends \IPS\Helpers\Form\Text
 			$params['height'] = 166;
 		}
 		
-		return \IPS\Theme::i()->getTemplate( 'records', 'cms', 'global' )->soundcloud( urlencode( $value ), $params );
+		return Theme::i()->getTemplate( 'records', 'cms', 'global' )->soundcloud( urlencode( $value ), $params );
 	}
 	
 	/**
 	 * Validate
 	 *
-	 * @throws	\InvalidArgumentException
-	 * @throws	\DomainException
-	 * @return	TRUE
-	 */
-	public function validate()
+	 * @return	bool
+	 * @throws	DomainException
+	 * @throws	InvalidArgumentException
+	 	 */
+	public function validate(): bool
 	{
 		parent::validate();
 						
 		if ( $this->value )
 		{
 			/* Check the URL is valid */
-			if ( !( $this->value instanceof \IPS\Http\Url ) )
+			if ( !( $this->value instanceof Url ) )
 			{
-				throw new \InvalidArgumentException('form_url_bad');
+				throw new InvalidArgumentException('form_url_bad');
 			}
 			
-			/* Check its a valid Soundcloud URL */
+			/* Check it's a valid Soundcloud URL */
 			if ( ! mb_stristr( $this->value->data['host'], 'soundcloud.com' ) )
 			{
-				throw new \InvalidArgumentException('form_url_bad');
+				throw new InvalidArgumentException('form_url_bad');
 			}
 		}
+
+		return true;
 	}
 	
 	/**
@@ -114,12 +125,12 @@ class _Soundcloud extends \IPS\Helpers\Form\Text
 	 *
 	 * @return	string
 	 */
-	public function getValue()
+	public function getValue(): mixed
 	{
 		$val = parent::getValue();
 		if ( $val and !mb_strpos( $val, '://' ) )
 		{
-			$val = "http://{$val}";
+			$val = "https://{$val}";
 		}
 		
 		return $val;
@@ -128,17 +139,17 @@ class _Soundcloud extends \IPS\Helpers\Form\Text
 	/**
 	 * Format Value
 	 *
-	 * @return	\IPS\Http\Url|string
+	 * @return	Url|string
 	 */
-	public function formatValue()
+	public function formatValue(): mixed
 	{
-		if ( $this->value and !( $this->value instanceof \IPS\Http\Url ) )
+		if ( $this->value and !( $this->value instanceof Url ) )
 		{
 			try
 			{
-				return new \IPS\Http\Url( $this->value );
+				return new Url( $this->value );
 			}
-			catch ( \InvalidArgumentException $e )
+			catch ( InvalidArgumentException $e )
 			{
 				return $this->value;
 			}