charitable / includes / interfaces / interface-charitable-form-view.php

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

77 lines 1.8 KB

Raw Download Zip

1	<?php
2	/**
3	* Donation form interface.
4	*
5	* This defines a strict interface that donation forms must implement.
6	*
7	* @version 1.5.0
8	* @package Charitable/Interfaces/Charitable_Form_View_Interface
9	* @author Eric Daams
10	* @copyright Copyright (c) 2022, 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' ) ) {
16	exit;
17	}
18
19	if ( ! interface_exists( 'Charitable_Form_View_Interface' ) ) :
20
21	/**
22	* Charitable_Form_View_Interface interface.
23	*
24	* @since 1.5.0
25	*/
26	interface Charitable_Form_View_Interface {
27
28	/**
29	* Render a form.
30	*
31	* @since 1.5.0
32	*
33	* @return void
34	*/
35	public function render();
36
37	/**
38	* Render notices before the form.
39	*
40	* @since 1.5.0
41	*
42	* @return string
43	*/
44	public function render_notices();
45
46	/**
47	* Render a form's hidden fields.
48	*
49	* @since 1.5.0
50	*
51	* @return boolean True if any fields were rendered. False otherwise.
52	*/
53	public function render_hidden_fields();
54
55	/**
56	* Render all of a form's fields.
57	*
58	* @since 1.5.0
59	*
60	* @return void
61	*/
62	public function render_fields();
63
64	/**
65	* Render a specific form fields.
66	*
67	* @since 1.5.0
68	*
69	* @param array $field Field definition.
70	* @param string $key Field key.
71	* @param array $args Mixed array of arguments.
72	* @return boolean
73	*/
74	public function render_field( $field, $key, $args = array() );
75	}
76
77	endif; // End interface_exists check.