72 lines
1.8 KiB
PHP
72 lines
1.8 KiB
PHP
<?php
|
|
/**
|
|
* @brief clearfeaturedevents 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}
|
|
* @since 03 Nov 2025
|
|
*/
|
|
|
|
namespace IPS\calendar\tasks;
|
|
|
|
use IPS\calendar\Event;
|
|
use IPS\Task;
|
|
use IPS\Task\Exception as TaskException;
|
|
use function defined;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* clearfeaturedevents Task
|
|
*/
|
|
class clearfeaturedevents extends Task
|
|
{
|
|
/**
|
|
* Execute
|
|
*
|
|
* If ran successfully, should return anything worth logging. Only log something
|
|
* worth mentioning (don't log "task ran successfully"). Return NULL (actual NULL, not '' or 0) to not log (which will be most cases).
|
|
* If an error occurs which means the task could not finish running, throw an \IPS\Task\Exception - do not log an error as a normal log.
|
|
* Tasks should execute within the time of a normal HTTP request.
|
|
*
|
|
* @return mixed Message to log or NULL
|
|
* @throws TaskException
|
|
*/
|
|
public function execute() : mixed
|
|
{
|
|
$log = "";
|
|
$featured = iterator_to_array( Event::featured( null ) );
|
|
foreach( $featured as $event )
|
|
{
|
|
/* @var Event $event */
|
|
if( $event->hasPassed() )
|
|
{
|
|
$event->setFeatured( false );
|
|
$log .= "Unfeatured event {$event->id}; ";
|
|
}
|
|
}
|
|
|
|
return $log ?: null;
|
|
}
|
|
|
|
/**
|
|
* Cleanup
|
|
*
|
|
* If your task takes longer than 15 minutes to run, this method
|
|
* will be called before execute(). Use it to clean up anything which
|
|
* may not have been done
|
|
*
|
|
* @return void
|
|
*/
|
|
public function cleanup() : void
|
|
{
|
|
|
|
}
|
|
} |