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/Content/Reactable.php
+233 -166
View File
@@ -11,9 +11,39 @@
namespace IPS\Content;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use BadMethodCallException;
use DateInterval;
use DomainException;
use Exception;
use IPS\Application;
use IPS\Content;
use IPS\DateTime;
use IPS\Db;
use IPS\Events\Event;
use IPS\Helpers\Table\Db as TableDb;
use IPS\IPS;
use IPS\Member;
use IPS\Node\Model;
use IPS\Notification;
use IPS\Platform\Bridge;
use IPS\Redis;
use IPS\Request;
use IPS\Settings;
use IPS\Theme;
use OutOfRangeException;
use RedisException;
use UnderflowException;
use function count;
use function defined;
use function get_called_class;
use function get_class;
use function is_array;
use function strtolower;
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;
}
@@ -27,63 +57,61 @@ trait Reactable
*
* @return string
*/
public static function reactionType()
{
throw new \BadMethodCallException;
}
abstract public static function reactionType(): string;
/**
* Reaction class
*
* @return string
*/
public static function reactionClass()
public static function reactionClass(): string
{
return \get_called_class();
return get_called_class();
}
/**
* React
*
* @param \IPS\core\Reaction $reaction The reaction
* @param \IPS\Member $member The member reacting, or NULL
* @return void
* @throws \DomainException
* @param Reaction $reaction The reaction
* @param Member|null $member The member reacting, or NULL
* @return void
* @throws DomainException
* @throws Exception
*/
public function react( \IPS\Content\Reaction $reaction, \IPS\Member $member = NULL )
public function react(Content\Reaction $reaction, ?Member $member = NULL ): void
{
/* Did we pass a member? */
$member = $member ?: \IPS\Member::loggedIn();
$member = $member ?: Member::loggedIn();
/* Figure out the owner of this - if it is content, it will be the author. If it is a node, then it will be the person who created it */
if ( $this instanceof \IPS\Content )
{
$owner = $this->author();
}
else if ( $this instanceof \IPS\Node\Model )
if( $this instanceof Model )
{
$owner = $this->owner();
}
else
{
$owner = $this->author();
}
/* Can we react? */
if ( !$this->canView( $member ) or !$this->canReact( $member ) or !$reaction->enabled )
{
throw new \DomainException( 'cannot_react' );
throw new DomainException( 'cannot_react' );
}
/* Have we hit our limit? Also, why 999 for unlimited? */
if ( $member->group['g_rep_max_positive'] !== -1 )
{
$count = \IPS\Db::i()->select( 'COUNT(*)', 'core_reputation_index', array( 'member_id=? AND rep_date>?', $member->member_id, \IPS\DateTime::create()->sub( new \DateInterval( 'P1D' ) )->getTimestamp() ) )->first();
$count = Db::i()->select( 'COUNT(*)', 'core_reputation_index', array( 'member_id=? AND rep_date>?', $member->member_id, DateTime::create()->sub( new DateInterval( 'P1D' ) )->getTimestamp() ) )->first();
if ( $count >= $member->group['g_rep_max_positive'] )
{
throw new \DomainException( \IPS\Member::loggedIn()->language()->addToStack( 'react_daily_exceeded', FALSE, array( 'sprintf' => array( $member->group['g_rep_max_positive'] ) ) ) );
throw new DomainException( Member::loggedIn()->language()->addToStack( 'react_daily_exceeded', FALSE, array( 'sprintf' => array( $member->group['g_rep_max_positive'] ) ) ) );
}
}
/* Figure out our app - we do it this way as content items and nodes will always have a lowercase namespace for the app, so if the match below fails, then 'core' can be assumed */
$app = explode( '\\', \get_class( $this ) );
if ( \strtolower( $app[1] ) === $app[1] )
$app = explode( '\\', get_class( $this ) );
if ( strtolower( $app[1] ) === $app[1] )
{
$app = $app[1];
}
@@ -94,7 +122,7 @@ trait Reactable
/* If this is a comment, we need the parent items ID */
$itemId = 0;
if ( $this instanceof \IPS\Content\Comment )
if ( $this instanceof Comment)
{
$item = $this->item();
$itemIdColumn = $item::$databaseColumnId;
@@ -119,12 +147,12 @@ trait Reactable
/* Actually insert it */
$idColumn = static::$databaseColumnId;
\IPS\Db::i()->insert( 'core_reputation_index', array(
Db::i()->insert( 'core_reputation_index', array(
'member_id' => $member->member_id,
'app' => $app,
'type' => static::reactionType(),
'type_id' => $this->$idColumn,
'rep_date' => \IPS\DateTime::create()->getTimestamp(),
'rep_date' => DateTime::create()->getTimestamp(),
'rep_rating' => $reaction->value,
'member_received' => $owner->member_id,
'rep_class' => static::reactionClass(),
@@ -133,10 +161,19 @@ trait Reactable
'reaction' => $reaction->id
) );
/* Send the notification but only if we aren't reacting to our own content, we can view the content, the user isn't ignored and we aren't changing from one reaction to another */
if ( $this->author()->member_id AND $this->author() != \IPS\Member::loggedIn() AND $this->canView( $owner ) AND !$reacted AND !$member->isIgnoring( $this->author(), 'posts' ) )
/* Fire event */
Event::fire( 'onReact', $member, [ $this, $reaction ] );
/* Have we hit highlighted content? */
if( $this->isHighlighted() )
{
$notification = new \IPS\Notification( \IPS\Application::load('core'), 'new_likes', $this, array( $this, $member ), array(), TRUE, \IPS\Content\Reaction::isLikeMode() ? NULL : 'notification_new_react' );
$owner->achievementAction( 'core', 'Highlight', [ 'content' => $this ] );
}
/* Send the notification but only if we aren't reacting to our own content, we can view the content, the user isn't ignored and we aren't changing from one reaction to another */
if ( $this->author()->member_id AND $this->author() !== $member AND $this->canView( $owner ) AND !$reacted AND !$member->isIgnoring( $this->author(), 'posts' ) )
{
$notification = new Notification( Application::load('core'), 'new_likes', $this, array( $this, $member ), array(), TRUE, Content\Reaction::isLikeMode() ? NULL : 'notification_new_react' );
$notification->recipients->attach( $owner );
$notification->send();
}
@@ -150,40 +187,47 @@ trait Reactable
/* Reset some cached values */
$this->_reactionCount = NULL;
$this->_reactions = NULL;
$this->likeBlurb = [];
unset( $this->reputation );
$this->hasReacted[ $member->member_id ] = $reaction;
if( \IPS\Application::appIsEnabled( 'cloud' ) and \IPS\cloud\Realtime::i()->isEnabled('realtime') )
{
$this->reactions();
\IPS\cloud\Realtime::i()->publishEvent( 'reaction-count', array('count' => $this->_reactionCount) );
}
if( \IPS\Application::appIsEnabled( 'cloud' ) and \IPS\cloud\Application::trendingIsEnabled() )
$item = ( ! $this instanceof Item) ? $this->item() : $this;
if ( Bridge::i()->featureIsEnabled( 'trending' ) )
{
/* We need to make sure we're using the item */
$item = ( ! $this instanceof \IPS\Content\Item ) ? $this->item() : $this;
$itemIdColumn = $item::$databaseColumnId;
$itemId = $item->$itemIdColumn;
try
{
\IPS\Redis::i()->zIncrBy( 'trending', time() * 0.4, \get_class( $item ) .'__' . $itemId );
Redis::i()->zIncrBy( 'trending', time() * 0.4, get_class( $item ) .'__' . $itemId );
}
catch( \BadMethodCallException | \RedisException $e ) {}
catch( BadMethodCallException | RedisException ) {}
}
if ( IPS::classUsesTrait( $item, 'IPS\Content\Statistics' ) )
{
/* @var Item $item */
$item->clearCachedStatistics();
}
}
/**
* Remove Reaction
*
* @param \IPS\Member|NULL $member The member, or NULL for currently logged in member
* @param Member|NULL $member The member, or NULL for currently logged in member
* @param bool $removeNotifications Whether to remove notifications or not
* @return void
*/
public function removeReaction( \IPS\Member $member = NULL, $removeNotifications = TRUE )
public function removeReaction( ?Member $member = NULL, bool $removeNotifications = TRUE ): void
{
$member = $member ?: \IPS\Member::loggedIn();
$member = $member ?: Member::loggedIn();
/* Reset some cached values */
$this->_reactionCount = NULL;
$this->_reactions = NULL;
$this->likeBlurb = [];
unset( $this->reputation );
try
{
@@ -193,22 +237,22 @@ trait Reactable
$where = $this->getReactionWhereClause( NULL, FALSE );
$where[] = array( 'member_id=?', $member->member_id );
$rep = \IPS\Db::i()->select( '*', 'core_reputation_index', $where )->first();
$rep = Db::i()->select( '*', 'core_reputation_index', $where )->first();
}
catch( \UnderflowException $e )
catch( UnderflowException )
{
throw new \OutOfRangeException;
throw new OutOfRangeException;
}
$memberReceived = \IPS\Member::load( $rep['member_received'] );
$reaction = \IPS\Content\Reaction::load( $rep['reaction'] );
$memberReceived = Member::load( $rep['member_received'] );
$reaction = Content\Reaction::load( $rep['reaction'] );
}
catch( \OutOfRangeException $e )
catch( OutOfRangeException )
{
throw new \DomainException;
throw new DomainException;
}
if( \IPS\Db::i()->delete( 'core_reputation_index', array( "app=? AND type=? AND type_id=? AND member_id=?", static::$application, static::reactionType(), $this->$idColumn, $member->member_id ) ) )
if( Db::i()->delete( 'core_reputation_index', array( "app=? AND type=? AND type_id=? AND member_id=?", static::$application, static::reactionType(), $this->$idColumn, $member->member_id ) ) )
{
if ( $memberReceived->member_id )
{
@@ -216,29 +260,28 @@ trait Reactable
$memberReceived->save();
}
/* Fire event */
Event::fire( 'onUnreact', $member, [ $this ] );
/* Remove Notifications */
if( $removeNotifications === TRUE )
{
$memberIds = array();
foreach( \IPS\Db::i()->select( '`member`', 'core_notifications', array( 'notification_key=? AND item_class=? AND item_id=?', 'new_likes', (string) \get_class( $this ), (int) $this->$idColumn ) ) as $memberToRecount )
foreach( Db::i()->select( '`member`', 'core_notifications', array( 'notification_key=? AND item_class=? AND item_id=?', 'new_likes', get_class( $this ), (int) $this->$idColumn ) ) as $memberToRecount )
{
$memberIds[ $memberToRecount ] = $memberToRecount;
}
\IPS\Db::i()->delete( 'core_notifications', array( 'notification_key=? AND item_class=? AND item_id=?', 'new_likes', (string) \get_class( $this ), (int) $this->$idColumn ) );
Db::i()->delete( 'core_notifications', array( 'notification_key=? AND item_class=? AND item_id=?', 'new_likes', get_class( $this ), (int) $this->$idColumn ) );
foreach( $memberIds as $memberToRecount )
{
\IPS\Member::load( $memberToRecount )->recountNotifications();
Member::load( $memberToRecount )->recountNotifications();
}
}
}
/* Reset some cached values */
$this->_reactionCount = NULL;
$this->_reactions = NULL;
if( isset( $this->hasReacted[ $member->member_id ] ) )
{
unset( $this->hasReacted[ $member->member_id ] );
@@ -248,36 +291,41 @@ trait Reactable
/**
* Can React
*
* @param \IPS\Member|NULL $member The member, or NULL for currently logged in
* @param Member|NULL $member The member, or NULL for currently logged in
* @return bool
*/
public function canReact( \IPS\Member $member = NULL )
public function canReact( ?Member $member = NULL ): bool
{
$member = $member ?: \IPS\Member::loggedIn();
if ( $this instanceof \IPS\Content )
if( !$this->actionEnabled( 'react', $member ) )
{
$owner = $this->author();
return false;
}
else if ( $this instanceof \IPS\Node\Model )
$member = $member ?: Member::loggedIn();
if ( $this instanceof Model )
{
$owner = $this->owner();
}
else
{
$owner = $this->author();
}
/* Only members can react */
if ( !$member->member_id )
{
return FALSE;
}
/* Cannot react to guest content */
if ( !$owner->member_id )
if ( !isset( $owner ) or !$owner->member_id )
{
return FALSE;
}
/* Protected Groups */
if ( $owner->inGroup( explode( ',', \IPS\Settings::i()->reputation_protected_groups ) ) )
if ( $owner->inGroup( explode( ',', Settings::i()->reputation_protected_groups ) ) )
{
return FALSE;
}
@@ -287,15 +335,15 @@ trait Reactable
{
return FALSE;
}
/* React to own content */
if ( !\IPS\Settings::i()->reputation_can_self_vote AND $this->author()->member_id == $member->member_id )
/* Unacknowledged warnings */
if ( $member->members_bitoptions['unacknowledged_warnings'] )
{
return FALSE;
}
/* Unacknowledged warnings */
if ( $member->members_bitoptions['unacknowledged_warnings'] )
/* React to own content */
if ( !Settings::i()->reputation_can_self_vote AND $this->author()->member_id == $member->member_id )
{
return FALSE;
}
@@ -307,14 +355,14 @@ trait Reactable
/**
* @brief Reactions Cache
*/
protected $_reactions = NULL;
protected array|null $_reactions = NULL;
/**
* Reactions
*
* @return array
*/
public function reactions()
public function reactions(): array
{
if ( $this->_reactionCount === NULL )
{
@@ -323,12 +371,11 @@ trait Reactable
if ( $this->_reactions === NULL )
{
$idColumn = static::$databaseColumnId;
$this->_reactions = array();
if ( \is_array( $this->reputation ) )
if ( isset( $this->reputation ) )
{
if ( $enabledReactions = \IPS\Content\Reaction::enabledReactions() )
if ( $enabledReactions = Content\Reaction::enabledReactions() )
{
foreach( $this->reputation AS $memberId => $reactionId )
{
@@ -344,7 +391,7 @@ trait Reactable
{
/* Set the data in $this->reputation to save queries later */
$this->reputation = array();
foreach( \IPS\Db::i()->select( '*', 'core_reputation_index', $this->getReactionWhereClause() )->join( 'core_reactions', 'reaction=reaction_id' ) AS $reaction )
foreach( Db::i()->select( '*', 'core_reputation_index', $this->getReactionWhereClause() )->join( 'core_reactions', 'reaction=reaction_id' ) AS $reaction )
{
$this->reputation[ $reaction['member_id'] ] = $reaction['reaction'];
$this->_reactions[ $reaction['member_id'] ][] = $reaction['reaction'];
@@ -359,14 +406,14 @@ trait Reactable
/**
* @brief Reaction Count
*/
protected $_reactionCount = NULL;
protected int|null $_reactionCount = NULL;
/**
* Reaction Count
*
* @return int
*/
public function reactionCount()
public function reactionCount(): int
{
if( $this->_reactionCount === NULL )
{
@@ -375,35 +422,55 @@ trait Reactable
return $this->_reactionCount;
}
/**
* Does this content reach the "reputation highlighted" threshhold?
*
* @return bool
*/
public function isHighlighted() : bool
{
return ( Settings::i()->reputation_enabled and Settings::i()->reputation_highlight and ( $this->reactionCount() >= Settings::i()->reputation_highlight ) );
}
/**
* Reaction Where Clause
*
* @param \IPS\Content\Reaction|array|int|NULL $reactions This can be any one of the following: An \IPS\Content\Reaction object, an array of \IPS\Content\Reaction objects, an integer, or an array of integers, or NULL
* @param Reaction|array|int|NULL $reactions This can be any one of the following: An \IPS\Content\Reaction object, an array of \IPS\Content\Reaction objects, an integer, or an array of integers, or NULL
* @param bool $enabledTypesOnly If TRUE, only reactions of the enabled reaction types will be included (must join core_reactions)
* @return array
*/
public function getReactionWhereClause( $reactions = NULL, $enabledTypesOnly=TRUE )
public function getReactionWhereClause( Reaction|array|int|null $reactions = NULL, bool $enabledTypesOnly=TRUE ): array
{
$app = explode( '\\', static::reactionClass() );
if ( strtolower( $app[1] ) === $app[1] )
{
$app = $app[1];
}
else
{
$app = 'core';
}
$idColumn = static::$databaseColumnId;
$where = array( array( 'rep_class=? AND type=? AND type_id=?', static::reactionClass(), static::reactionType(), $this->$idColumn ) );
$where = array( array( 'rep_class=? AND app=? AND type=? AND type_id=?', static::reactionClass(), $app, static::reactionType(), $this->$idColumn ) );
if ( $enabledTypesOnly )
{
$where[] = array( 'reaction_enabled=1' );
}
if ( $reactions !== NULL )
{
if ( !\is_array( $reactions ) )
if ( !is_array( $reactions ) )
{
$reactions = array( $reactions );
}
$in = array();
foreach( $reactions AS $reaction )
{
if ( $reaction instanceof \IPS\Content\Reaction )
if ( $reaction instanceof Reaction)
{
$in[] = $reaction->id;
}
@@ -412,42 +479,40 @@ trait Reactable
$in[] = $reaction;
}
}
if ( \count( $in ) )
if ( count( $in ) )
{
$where[] = array( \IPS\Db::i()->in( 'reaction', $in ) );
$where[] = array( Db::i()->in( 'reaction', $in ) );
}
}
return $where;
}
/**
* Reaction Table
*
* @param \IPS\Content\Reaction|int|NULL $reaction This can be any one of the following: An \IPS\Content\Reaction object, an integer, or NULL
* @return \IPS\Helpers\Table\Db
* @param Reaction|int|NULL $reaction This can be any one of the following: An \IPS\Content\Reaction object, an integer, or NULL
* @return TableDb
*/
public function reactionTable( $reaction=NULL )
public function reactionTable( Reaction|int|null $reaction=NULL ): TableDb
{
if ( !\IPS\Member::loggedIn()->group['gbw_view_reps'] or !$this->canView() )
if ( !Member::loggedIn()->group['gbw_view_reps'] or !$this->canView() )
{
throw new \DomainException;
throw new DomainException;
}
$idColumn = static::$databaseColumnId;
$table = new \IPS\Helpers\Table\Db( 'core_reputation_index', $this->url('showReactions'), $this->getReactionWhereClause( $reaction ) );
$table = new TableDb( 'core_reputation_index', $this->url('showReactions'), $this->getReactionWhereClause( $reaction ) );
$table->sortBy = 'rep_date';
$table->sortDirection = 'desc';
$table->tableTemplate = array( \IPS\Theme::i()->getTemplate( 'global', 'core', 'front' ), 'reactionLogTable' );
$table->rowsTemplate = array( \IPS\Theme::i()->getTemplate( 'global', 'core', 'front' ), 'reactionLog' );
$table->tableTemplate = array( Theme::i()->getTemplate( 'global', 'core', 'front' ), 'reactionLogTable' );
$table->rowsTemplate = array( Theme::i()->getTemplate( 'global', 'core', 'front' ), 'reactionLog' );
$table->joins = array( array( 'from' => 'core_reactions', 'where' => 'reaction=reaction_id' ) );
$table->parsers = array(
'rep_date' => function( $date, $row )
{
if ( isset( \IPS\Request::i()->item ) and \IPS\Request::i()->item )
if ( isset( Request::i()->item ) and Request::i()->item )
{
/* This is an item level thing, and not a comment level thing */
try
@@ -455,14 +520,14 @@ trait Reactable
$class = $row['rep_class'];
$item = $class::load( $row['type_id'] );
return \IPS\Member::loggedIn()->language()->addToStack( '_defart_from_date', FALSE, array( 'htmlsprintf' => array( $item->url(), $item->mapped('title'), \IPS\DateTime::ts( $date )->html() ) ) );
return Member::loggedIn()->language()->addToStack( '_defart_from_date', FALSE, array( 'htmlsprintf' => array( $item->url(), $item->mapped('title'), DateTime::ts( $date )->html() ) ) );
}
catch( \Exception $e )
catch( Exception )
{
return \IPS\DateTime::ts( $date )->html();
return DateTime::ts( $date )->html();
}
}
return \IPS\DateTime::ts( $date )->html();
return DateTime::ts( $date )->html();
}
);
@@ -484,17 +549,17 @@ trait Reactable
/**
* @brief Cached Reacted
*/
protected $hasReacted = array();
protected array $hasReacted = array();
/**
* Has reacted?
*
* @param \IPS\Member|NULL $member The member, or NULL for currently logged in
* @return \IPS\Content\Reaction|FALSE
* @param Member|NULL $member The member, or NULL for currently logged in
* @return Reaction|FALSE
*/
public function reacted( \IPS\Member $member = NULL )
public function reacted( ?Member $member = NULL ): Reaction|bool
{
$member = $member ?: \IPS\Member::loggedIn();
$member = $member ?: Member::loggedIn();
if( !isset( $this->hasReacted[ $member->member_id ] ) )
{
@@ -502,21 +567,21 @@ trait Reactable
try
{
if ( \is_array( $this->reputation ) )
if ( $this->reputation and count( $this->reputation ) )
{
if ( isset( $this->reputation[ $member->member_id ] ) )
{
$this->hasReacted[ $member->member_id ] = \IPS\Content\Reaction::load( $this->reputation[ $member->member_id ] );
$this->hasReacted[ $member->member_id ] = Content\Reaction::load( $this->reputation[ $member->member_id ] );
}
}
else
{
$where = $this->getReactionWhereClause( NULL, FALSE );
$where[] = array( 'member_id=?', $member->member_id );
$this->hasReacted[ $member->member_id ] = \IPS\Content\Reaction::load( \IPS\Db::i()->select( 'reaction', 'core_reputation_index', $where )->first() );
$this->hasReacted[ $member->member_id ] = Content\Reaction::load( Db::i()->select( 'reaction', 'core_reputation_index', $where )->first() );
}
}
catch( \UnderflowException $e ){}
catch( UnderflowException ){}
}
return $this->hasReacted[ $member->member_id ];
@@ -525,32 +590,37 @@ trait Reactable
/**
* @brief Cached React Blurb
*/
public $reactBlurb = NULL;
public array|null $reactBlurb = NULL;
/**
* React Blurb
*
* @return array
* @param array|null $reactionCounts
* @return array
*/
public function reactBlurb(): array
public function reactBlurb( array|null $reactionCounts=null ): array
{
if ( $this->reactBlurb === NULL )
{
$this->reactBlurb = array();
if ( $reactionCounts !== null )
{
$this->reactBlurb = $reactionCounts;
}
/*
If we have lots of rows, then use a more efficient way of getting the data (but does increase query count and uses a group by).
I know this is an artibrary number, but it should mean that most communities never need to run this code, and just those with topics with more than 4,000 pages
*/
if ( ( $this instanceof \IPS\Content\Item ) and isset( $this::$databaseColumnMap['num_comments'] ) and $this->mapped( 'num_comments' ) >= 100000 )
else if ( ( $this instanceof Item) and isset( $this::$databaseColumnMap['num_comments'] ) and $this->mapped( 'num_comments' ) >= 100000 )
{
$enabledReactions = [];
foreach( \IPS\Content\Reaction::enabledReactions() as $reaction )
foreach(Reaction::enabledReactions() as $reaction )
{
$enabledReactions[] = $reaction->id;
}
foreach( \IPS\Db::i()->select( 'COUNT(*) as count, reaction', 'core_reputation_index', $this->getReactionWhereClause( NULL , FALSE ), 'count DESC', NULL, 'reaction' ) as $row )
foreach( Db::i()->select( 'COUNT(*) as count, reaction', 'core_reputation_index', $this->getReactionWhereClause( NULL , FALSE ), 'count DESC', NULL, 'reaction' ) as $row )
{
if( in_array( needle: $row['reaction'], haystack: $enabledReactions ) )
{
@@ -560,10 +630,9 @@ trait Reactable
}
else
{
if ( \count( $this->reactions() ) )
if ( count( $this->reactions() ) )
{
$idColumn = static::$databaseColumnId;
if ( \is_array( $this->_reactions ) )
if ( is_array( $this->_reactions ) )
{
foreach ( $this->_reactions as $memberId => $reactions )
{
@@ -580,7 +649,7 @@ trait Reactable
}
else
{
foreach ( \IPS\Db::i()->select( 'reaction', 'core_reputation_index', $this->getReactionWhereClause() )->join( 'core_reactions', 'reaction=reaction_id' ) as $rep )
foreach ( Db::i()->select( 'reaction', 'core_reputation_index', $this->getReactionWhereClause() )->join( 'core_reactions', 'reaction=reaction_id' ) as $rep )
{
if ( !isset( $this->reactBlurb[$rep] ) )
{
@@ -592,7 +661,7 @@ trait Reactable
}
/* Error suppressor for https://bugs.php.net/bug.php?id=50688 */
$enabledReactions = \IPS\Content\Reaction::enabledReactions();
$enabledReactions = Content\Reaction::enabledReactions();
@uksort( $this->reactBlurb, function ( $a, $b ) use ( $enabledReactions ) {
$positionA = $enabledReactions[$a]->position;
@@ -619,22 +688,25 @@ trait Reactable
/**
* @brief Cached like blurb
*/
public $likeBlurb = NULL;
public array $likeBlurb = [];
/**
* Who Reacted
*
* @param bool|NULL $isLike Use like text instead? NULL to automatically determine
* @param bool $anonymized Whether to anonymize the result; when true, the result will not contain "You"
*
* @return string
*/
public function whoReacted( $isLike = NULL )
public function whoReacted( ?bool $isLike = NULL, bool $anonymized=false ): string
{
if ( $isLike === NULL )
{
$isLike = \IPS\Content\Reaction::isLikeMode();
$isLike = Content\Reaction::isLikeMode();
}
if( $this->likeBlurb === NULL )
$blurbKey = $anonymized ? 'anon' : 'reg';
if( !isset( $this->likeBlurb[$blurbKey] ) )
{
$langPrefix = 'react_';
if ( $isLike )
@@ -643,14 +715,14 @@ trait Reactable
}
/* Did anyone like it? */
$numberOfLikes = \count( $this->reactions() ); # int
$numberOfLikes = count( $this->reactions() ); # int
if ( $numberOfLikes )
{
{
/* Is it just us? */
$userLiked = ( $this->reacted() );
$userLiked = ( !$anonymized AND $this->reacted() );
if ( $userLiked and $numberOfLikes < 2 )
{
$this->likeBlurb = \IPS\Member::loggedIn()->language()->addToStack("{$langPrefix}blurb_just_you");
$this->likeBlurb[$blurbKey] = Member::loggedIn()->language()->addToStack("{$langPrefix}blurb_just_you");
}
/* Nope, we need to display a number... */
else
@@ -662,33 +734,28 @@ trait Reactable
/* If the user liked, we always show "You" first */
if ( $userLiked )
{
$peopleToDisplayInMainView[] = \IPS\Member::loggedIn()->language()->addToStack("{$langPrefix}blurb_you_and_others");
$peopleToDisplayInMainView[] = Member::loggedIn()->language()->addToStack("{$langPrefix}blurb_you_and_others");
$andXOthers--;
}
/* Some random names */
$i = 0;
$app = explode( '\\', static::reactionClass() );
if ( \strtolower( $app[1] ) === $app[1] )
{
$app = $app[1];
}
else
{
$app = 'core';
}
$where = $this->getReactionWhereClause();
$where[] = array( 'member_id!=?', \IPS\Member::loggedIn()->member_id ?: 0 );
foreach ( \IPS\Db::i()->select( '*', 'core_reputation_index', $where, 'RAND()', \IPS\Content\Reaction::isLikeMode() ? 18 : ( $userLiked ? 2 : 3 ) )->join( 'core_reactions', 'reaction=reaction_id' ) as $rep )
if ( !$anonymized )
{
$where[] = array( 'member_id!=?', Member::loggedIn()->member_id ?: 0 );
}
foreach (Db::i()->select( '*', 'core_reputation_index', $where, 'RAND()', Content\Reaction::isLikeMode() ? 18 : ( $userLiked ? 2 : 3 ) )->join( 'core_reactions', 'reaction=reaction_id' ) as $rep )
{
if ( $i < ( $userLiked ? 2 : 3 ) )
{
$peopleToDisplayInMainView[] = \IPS\Theme::i()->getTemplate( 'global', 'core', 'front' )->userLink( \IPS\Member::load( $rep['member_id'] ) );
$peopleToDisplayInMainView[] = Theme::i()->getTemplate( 'global', 'core', 'front' )->userLink( Member::load( $rep['member_id'] ) );
$andXOthers--;
}
else
{
$peopleToDisplayInSecondaryView[] = htmlspecialchars( \IPS\Member::load( $rep['member_id'] )->name, ENT_QUOTES | ENT_DISALLOWED, 'UTF-8', FALSE );
$peopleToDisplayInSecondaryView[] = htmlspecialchars( Member::load( $rep['member_id'] )->name, ENT_QUOTES | ENT_DISALLOWED, 'UTF-8', FALSE );
}
$i++;
}
@@ -696,43 +763,43 @@ trait Reactable
/* If there's people to display in the secondary view, add that */
if ( $andXOthers )
{
if ( \count( $peopleToDisplayInSecondaryView ) < $andXOthers )
if ( count( $peopleToDisplayInSecondaryView ) < $andXOthers )
{
$peopleToDisplayInSecondaryView[] = \IPS\Member::loggedIn()->language()->addToStack( "{$langPrefix}blurb_others_secondary", FALSE, array( 'pluralize' => array( $andXOthers - \count( $peopleToDisplayInSecondaryView ) ) ) );
$peopleToDisplayInSecondaryView[] = Member::loggedIn()->language()->addToStack( "{$langPrefix}blurb_others_secondary", FALSE, array( 'pluralize' => array( $andXOthers - count( $peopleToDisplayInSecondaryView ) ) ) );
}
$peopleToDisplayInMainView[] = \IPS\Theme::i()->getTemplate( 'global', 'core', 'front' )->reputationOthers( $this->url( 'showReactions' ), \IPS\Member::loggedIn()->language()->addToStack( "{$langPrefix}blurb_others", FALSE, array( 'pluralize' => array( $andXOthers ) ) ), json_encode( $peopleToDisplayInSecondaryView ) );
$peopleToDisplayInMainView[] = Theme::i()->getTemplate( 'global', 'core', 'front' )->reputationOthers( $this->url( 'showReactions' ), Member::loggedIn()->language()->addToStack( "{$langPrefix}blurb_others", FALSE, array( 'pluralize' => array( $andXOthers ) ) ), json_encode( $peopleToDisplayInSecondaryView ) );
}
/* Put it all together */
$this->likeBlurb = \IPS\Member::loggedIn()->language()->addToStack( "{$langPrefix}blurb", FALSE, array( 'pluralize' => array( $numberOfLikes ), 'htmlsprintf' => array( \IPS\Member::loggedIn()->language()->formatList( $peopleToDisplayInMainView ) ) ) );
$this->likeBlurb[$blurbKey] = Member::loggedIn()->language()->addToStack( "{$langPrefix}blurb", FALSE, array( 'pluralize' => array( $numberOfLikes ), 'htmlsprintf' => array( Member::loggedIn()->language()->formatList( $peopleToDisplayInMainView ) ) ) );
}
}
/* Nobody liked it - show nothing */
else
{
$this->likeBlurb = '';
$this->likeBlurb[$blurbKey] = '';
}
}
return $this->likeBlurb;
return $this->likeBlurb[$blurbKey];
}
/**
* Return boolean indicating if *any* reaction elements are available to the user
* Provides a convenient way of reducing logic in frontend templates rather than having to check every condition.
*
* @return boolean
* @return bool
*/
public function hasReactionBar()
public function hasReactionBar(): bool
{
/* If we're in count mode and have > 0 */
if ( \IPS\Settings::i()->reaction_count_display == 'count' && $this->reactionCount() )
if ( Settings::i()->reaction_count_display == 'count' && $this->reactionCount() )
{
return TRUE;
}
/* Not in count mode and have some blurb to show */
if( \IPS\Settings::i()->reaction_count_display !== 'count' && $this->reactBlurb() && \count( $this->reactBlurb() ) )
if( Settings::i()->reaction_count_display !== 'count' && $this->reactBlurb() && count( $this->reactBlurb() ) )
{
return TRUE;
}