109 lines
2.9 KiB
PHP
109 lines
2.9 KiB
PHP
<?php
|
|
/**
|
|
* @brief Background Task
|
|
* @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/
|
|
* @package Invision Community
|
|
* @subpackage Commerce
|
|
* @since 25 Jul 2022
|
|
*/
|
|
|
|
namespace IPS\nexus\extensions\core\Queue;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
|
|
use Exception;
|
|
use IPS\Db;
|
|
use IPS\Extensions\QueueAbstract;
|
|
use IPS\Member;
|
|
use IPS\Patterns\ActiveRecordIterator;
|
|
use OutOfRangeException;
|
|
use function count;
|
|
use function defined;
|
|
use const IPS\REBUILD_SLOW;
|
|
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Background Task
|
|
*/
|
|
class DeleteSubscriptions extends QueueAbstract
|
|
{
|
|
/**
|
|
* Parse data before queuing
|
|
*
|
|
* @param array $data
|
|
* @return array|null
|
|
*/
|
|
public function preQueueData( array $data ): ?array
|
|
{
|
|
try
|
|
{
|
|
$data['count'] = Db::i()->select( 'COUNT(*)', 'nexus_member_subscriptions', [ 'sub_package_id=?', $data['id'] ] )->first();
|
|
}
|
|
catch( Exception )
|
|
{
|
|
return NULL;
|
|
}
|
|
|
|
$data['lastId'] = $data['completed'] = 0;
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Run Background Task
|
|
*
|
|
* @param mixed $data Data as it was passed to \IPS\Task::queue()
|
|
* @param int $offset Offset
|
|
* @return int New offset
|
|
* @throws \IPS\Task\Queue\OutOfRangeException Indicates offset doesn't exist and thus task is complete
|
|
*/
|
|
public function run( array &$data, int $offset ): int
|
|
{
|
|
$query = Db::i()->select( '*', 'nexus_member_subscriptions', [ 'sub_id>? AND sub_package_id=?', $data['lastId'], $data['id'] ], 'sub_id ASC', REBUILD_SLOW );
|
|
if ( !count( $query ) )
|
|
{
|
|
throw new \IPS\Task\Queue\OutOfRangeException;
|
|
}
|
|
|
|
foreach ( new ActiveRecordIterator( $query, 'IPS\nexus\Subscription' ) as $sub )
|
|
{
|
|
$data['completed']++;
|
|
$data['lastId'] = $sub->id;
|
|
$sub->delete();
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Get Progress
|
|
*
|
|
* @param mixed $data Data as it was passed to \IPS\Task::queue()
|
|
* @param int $offset Offset
|
|
* @return array( 'text' => 'Doing something...', 'complete' => 50 ) Text explaining task and percentage complete
|
|
* @throws OutOfRangeException Indicates offset doesn't exist and thus task is complete
|
|
*/
|
|
public function getProgress( mixed $data, int $offset ): array
|
|
{
|
|
return array( 'text' => Member::loggedIn()->language()->addToStack('removing_subscriptions'), 'complete' => $data['count'] ? ( round( 100 / $data['count'] * $data['completed'], 2 ) ) : 100 );
|
|
}
|
|
|
|
/**
|
|
* Perform post-completion processing
|
|
*
|
|
* @param array $data Data returned from preQueueData
|
|
* @param bool $processed Was anything processed or not? If preQueueData returns NULL, this will be FALSE.
|
|
* @return void
|
|
*/
|
|
public function postComplete( array $data, bool $processed = TRUE ) : void
|
|
{
|
|
|
|
}
|
|
} |