Version 5.0.0 beta 1

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

No files matched your search

@@ -0,0 +1,301 @@
<?php
/**
* @brief Achievement Action Extension
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
* @subpackage Commerce
* @since 16 Mar 2023
*/
namespace IPS\nexus\extensions\core\AchievementAction;
/* To prevent PHP errors (extending class does not exist) revealing path */
use IPS\core\Achievements\Actions\AchievementActionAbstract;
use IPS\core\Achievements\Rule;
use IPS\Db;
use IPS\Db\Select;
use IPS\Helpers\Form\Node;
use IPS\Helpers\Form\Number;
use IPS\Http\Url;
use IPS\Member;
use IPS\nexus\Donation\Goal;
use IPS\Theme;
use OutOfRangeException;
use function count;
use function defined;
use function in_array;
use function is_array;
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ($_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0') . ' 403 Forbidden' );
exit;
}
/**
* Achievement Action Extension
*/
class Donation extends AchievementActionAbstract // NOTE: Other classes exist to provided bases for common situations, like where node-based filters will be required
{
/**
* Get filter form elements
*
* @param array|NULL $filters Current filter values (if editing)
* @param Url $url The URL the form is being shown on
* @return array
*/
public function filters( ?array $filters, Url $url ): array
{
$return = array();
$return['nodes'] = new Node( 'achievement_filter_Donation_nodes', ( $filters and isset( $filters['nodes'] ) and $filters['nodes'] ) ? $filters['nodes'] : 0, FALSE, [
'url' => $url,
'class' => 'IPS\nexus\Donation\Goal',
'showAllNodes' => TRUE,
'multiple' => TRUE,
], NULL, Member::loggedIn()->language()->addToStack( 'achievement_filter_NewContentItem_node_prefix', FALSE, [ 'sprintf' => [
Member::loggedIn()->language()->addToStack( 'donation_lc', FALSE ),
Member::loggedIn()->language()->addToStack( 'goals_sg', FALSE, [ 'strtolower' => TRUE ] )
] ] ) );
$return['nodes']->label = Member::loggedIn()->language()->addToStack( 'achievement_filter_NewContentItem_node', FALSE, [ 'sprintf' => [ Member::loggedIn()->language()->addToStack( 'goals_sg', FALSE, [ 'strtolower' => TRUE ] ) ] ] );
$return['milestone'] = new Number( 'achievement_filter_Donation_nth', ( $filters and isset( $filters['milestone'] ) and $filters['milestone'] ) ? $filters['milestone'] : 0, FALSE, [], NULL, Member::loggedIn()->language()->addToStack('achievement_filter_nth_their'), Member::loggedIn()->language()->addToStack('achievement_filter_Donation_nth_suffix') );
$return['milestone']->label = Member::loggedIn()->language()->addToStack('achievement_filter_NewContentItem_nth');
return $return;
}
/**
* Format filter form values
*
* @param array $values The values from the form
* @return array
*/
public function formatFilterValues( array $values ): array
{
$return = [];
if ( isset( $values['achievement_filter_Donation_nodes'] ) )
{
$return['nodes'] = array_keys( $values['achievement_filter_Donation_nodes'] );
}
if ( isset( $values['achievement_filter_Donation_nth'] ) )
{
$return['milestone'] = $values['achievement_filter_Donation_nth'];
}
return $return;
}
/**
* Work out if the filters applies for a given action
*
* Important note for milestones: consider the context. This method is called by \IPS\Member::achievementAction(). If your code
* calls that BEFORE making its change in the database (or there is read/write separation), you will need to add
* 1 to the value being considered for milestones
*
* @param Member $subject The subject member
* @param array $filters The value returned by formatFilterValues()
* @param mixed $extra Any additional information about what is happening (e.g. if a post is being made: the post object)
* @return bool
*/
public function filtersMatch( Member $subject, array $filters, mixed $extra = NULL ): bool
{
if ( isset( $filters['nodes'] ) )
{
if ( !in_array( $extra->_id, $filters['nodes'] ) )
{
return FALSE;
}
}
if ( isset( $filters['milestone'] ) )
{
$query = $this->getQuery( 'COUNT(*)', [ [ 'dl_member=?', $subject->member_id ] ], NULL, NULL, $filters );
if ( $query->first() + 1 < $filters['milestone'] )
{
return FALSE;
}
}
return TRUE;
}
/**
* Get the labels for the people this action might give awards to
*
* @param array|NULL $filters Current filter values
*
* @return array
*/
public function awardOptions( ?array $filters ): array
{
return [
'subject' => 'achievement_filter_Donation_donor',
];
}
/**
* Get identifier to prevent the member being awarded points for the same action twice
* Must be unique within within of this domain, must not exceed 32 chars.
*
* @param Member $subject The subject member
* @param mixed $extra Any additional information about what is happening (e.g. if a post is being made: the post object)
* @return string
*/
public function identifier( Member $subject, mixed $extra = NULL ): string
{
return 'Donation:' . $extra->id . ':' . $subject->member_id;
}
/**
* Return a description for this action to show in the log
*
* @param string $identifier The identifier as returned by identifier()
* @param array $actor If the member was the "subject", "other", or both
* @return string
*/
public function logRow( string $identifier, array $actor ): string
{
$exploded = explode( ':', $identifier );
try
{
$goal = Goal::load( $exploded[1] );
$sprintf = [ 'htmlsprintf' => [
Theme::i()->getTemplate( 'global', 'core', 'global' )->basicUrl( $goal->url(), TRUE, '@todo goal title', FALSE )
] ];
}
catch ( OutOfRangeException )
{
$sprintf = [ 'sprintf' => [ Member::loggedIn()->language()->addToStack('modcp_deleted') ] ];
}
return Member::loggedIn()->language()->addToStack( 'AchievementAction__Donation_log', FALSE, $sprintf );
}
/**
* Get "description" for rule
*
* @param Rule $rule The rule
* @return string|NULL
*/
public function ruleDescription( Rule $rule ): ?string
{
$conditions = [];
if ( isset( $rule->filters['milestone'] ) )
{
$conditions[] = Member::loggedIn()->language()->addToStack( 'achievements_title_filter_milestone', FALSE, [
'htmlsprintf' => [
Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'milestone', Member::loggedIn()->language()->addToStack( 'achievements_title_filter_milestone_nth', FALSE, [ 'pluralize' => [ $rule->filters['milestone'] ] ] ) )
],
'sprintf' => [ Member::loggedIn()->language()->addToStack('donation_lc') ]
] );
}
if ( $nodeCondition = $this->_nodeFilterDescription( $rule ) )
{
$conditions[] = $nodeCondition;
}
return Theme::i()->getTemplate( 'achievements' )->ruleDescription(
Member::loggedIn()->language()->addToStack( 'AchievementAction__Donation_title' ),
$conditions
);
}
/**
* Get "description" for rule (usually a description of the rule's filters)
*
* @param Rule $rule The rule
* @return string|NULL
*/
protected function _nodeFilterDescription( Rule $rule ): ?string
{
if ( isset( $rule->filters['nodes'] ) )
{
$nodeNames = [];
foreach ( $rule->filters['nodes'] as $id )
{
try
{
$nodeNames[] = Goal::load( $id )->_title; //@todo
}
catch ( OutOfRangeException ) {}
}
if ( $nodeNames )
{
return Member::loggedIn()->language()->addToStack( 'achievements_title_filter_location', FALSE, [
'htmlsprintf' => [
Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'location',
count( $nodeNames ) === 1 ? $nodeNames[0] : Member::loggedIn()->language()->addToStack( 'achievements_title_filter_location_val', FALSE, [ 'sprintf' => [
count( $nodeNames ),
Member::loggedIn()->language()->addToStack( 'goals', FALSE, [ 'strtolower' => TRUE ] ) //@todo
] ] ),
count( $nodeNames ) === 1 ? NULL : $nodeNames
)
],
] );
}
}
return NULL;
}
/**
* Get a query to use for multiple methods within this extension
* @param string $select Select for the query
* @param array|NULL $where Where for the query
* @param int|NULL $limit Limit for the query
* @param string|NULL $order Order by for the query
* @param array $filters Rule filters
* @return Select
*/
public function getQuery( string $select, ?array $where, ?int $limit, ?string $order, array $filters ): Select
{
$joinContainers = FALSE;
$extraJoinCondition = NULL;
$where = is_array( $where ) ? $where : array();
/* Limit by node */
if ( isset( $filters['nodes'] ) )
{
$joinContainers = TRUE;
$extraJoinCondition = ' AND ' . Db::i()->in( 'nexus_donate_logs.dl_goal', $filters['nodes'] );
}
$query = Db::i()->select( $select, 'nexus_donate_logs', $where, $order, $limit );
if ( $joinContainers )
{
$query->join( 'nexus_donate_goals', 'nexus_donate_logs.dl_goal=nexus_donate_goals.d_id' . $extraJoinCondition, 'INNER' );
}
return $query;
}
/**
* Get rebuild data
*
* @return array
*/
static public function rebuildData(): array
{
return [ [
'table' => 'nexus_donate_logs',
'pkey' => 'dl_id'
] ];
}
/**
* Process the rebuild row
*
* @param array $row Row from database
* @param array $data Data collected when starting rebuild [table, pkey...]
* @return void
*/
public static function rebuildRow( array $row, array $data ) : void
{
Member::load( $row['dl_member'] )->achievementAction( 'nexus', 'Donation', [ Goal::load( $row['dl_goal'] ) ] );
}
}
@@ -11,41 +11,58 @@
namespace IPS\nexus\extensions\core\AchievementAction;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use IPS\core\Achievements\Actions\AchievementActionAbstract;
use IPS\core\Achievements\Rule;
use IPS\Db;
use IPS\Helpers\Form\Node;
use IPS\Helpers\Form\Number;
use IPS\Http\Url;
use IPS\Member;
use IPS\nexus\Package as NexusPackage;
use IPS\nexus\Package\Group;
use IPS\Theme;
use OutOfRangeException;
use function count;
use function defined;
use function in_array;
use function is_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;
}
/**
* Achievement Action Extension
*/
class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction // NOTE: Other classes exist to provided bases for common situations, like where node-based filters will be required
class Package extends AchievementActionAbstract // NOTE: Other classes exist to provided bases for common situations, like where node-based filters will be required
{
/**
* Get filter form elements
*
* @param array|NULL $filters Current filter values (if editing)
* @param \IPS\Http\Url $url The URL the form is being shown on
* @param Url $url The URL the form is being shown on
* @return array
*/
public function filters( ?array $filters, \IPS\Http\Url $url ): array
public function filters( ?array $filters, Url $url ): array
{
$return = array();
$return['nodes'] = new \IPS\Helpers\Form\Node( 'achievement_filter_Package', ( $filters and isset( $filters['nodes'] ) and $filters['nodes'] ) ? $filters['nodes'] : 0, FALSE, [
$return['nodes'] = new Node( 'achievement_filter_Package', ( $filters and isset( $filters['nodes'] ) and $filters['nodes'] ) ? $filters['nodes'] : 0, FALSE, [
'url' => $url,
'class' => 'IPS\nexus\Package\Group',
'subnodes' => FALSE,
'showAllNodes' => TRUE,
'multiple' => TRUE
], NULL, \IPS\Member::loggedIn()->language()->addToStack( 'achievement_filter_Package_node_prefix', FALSE, [ 'sprintf' => [
\IPS\Member::loggedIn()->language()->addToStack( 'nexus_sub_package_id', FALSE ),
\IPS\Member::loggedIn()->language()->addToStack( 'purchase_groups_lc', FALSE )
], NULL, Member::loggedIn()->language()->addToStack( 'achievement_filter_Package_node_prefix', FALSE, [ 'sprintf' => [
Member::loggedIn()->language()->addToStack( 'nexus_sub_package_id', FALSE ),
Member::loggedIn()->language()->addToStack( 'purchase_groups_lc', FALSE )
] ] ) );
$return['milestone'] = new \IPS\Helpers\Form\Number( 'achievement_filter_Package_nth', ( $filters and isset( $filters['milestone'] ) and $filters['milestone'] ) ? $filters['milestone'] : 0, FALSE, [], NULL, \IPS\Member::loggedIn()->language()->addToStack('achievement_filter_nth_their'), \IPS\Member::loggedIn()->language()->addToStack('achievement_filter_Package_nth_suffix') );
$return['milestone']->label = \IPS\Member::loggedIn()->language()->addToStack('achievement_filter_NewContentItem_nth');
$return['milestone'] = new Number( 'achievement_filter_Package_nth', ( $filters and isset( $filters['milestone'] ) and $filters['milestone'] ) ? $filters['milestone'] : 0, FALSE, [], NULL, Member::loggedIn()->language()->addToStack('achievement_filter_nth_their'), Member::loggedIn()->language()->addToStack('achievement_filter_Package_nth_suffix') );
$return['milestone']->label = Member::loggedIn()->language()->addToStack('achievement_filter_NewContentItem_nth');
return $return;
}
@@ -63,7 +80,7 @@ class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction
{
$return['nodes'] = [];
if ( \is_array( $values['achievement_filter_Package'] ) )
if ( is_array( $values['achievement_filter_Package'] ) )
{
foreach ( $values['achievement_filter_Package'] as $node )
{
@@ -85,16 +102,16 @@ class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction
* calls that BEFORE making its change in the database (or there is read/write separation), you will need to add
* 1 to the value being considered for milestones
*
* @param \IPS\Member $subject The subject member
* @param Member $subject The subject member
* @param array $filters The value returned by formatFilterValues()
* @param mixed $extra Any additional information about what is happening (e.g. if a post is being made: the post object)
* @return bool
*/
public function filtersMatch( \IPS\Member $subject, array $filters, $extra = NULL ): bool
public function filtersMatch( Member $subject, array $filters, mixed $extra = NULL ): bool
{
if ( isset( $filters['nodes'] ) and \is_array( $filters['nodes'] ) and \count( $filters['nodes'] ) )
if ( isset( $filters['nodes'] ) and is_array( $filters['nodes'] ) and count( $filters['nodes'] ) )
{
if ( !\in_array( $extra->item()->container()->_id, $filters['nodes'] ) )
if ( !in_array( $extra->item()->container()->_id, $filters['nodes'] ) )
{
return FALSE;
}
@@ -102,7 +119,7 @@ class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction
if ( isset( $filters['milestone'] ) )
{
if ( \IPS\Db::i()->select( 'COUNT(*)', 'nexus_purchases', [ 'ps_cancelled !=1 AND ps_member=?', $subject->member_id ] )->first() < $filters['milestone'] )
if ( Db::i()->select( 'COUNT(*)', 'nexus_purchases', [ 'ps_cancelled !=1 AND ps_member=?', $subject->member_id ] )->first() < $filters['milestone'] )
{
return FALSE;
}
@@ -115,11 +132,11 @@ class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction
* Get identifier to prevent the member being awarded points for the same action twice
* Must be unique within within of this domain, must not exceed 32 chars.
*
* @param \IPS\Member $subject The subject member
* @param Member $subject The subject member
* @param mixed $extra Any additional information about what is happening (e.g. if a post is being made: the post object)
* @return string
*/
public function identifier( \IPS\Member $subject, $extra = NULL ): string
public function identifier( Member $subject, mixed $extra = NULL ): string
{
return $extra->id . '.' . $subject->member_id;
}
@@ -136,35 +153,35 @@ class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction
try
{
list( $identifier, $memberId ) = explode( '.', $identifier );
$package = \IPS\nexus\Package::load( $identifier );
$package = NexusPackage::load( $identifier );
$sprintf = [ 'htmlsprintf' => [
\IPS\Theme::i()->getTemplate( 'global', 'core', 'global' )->basicUrl( $package->url(), TRUE, $package->_title, FALSE )
Theme::i()->getTemplate( 'global', 'core', 'global' )->basicUrl( $package->url(), TRUE, $package->_title, FALSE )
] ];
}
catch ( \OutOfRangeException $e )
catch ( OutOfRangeException )
{
$sprintf = [ 'sprintf' => [ \IPS\Member::loggedIn()->language()->addToStack('modcp_deleted') ] ];
$sprintf = [ 'sprintf' => [ Member::loggedIn()->language()->addToStack('modcp_deleted') ] ];
}
return \IPS\Member::loggedIn()->language()->addToStack( 'AchievementAction__Package_log', FALSE, $sprintf );
return Member::loggedIn()->language()->addToStack( 'AchievementAction__Package_log', FALSE, $sprintf );
}
/**
* Get "description" for rule
*
* @param \IPS\core\Achievements\Rule $rule The rule
* @param Rule $rule The rule
* @return string|NULL
*/
public function ruleDescription( \IPS\core\Achievements\Rule $rule ): ?string
public function ruleDescription( Rule $rule ): ?string
{
$conditions = [];
if ( isset( $rule->filters['milestone'] ) )
{
$conditions[] = \IPS\Member::loggedIn()->language()->addToStack( 'achievements_title_filter_milestone', FALSE, [
$conditions[] = Member::loggedIn()->language()->addToStack( 'achievements_title_filter_milestone', FALSE, [
'htmlsprintf' => [
\IPS\Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'milestone', \IPS\Member::loggedIn()->language()->addToStack( 'achievements_title_filter_milestone_nth', FALSE, [ 'pluralize' => [ $rule->filters['milestone'] ] ] ) )
Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'milestone', Member::loggedIn()->language()->addToStack( 'achievements_title_filter_milestone_nth', FALSE, [ 'pluralize' => [ $rule->filters['milestone'] ] ] ) )
],
'sprintf' => [ \IPS\Member::loggedIn()->language()->addToStack('AchievementAction__Package_title_generic') ]
'sprintf' => [ Member::loggedIn()->language()->addToStack('AchievementAction__Package_title_generic') ]
] );
}
@@ -173,8 +190,8 @@ class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction
$conditions[] = $nodeCondition;
}
return \IPS\Theme::i()->getTemplate( 'achievements' )->ruleDescription(
\IPS\Member::loggedIn()->language()->addToStack( 'AchievementAction__Package_title' ),
return Theme::i()->getTemplate( 'achievements' )->ruleDescription(
Member::loggedIn()->language()->addToStack( 'AchievementAction__Package_title' ),
$conditions
);
}
@@ -182,10 +199,10 @@ class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction
/**
* Get "description" for rule (usually a description of the rule's filters)
*
* @param \IPS\core\Achievements\Rule $rule The rule
* @param Rule $rule The rule
* @return string|NULL
*/
protected function _nodeFilterDescription( \IPS\core\Achievements\Rule $rule ): ?string
protected function _nodeFilterDescription( Rule $rule ): ?string
{
if ( isset( $rule->filters['nodes'] ) )
{
@@ -194,20 +211,20 @@ class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction
{
try
{
$nodeNames[] = \IPS\nexus\Package\Group::load( $id )->_title;
$nodeNames[] = Group::load( $id )->_title;
}
catch ( \OutOfRangeException $e ) {}
catch ( OutOfRangeException ) {}
}
if ( $nodeNames )
{
return \IPS\Member::loggedIn()->language()->addToStack( 'achievements_title_filter_location', FALSE, [
return Member::loggedIn()->language()->addToStack( 'achievements_title_filter_location', FALSE, [
'htmlsprintf' => [
\IPS\Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'location',
\count( $nodeNames ) === 1 ? $nodeNames[0] : \IPS\Member::loggedIn()->language()->addToStack( 'achievements_title_filter_location_val', FALSE, [ 'sprintf' => [
\count( $nodeNames ),
\IPS\Member::loggedIn()->language()->addToStack( 'purchase_groups_lc', FALSE )
Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'location',
count( $nodeNames ) === 1 ? $nodeNames[0] : Member::loggedIn()->language()->addToStack( 'achievements_title_filter_location_val', FALSE, [ 'sprintf' => [
count( $nodeNames ),
Member::loggedIn()->language()->addToStack( 'purchase_groups_lc', FALSE )
] ] ),
\count( $nodeNames ) === 1 ? NULL : $nodeNames
count( $nodeNames ) === 1 ? NULL : $nodeNames
)
],
] );
@@ -222,7 +239,7 @@ class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction
*
* @return array
*/
static public function rebuildData()
static public function rebuildData(): array
{
return [ [
'table' => 'nexus_purchases',
@@ -239,9 +256,9 @@ class _Package extends \IPS\core\Achievements\Actions\AbstractAchievementAction
* @param array $data Data collected when starting rebuild [table, pkey...]
* @return void
*/
public static function rebuildRow( $row, $data )
public static function rebuildRow( array $row, array $data ) : void
{
\IPS\Member::load( $row['ps_member'] )->achievementAction( 'nexus', 'Package', \IPS\nexus\Package::load( $row['ps_item_id'] ) );
Member::load( $row['ps_member'] )->achievementAction( 'nexus', 'Package', NexusPackage::load( $row['ps_item_id'] ) );
}
}
@@ -11,16 +11,32 @@
namespace IPS\nexus\extensions\core\AchievementAction;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use IPS\core\Achievements\Actions\AchievementActionAbstract;
use IPS\core\Achievements\Rule;
use IPS\Helpers\Form\Node;
use IPS\Helpers\Form\YesNo;
use IPS\Http\Url;
use IPS\Member;
use IPS\nexus\Subscription as NexusSubscription;
use IPS\nexus\Subscription\Package;
use IPS\Settings;
use IPS\Theme;
use OutOfRangeException;
use function count;
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;
}
/**
* Achievement Action Extension
*/
class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAction // NOTE: Other classes exist to provided bases for common situations, like where node-based filters will be required
class Subscription extends AchievementActionAbstract // NOTE: Other classes exist to provided bases for common situations, like where node-based filters will be required
{
/**
* Can use this rule?
@@ -29,32 +45,32 @@ class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAc
*/
public function canUse(): bool
{
return (bool) parent::canUse() and \IPS\Settings::i()->nexus_subs_enabled;
return parent::canUse() and Settings::i()->nexus_subs_enabled;
}
/**
* Get filter form elements
*
* @param array|NULL $filters Current filter values (if editing)
* @param \IPS\Http\Url $url The URL the form is being shown on
* @param Url $url The URL the form is being shown on
* @return array
*/
public function filters( ?array $filters, \IPS\Http\Url $url ): array
public function filters( ?array $filters, Url $url ): array
{
$return = array();
$return['subscriptions'] = new \IPS\Helpers\Form\Node( 'achievement_filter_Subscriptions', ( $filters and isset( $filters['subscriptions'] ) and $filters['subscriptions'] ) ? $filters['subscriptions'] : 0, FALSE, [
$return['subscriptions'] = new Node( 'achievement_filter_Subscriptions', ( $filters and isset( $filters['subscriptions'] ) and $filters['subscriptions'] ) ? $filters['subscriptions'] : 0, FALSE, [
'url' => $url,
'class' => 'IPS\nexus\Subscription\Package',
'showAllNodes' => TRUE,
'multiple' => TRUE,
], NULL, \IPS\Member::loggedIn()->language()->addToStack( 'achievement_filter_Subscriptions_node_prefix', FALSE, [ 'sprintf' => [
\IPS\Member::loggedIn()->language()->addToStack( 'nexus_sub_package_id', FALSE ),
\IPS\Member::loggedIn()->language()->addToStack( 'calendars_sg', FALSE, [ 'strtolower' => TRUE ] )
], NULL, Member::loggedIn()->language()->addToStack( 'achievement_filter_Subscriptions_node_prefix', FALSE, [ 'sprintf' => [
Member::loggedIn()->language()->addToStack( 'nexus_sub_package_id', FALSE ),
Member::loggedIn()->language()->addToStack( 'calendars_sg', FALSE, [ 'strtolower' => TRUE ] )
] ] ) );
$return['subscriptions_active'] = new \IPS\Helpers\Form\YesNo( 'achievement_filter_Subscriptions_active', $filters and isset( $filters['subscriptions_active'] ) and $filters['subscriptions_active'], FALSE, [],NULL,
\IPS\Member::loggedIn()->language()->addToStack( 'nexus_sub_active', FALSE )
$return['subscriptions_active'] = new YesNo( 'achievement_filter_Subscriptions_active', $filters and isset( $filters['subscriptions_active'] ) and $filters['subscriptions_active'], FALSE, [],NULL,
Member::loggedIn()->language()->addToStack( 'nexus_sub_active', FALSE )
);
return $return;
@@ -87,16 +103,16 @@ class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAc
* calls that BEFORE making its change in the database (or there is read/write separation), you will need to add
* 1 to the value being considered for milestones
*
* @param \IPS\Member $subject The subject member
* @param Member $subject The subject member
* @param array $filters The value returned by formatFilterValues()
* @param mixed $extra Any additional information about what is happening (e.g. if a post is being made: the post object)
* @return bool
*/
public function filtersMatch( \IPS\Member $subject, array $filters, $extra = NULL ): bool
public function filtersMatch( Member $subject, array $filters, mixed $extra = NULL ): bool
{
if ( isset( $filters['subscriptions'] ) )
{
if ( !\in_array( $extra->package_id, $filters['subscriptions'] ) )
if ( !in_array( $extra->package_id, $filters['subscriptions'] ) )
{
return FALSE;
}
@@ -108,12 +124,12 @@ class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAc
{
try
{
\IPS\nexus\Subscription::loadByMemberAndPackage( $subject, \IPS\nexus\Subscription\Package::load( $id ), TRUE );
NexusSubscription::loadByMemberAndPackage( $subject, Package::load( $id ), TRUE );
/* Still here? */
return TRUE;
}
catch ( \OutOfRangeException $e ) { }
catch ( OutOfRangeException ) { }
}
/* No active matches */
@@ -127,11 +143,11 @@ class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAc
* Get identifier to prevent the member being awarded points for the same action twice
* Must be unique within within of this domain, must not exceed 32 chars.
*
* @param \IPS\Member $subject The subject member
* @param Member $subject The subject member
* @param mixed $extra Any additional information about what is happening (e.g. if a post is being made: the post object)
* @return string
*/
public function identifier( \IPS\Member $subject, $extra = NULL ): string
public function identifier( Member $subject, mixed $extra = NULL ): string
{
return (string) $extra->id;
}
@@ -151,20 +167,20 @@ class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAc
/**
* Get "description" for rule
*
* @param \IPS\core\Achievements\Rule $rule The rule
* @param Rule $rule The rule
* @return string|NULL
*/
public function ruleDescription( \IPS\core\Achievements\Rule $rule ): ?string
public function ruleDescription( Rule $rule ): ?string
{
$conditions = [];
if ( isset( $rule->filters['subscriptions_active'] ) AND $rule->filters['subscriptions_active'] )
{
$conditions[] = \IPS\Member::loggedIn()->language()->addToStack( 'achievement_filter_Subscriptions_active');
$conditions[] = Member::loggedIn()->language()->addToStack( 'achievement_filter_Subscriptions_active');
}
else
{
$conditions[] = \IPS\Member::loggedIn()->language()->addToStack( 'achievement_filter_Subscriptions_node_prefix');
$conditions[] = Member::loggedIn()->language()->addToStack( 'achievement_filter_Subscriptions_node_prefix');
}
if ( $nodeCondition = $this->_nodeFilterDescription( $rule ) )
@@ -172,8 +188,8 @@ class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAc
$conditions[] = $nodeCondition;
}
return \IPS\Theme::i()->getTemplate( 'achievements' )->ruleDescription(
\IPS\Member::loggedIn()->language()->addToStack( 'AchievementAction__Subscription_title' ),
return Theme::i()->getTemplate( 'achievements' )->ruleDescription(
Member::loggedIn()->language()->addToStack( 'AchievementAction__Subscription_title' ),
$conditions
);
}
@@ -181,10 +197,10 @@ class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAc
/**
* Get "description" for rule (usually a description of the rule's filters)
*
* @param \IPS\core\Achievements\Rule $rule The rule
* @param Rule $rule The rule
* @return string|NULL
*/
protected function _nodeFilterDescription( \IPS\core\Achievements\Rule $rule ): ?string
protected function _nodeFilterDescription( Rule $rule ): ?string
{
if ( isset( $rule->filters['subscriptions'] ) )
{
@@ -193,21 +209,21 @@ class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAc
{
try
{
$nodeNames[] = \IPS\nexus\Subscription\Package::load( $id )->_title;
$nodeNames[] = Package::load( $id )->_title;
}
catch ( \OutOfRangeException $e ) {}
catch ( OutOfRangeException ) {}
}
if ( $nodeNames )
{
return \IPS\Member::loggedIn()->language()->addToStack( 'achievements_filter_Subscription_type', FALSE, [
return Member::loggedIn()->language()->addToStack( 'achievements_filter_Subscription_type', FALSE, [
'htmlsprintf' => [
\IPS\Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'achievements_filter_Subscription_type',
\count( $nodeNames ) === 1 ? $nodeNames[0] : \IPS\Member::loggedIn()->language()->addToStack( 'achievements_filter_Subscription_pl', FALSE, [ 'sprintf' => [
\count( $nodeNames ),
\IPS\Member::loggedIn()->language()->addToStack( 'nexus_sub_package_id', FALSE, [ 'strtolower' => TRUE ] )
Theme::i()->getTemplate( 'achievements' )->ruleDescriptionBadge( 'achievements_filter_Subscription_type',
count( $nodeNames ) === 1 ? $nodeNames[0] : Member::loggedIn()->language()->addToStack( 'achievements_filter_Subscription_pl', FALSE, [ 'sprintf' => [
count( $nodeNames ),
Member::loggedIn()->language()->addToStack( 'nexus_sub_package_id', FALSE, [ 'strtolower' => TRUE ] )
] ] ),
\count( $nodeNames ) === 1 ? NULL : $nodeNames
count( $nodeNames ) === 1 ? NULL : $nodeNames
)
],
] );
@@ -222,7 +238,7 @@ class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAc
*
* @return array
*/
static public function rebuildData()
static public function rebuildData(): array
{
return [ [
'table' => 'nexus_member_subscriptions',
@@ -239,9 +255,9 @@ class _Subscription extends \IPS\core\Achievements\Actions\AbstractAchievementAc
* @param array $data Data collected when starting rebuild [table, pkey...]
* @return void
*/
public static function rebuildRow( $row, $data )
public static function rebuildRow( array $row, array $data ) : void
{
\IPS\Member::load( $row['sub_member_id'] )->achievementAction( 'nexus', 'Subscription', \IPS\nexus\Subscription::load( $row['sub_id'] ) );
Member::load( $row['sub_member_id'] )->achievementAction( 'nexus', 'Subscription', NexusSubscription::load( $row['sub_id'] ) );
}
}