83 lines
2.4 KiB
PHP
83 lines
2.4 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 Downloads
|
|
* @since 23 Sep 2014
|
|
*/
|
|
|
|
namespace IPS\downloads\extensions\core\Queue;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
|
|
use IPS\downloads\Category;
|
|
use IPS\downloads\File;
|
|
use IPS\Extensions\QueueAbstract;
|
|
use IPS\Member;
|
|
use IPS\Theme;
|
|
use OutOfRangeException;
|
|
use function defined;
|
|
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Background Task
|
|
*/
|
|
class Follow extends QueueAbstract
|
|
{
|
|
/**
|
|
* 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
|
|
{
|
|
$category = Category::load( $data['category_id'] );
|
|
$member = Member::load( $data['member_id'] );
|
|
$newOffset = File::_sendNotificationsBatch( $category, $member, $offset );
|
|
|
|
if( $newOffset === NULL )
|
|
{
|
|
throw new \IPS\Task\Queue\OutOfRangeException;
|
|
}
|
|
|
|
return $newOffset;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
{
|
|
$category = Category::load( $data['category_id'] );
|
|
$complete = $data['followerCount'] ? round( 100 / $data['followerCount'] * $offset, 2 ) : 100;
|
|
|
|
return array( 'text' => Member::loggedIn()->language()->addToStack('backgroundQueue_follow', FALSE, array( 'htmlsprintf' => array( Theme::i()->getTemplate( 'global', 'core', 'global' )->basicUrl( $category->url(), TRUE, $category->_title, FALSE ) ) ) ), 'complete' => $complete );
|
|
}
|
|
|
|
/**
|
|
* Parse data before queuing
|
|
*
|
|
* @param array $data
|
|
* @return array|null
|
|
*/
|
|
public function preQueueData( array $data ): ?array
|
|
{
|
|
return $data;
|
|
}
|
|
} |