charitable / includes / interfaces / interface-charitable-email.php

interface-charitable-email.php in Charitable – Donation & Fundraising Platform (Donation Forms, Recurring Donations & Fundraising Campaigns) 1.6.28, at includes/interfaces/interface-charitable-email.php

59 lines 1.4 KB

Raw Download Zip

1	<?php
2	/**
3	* Charitable Email interface.
4	*
5	* This defines a strict interface that emails must implement.
6	*
7	* @version 1.5.0
8	* @package Charitable/Interfaces/Charitable_Email_Interface
9	* @author Eric Daams
10	* @copyright Copyright (c) 2019, Studio 164a
11	* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
12	*/
13
14	// Exit if accessed directly.
15	if ( ! defined( 'ABSPATH' ) ) { exit; }
16
17	if ( ! interface_exists( 'Charitable_Email_Interface' ) ) :
18
19	/**
20	* Charitable_Email_Interface interface.
21	*
22	* @since 1.2.0
23	*/
24	interface Charitable_Email_Interface {
25
26	/**
27	* Returns the email's ID.
28	*
29	* @since 1.2.0
30	*
31	* @return string
32	*/
33	public static function get_email_id();
34
35	/**
36	* Resend an email.
37	*
38	* @since 1.5.0
39	*
40	* @param int $object_id An object ID.
41	* @param array $args Mixed set of arguments.
42	* @return boolean
43	*/
44	public static function resend( $object_id, $args = array() );
45
46	/**
47	* Checks whether an email can be resent.
48	*
49	* @since 1.5.0
50	*
51	* @param int $object_id An object ID.
52	* @param array $args Mixed set of arguments.
53	* @return boolean
54	*/
55	public static function can_be_resent( $object_id, $args = array() );
56	}
57
58	endif;
59