Version 4.1.19

applications/core/data/defaults/extensions/BulkMail.txt

@@ -1,10 +1,10 @@
 <?php
 /**
- * @brief		Bulk mail extension
+ * @brief		Bulk Mail Extension
  * @author		<a href='http://www.invisionpower.com'>Invision Power Services, Inc.</a>
- * @copyright	(c) 2001 - SVN_YYYY Invision Power Services, Inc.
+ * @copyright	(c) 2001 - 2016 Invision Power Services, Inc.
  * @license		http://www.invisionpower.com/legal/standards/
- * @package		IPS Social Suite
+ * @package		IPS Community Suite
 {subpackage}
  * @since		{date}
  * @version		SVN_VERSION_NUMBER
@@ -20,54 +20,34 @@ if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
 }
 
 /**
- * Bulk mail extension
+ * Bulk Mail Extension
  */
 class _{class}
 {
 	/** 
-	 * Get Setting Field
+	 * Get tags that can be used in bulk mail
 	 *
-	 * @param	mixed	$criteria	Value returned from the save() method
-	 * @return	array 	Array of form elements
+	 * @return	array
 	 */
-	public function getSettingField( $criteria )
+	public function getTags()
 	{
-		return array();
+		return array(
+			'{some_tag}'	=> 'Explanation of tag',
+		);
 	}
 	
-	/**
-	 * Save the filter data
+	/** 
+	 * Get value for tags
 	 *
-	 * @param	array	$post	Form values
-	 * @return	mixed			False, or an array of data to use later when filtering the members
-	 * @throws \LogicException
+	 * @param	string				$content	Bulk Mail Content (passed in case a particular tag is computationally expensive so that the extension may "sniff" for it and elect not to perform the computation if it is not used)
+	 * @param	int					$type		0=All, 1=Global, 2=Member-specific
+	 * @param	NULL|\IPS\Member	$member		Member object if $type is 0 or 2
+	 * @return	array
 	 */
-	public function save( $post )
+	public function returnTagValues( $content, $type, $member )
 	{
-		return FALSE;
-	}
-	
-	/**
-	 * Get where clause to add to the member retrieval database query
-	 *
-	 * @param	mixed				$data	The array returned from the save() method
-	 * @return	string|array|NULL	Where clause
-	 */
-	public function getQueryWhereClause( $data )
-	{
-		return NULL;
-	}
-	
-	/**
-	 * Callback for member retrieval database query
-	 * Can be used to set joins
-	 *
-	 * @param	mixed			$data	The array returned from the save() method
-	 * @param	\IPS\Db\Query	$query	The query
-	 * @return	void
-	 */
-	public function queryCallback( &$query )
-	{
-		return NULL;
+		return array(
+			'{some_tag}'	=> 'Value',
+		);
 	}
 }