Version 4.7.0

applications/core/tasks/weeklyStreamSubscriptions.php

@@ -0,0 +1,68 @@
+<?php
+/**
+ * @brief		weeklyStreamSubscriptions 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
+ * @since		30 Jul 2021
+ */
+
+namespace IPS\core\tasks;
+
+/* To prevent PHP errors (extending class does not exist) revealing path */
+if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
+{
+	header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
+	exit;
+}
+
+/**
+ * weeklyStreamSubscriptions Task
+ */
+class _weeklyStreamSubscriptions extends \IPS\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	\IPS\Task\Exception
+	 */
+	public function execute()
+	{
+		/* Disable task if no subscriptions */
+		$select = \IPS\Db::i()->select( '*', 'core_stream_subscriptions', array( 'frequency=?', 'weekly' ));
+		if( !$select->count() )
+		{
+			$this->enabled = FALSE;
+			$this->save();
+
+			return NULL;
+		}
+
+		$this->runUntilTimeout( function()
+		{
+			return \IPS\core\Stream\Subscription::sendBatch( 'weekly' );
+		});
+		return 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()
+	{
+		
+	}
+}