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

applications/calendar/api/reviews.php
+77 -52
View File
@@ -12,21 +12,36 @@
namespace IPS\calendar\api;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use InvalidArgumentException;
use IPS\Api\Exception;
use IPS\Api\PaginatedResponse;
use IPS\Api\Response;
use IPS\calendar\Event;
use IPS\calendar\Event\Review;
use IPS\Content\Api\CommentController;
use IPS\Member;
use IPS\Request;
use IPS\Settings;
use OutOfRangeException;
use function defined;
use function in_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;
}
/**
* @brief Calendar Events Reviews API
*/
class _reviews extends \IPS\Content\Api\CommentController
class reviews extends CommentController
{
/**
* Class
*/
protected $class = 'IPS\calendar\Event\Review';
protected string $class = 'IPS\calendar\Event\Review';
/**
* GET /calendar/reviews
@@ -42,9 +57,10 @@ class _reviews extends \IPS\Content\Api\CommentController
* @apiparam string sortDir Sort direction. Can be 'asc' or 'desc' - defaults to 'asc'
* @apiparam int page Page number
* @apiparam int perPage Number of results per page - defaults to 25
* @return \IPS\Api\PaginatedResponse<IPS\calendar\Event\Review>
* @apireturn PaginatedResponse<IPS\calendar\Event\Review>
* @return PaginatedResponse<Review>
*/
public function GETindex()
public function GETindex(): PaginatedResponse
{
return $this->_list( array(), 'calendars' );
}
@@ -55,12 +71,14 @@ class _reviews extends \IPS\Content\Api\CommentController
*
* @param int $id ID Number
* @throws 2L298/1 INVALID_ID The review ID does not exist or the authorized user does not have permission to view it
* @return \IPS\calendar\Event\Review
* @apireturn \IPS\calendar\Event\Review
* @return Response
*/
public function GETitem( $id )
public function GETitem( int $id ): Response
{
try
{
/* @var Review $class */
$class = $this->class;
if ( $this->member )
{
@@ -71,11 +89,11 @@ class _reviews extends \IPS\Content\Api\CommentController
$object = $class::load( $id );
}
return new \IPS\Api\Response( 200, $object->apiOutput( $this->member ) );
return new Response( 200, $object->apiOutput( $this->member ) );
}
catch ( \OutOfRangeException $e )
catch ( OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2L298/1', 404 );
throw new Exception( 'INVALID_ID', '2L298/1', 404 );
}
}
@@ -98,18 +116,19 @@ class _reviews extends \IPS\Content\Api\CommentController
* @throws 1L298/4 NO_CONTENT No content was supplied
* @throws 1L298/8 INVALID_RATING The rating is not a valid number up to the maximum rating
* @throws 2L298/A NO_PERMISSION The authorized user does not have permission to review that event
* @return \IPS\calendar\Event\Review
* @apireturn \IPS\calendar\Event\Review
* @return Response
*/
public function POSTindex()
public function POSTindex(): Response
{
/* Get event */
try
{
$event = \IPS\calendar\Event::load( \IPS\Request::i()->event );
$event = Event::load( Request::i()->event );
}
catch ( \OutOfRangeException $e )
catch ( OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2L298/2', 403 );
throw new Exception( 'INVALID_ID', '2L298/2', 403 );
}
/* Get author */
@@ -117,44 +136,44 @@ class _reviews extends \IPS\Content\Api\CommentController
{
if ( !$event->canReview( $this->member ) )
{
throw new \IPS\Api\Exception( 'NO_PERMISSION', '2L298/A', 403 );
throw new Exception( 'NO_PERMISSION', '2L298/A', 403 );
}
$author = $this->member;
}
else
{
if ( \IPS\Request::i()->author )
if ( Request::i()->author )
{
$author = \IPS\Member::load( \IPS\Request::i()->author );
$author = Member::load( Request::i()->author );
if ( !$author->member_id )
{
throw new \IPS\Api\Exception( 'NO_AUTHOR', '1L298/3', 404 );
throw new Exception( 'NO_AUTHOR', '1L298/3', 404 );
}
}
else
{
if ( (int) \IPS\Request::i()->author === 0 )
if ( Request::i()->author === 0 )
{
$author = new \IPS\Member;
$author->name = \IPS\Request::i()->author_name;
$author = new Member;
$author->name = Request::i()->author_name;
}
else
{
throw new \IPS\Api\Exception( 'NO_AUTHOR', '1L298/3', 400 );
throw new Exception( 'NO_AUTHOR', '1L298/3', 400 );
}
}
}
/* Check we have a post */
if ( !\IPS\Request::i()->content )
if ( !Request::i()->content )
{
throw new \IPS\Api\Exception( 'NO_CONTENT', '1L298/4', 403 );
throw new Exception( 'NO_CONTENT', '1L298/4', 403 );
}
/* Check we have a rating */
if ( !\IPS\Request::i()->rating or !\in_array( (int) \IPS\Request::i()->rating, range( 1, \IPS\Settings::i()->reviews_rating_out_of ) ) )
if ( !Request::i()->rating or !in_array( (int) Request::i()->rating, range( 1, Settings::i()->reviews_rating_out_of ) ) )
{
throw new \IPS\Api\Exception( 'INVALID_RATING', '1L298/8', 403 );
throw new Exception( 'INVALID_RATING', '1L298/8', 403 );
}
/* Do it */
@@ -177,41 +196,42 @@ class _reviews extends \IPS\Content\Api\CommentController
* @throws 1L298/6 NO_AUTHOR The author ID does not exist
* @throws 1L298/9 INVALID_RATING The rating is not a valid number up to the maximum rating
* @throws 2L298/B NO_PERMISSION The authorized user does not have permission to edit the review
* @return \IPS\calendar\Event\Review
* @apireturn \IPS\calendar\Event\Review
* @return Response
*/
public function POSTitem( $id )
public function POSTitem( int $id ): Response
{
try
{
/* Load */
$comment = \IPS\calendar\Event\Review::load( $id );
$comment = Review::load( $id );
if ( $this->member and !$comment->canView( $this->member ) )
{
throw new \OutOfRangeException;
throw new OutOfRangeException;
}
if ( $this->member and !$comment->canEdit( $this->member ) )
{
throw new \IPS\Api\Exception( 'NO_PERMISSION', '2L298/B', 403 );
throw new Exception( 'NO_PERMISSION', '2L298/B', 403 );
}
/* Check */
if ( isset( \IPS\Request::i()->rating ) and !\in_array( (int) \IPS\Request::i()->rating, range( 1, \IPS\Settings::i()->reviews_rating_out_of ) ) )
if ( isset( Request::i()->rating ) and !in_array( (int) Request::i()->rating, range( 1, Settings::i()->reviews_rating_out_of ) ) )
{
throw new \IPS\Api\Exception( 'INVALID_RATING', '1L298/9', 403 );
throw new Exception( 'INVALID_RATING', '1L298/9', 403 );
}
/* Do it */
try
{
return $this->_edit( $comment );
}
catch ( \InvalidArgumentException $e )
catch ( InvalidArgumentException $e )
{
throw new \IPS\Api\Exception( 'NO_AUTHOR', '1L298/6', 400 );
throw new Exception( 'NO_AUTHOR', '1L298/6', 400 );
}
}
catch ( \OutOfRangeException $e )
catch ( OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2L298/5', 404 );
throw new Exception( 'INVALID_ID', '2L298/5', 404 );
}
}
@@ -222,25 +242,27 @@ class _reviews extends \IPS\Content\Api\CommentController
* @param int $id ID Number
* @throws 2L298/7 INVALID_ID The review ID does not exist
* @throws 2L298/C NO_PERMISSION The authorized user does not have permission to delete the comment
* @return void
* @apireturn void
* @return Response
*/
public function DELETEitem( $id )
public function DELETEitem( int $id ): Response
{
try
{
{
/* @var Review $class */
$class = $this->class;
$object = $class::load( $id );
if ( $this->member and !$object->canDelete( $this->member ) )
{
throw new \IPS\Api\Exception( 'NO_PERMISSION', '2L298/C', 403 );
throw new Exception( 'NO_PERMISSION', '2L298/C', 403 );
}
$object->delete();
return new \IPS\Api\Response( 200, NULL );
return new Response( 200, NULL );
}
catch ( \OutOfRangeException $e )
catch ( OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2L298/7', 404 );
throw new Exception( 'INVALID_ID', '2L298/7', 404 );
}
}
@@ -251,14 +273,15 @@ class _reviews extends \IPS\Content\Api\CommentController
* @param int $id ID Number
* @apiparam int id ID of the reaction to add
* @apiparam int author ID of the member reacting
* @return \IPS\calendar\Event\Review
* @apireturn \IPS\calendar\Event\Review
* @throws 1S425/2 NO_REACTION The reaction ID does not exist
* @throws 1S425/3 NO_AUTHOR The author ID does not exist
* @throws 1S425/4 REACT_ERROR Error adding the reaction
* @throws 1S425/5 INVALID_ID Object ID does not exist
* @note If the author has already reacted to this content, any existing reaction will be removed first
* @return Response
*/
public function POSTitem_react( $id )
public function POSTitem_react( int $id ): Response
{
return $this->_reactAdd( $id );
}
@@ -269,13 +292,14 @@ class _reviews extends \IPS\Content\Api\CommentController
*
* @param int $id ID Number
* @apiparam int author ID of the member who reacted
* @return \IPS\calendar\Event\Review
* @apireturn Review
* @throws 1S425/6 NO_AUTHOR The author ID does not exist
* @throws 1S425/7 REACT_ERROR Error adding the reaction
* @throws 1S425/8 INVALID_ID Object ID does not exist
* @note If the author has already reacted to this content, any existing reaction will be removed first
* @return Response
*/
public function DELETEitem_react( $id )
public function DELETEitem_react( int $id ): Response
{
return $this->_reactRemove( $id );
}
@@ -289,9 +313,10 @@ class _reviews extends \IPS\Content\Api\CommentController
* @apiparam string message Optional message
* @throws 1S425/B NO_AUTHOR The author ID does not exist
* @throws 1S425/C REPORTED_ALREADY The member has reported this item in the past 24 hours
* @return \IPS\calendar\Event\Review
* @apireturn \IPS\calendar\Event\Review
* @return Response
*/
public function POSTitem_report( $id )
public function POSTitem_report( int $id ): Response
{
return $this->_report( $id );
}