Version 5.0.0 beta 1

applications/gallery/sources/Image/Review.php

@@ -12,53 +12,74 @@
 namespace IPS\gallery\Image;
 
 /* To prevent PHP errors (extending class does not exist) revealing path */
-if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
+
+use BadMethodCallException;
+use IPS\Content\EditHistory;
+use IPS\Content\Embeddable;
+use IPS\Content\Filter;
+use IPS\Content\Hideable;
+use IPS\Content\Reactable;
+use IPS\Content\Reportable;
+use IPS\Content\Review as ContentReview;
+use IPS\Content\Shareable;
+use IPS\Http\Url;
+use IPS\Http\Url\Exception;
+use IPS\Output;
+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;
 }
 
 /**
  * Image Review Model
  */
-class _Review extends \IPS\Content\Review implements \IPS\Content\EditHistory, \IPS\Content\Hideable, \IPS\Content\Searchable, \IPS\Content\Embeddable
+class Review extends ContentReview implements Embeddable,
+	Filter
 {
-	use \IPS\Content\Reactable, \IPS\Content\Reportable;
+	use	Reactable,
+		Reportable,
+		Shareable,
+		EditHistory,
+		Hideable;
 
 	/**
 	 * @brief	[Content\Comment]	Form Template
 	 */
-	public static $formTemplate = array( array( 'forms', 'gallery', 'front' ), 'reviewTemplate' );
+	public static array $formTemplate = array( array( 'forms', 'gallery', 'front' ), 'reviewTemplate' );
 
 	/**
 	 * @brief	[Content\Comment]	Comment Template
 	 */
-	public static $commentTemplate = array( array( 'global', 'gallery', 'front' ), 'reviewContainer' );
+	public static array $commentTemplate = array( array( 'global', 'gallery', 'front' ), 'reviewContainer' );
 
 	/**
 	 * @brief	[ActiveRecord] Multiton Store
 	 */
-	protected static $multitons;
+	protected static array $multitons;
 
 	/**
 	 * @brief	[Content\Comment]	Item Class
 	 */
-	public static $itemClass = 'IPS\gallery\Image';
+	public static ?string $itemClass = 'IPS\gallery\Image';
 
 	/**
 	 * @brief	[ActiveRecord] Database Table
 	 */
-	public static $databaseTable = 'gallery_reviews';
+	public static ?string $databaseTable = 'gallery_reviews';
 
 	/**
 	 * @brief	[ActiveRecord] Database Prefix
 	 */
-	public static $databasePrefix = 'review_';
+	public static string $databasePrefix = 'review_';
 	
 	/**
 	 * @brief	Database Column Map
 	 */
-	public static $databaseColumnMap = array(
+	public static array $databaseColumnMap = array(
 		'item'				=> 'image_id',
 		'author'			=> 'author',
 		'author_name'		=> 'author_name',
@@ -79,59 +100,42 @@ class _Review extends \IPS\Content\Review implements \IPS\Content\EditHistory, \
 	/**
 	 * @brief	Application
 	 */
-	public static $application = 'gallery';
+	public static string $application = 'gallery';
 
 	/**
 	 * @brief	Title
 	 */
-	public static $title = 'gallery_image_review';
+	public static string $title = 'gallery_image_review';
 
 	/**
 	 * @brief	Icon
 	 */
-	public static $icon = 'camera';
+	public static string $icon = 'camera';
 
 	/**
 	 * @brief	[Content]	Key for hide reasons
 	 */
-	public static $hideLogKey = 'gallery-image-review';
+	public static ?string $hideLogKey = 'gallery-image-review';
 
 	/**
 	 * Get URL for doing stuff
 	 *
 	 * @param	string|NULL		$action		Action
-	 * @return	\IPS\Http\Url
-	 * @throws	\BadMethodCallException
-	 * @throws	\IPS\Http\Url\Exception
+	 * @return	Url
+	 * @throws	BadMethodCallException
+	 * @throws	Exception
 	 */
-	public function url( $action='find' )
+	public function url( ?string $action='find' ): Url
 	{
 		return parent::url( $action )->setQueryString( 'tab', 'reviews' );
 	}
-
-	/**
-	 * Get snippet HTML for search result display
-	 *
-	 * @param	array		$indexData		Data from the search index
-	 * @param	array		$authorData		Basic data about the author. Only includes columns returned by \IPS\Member::columnsForPhoto()
-	 * @param	array		$itemData		Basic data about the item. Only includes columns returned by item::basicDataColumns()
-	 * @param	array|NULL	$containerData	Basic data about the container. Only includes columns returned by container::basicDataColumns()
-	 * @param	array		$reputationData	Array of people who have given reputation and the reputation they gave
-	 * @param	int|NULL	$reviewRating	If this is a review, the rating
-	 * @param	string		$view			'expanded' or 'condensed'
-	 * @return	callable
-	 */
-	public static function searchResultSnippet( array $indexData, array $authorData, array $itemData, ?array $containerData, array $reputationData, $reviewRating, $view )
-	{
-		return \IPS\gallery\Image\Comment::searchResultSnippet( $indexData, $authorData, $itemData, $containerData, $reputationData, $reviewRating, $view );
-	}
 	
 	/**
 	 * Reaction Type
 	 *
 	 * @return	string
 	 */
-	public static function reactionType()
+	public static function reactionType(): string
 	{
 		return 'review_id';
 	}
@@ -142,9 +146,9 @@ class _Review extends \IPS\Content\Review implements \IPS\Content\EditHistory, \
 	 * @param	array	$params	Additional parameters to add to URL
 	 * @return	string
 	 */
-	public function embedContent( $params )
+	public function embedContent( array $params ): string
 	{
-		\IPS\Output::i()->cssFiles = array_merge( \IPS\Output::i()->cssFiles, \IPS\Theme::i()->css( 'embed.css', 'gallery', 'front' ) );
-		return \IPS\Theme::i()->getTemplate( 'global', 'gallery' )->embedImageReview( $this, $this->item(), $this->url()->setQueryString( $params ) );
+		Output::i()->cssFiles = array_merge( Output::i()->cssFiles, Theme::i()->css( 'embed.css', 'gallery', 'front' ) );
+		return Theme::i()->getTemplate( 'global', 'gallery' )->embedImageReview( $this, $this->item(), $this->url()->setQueryString( $params ) );
 	}
 }