| 1 |
<?php |
| 2 |
/** |
| 3 |
* Strict interface for Charitable Field Registry APIs. |
| 4 |
* |
| 5 |
* @package Charitable/Interfaces/Charitable_Field_Registry_Interface |
| 6 |
* @author David Bisset |
| 7 |
* @copyright Copyright (c) 2022, WP Charitable LLC |
| 8 |
* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License |
| 9 |
* @since 1.5.0 |
| 10 |
* @version 1.5.0 |
| 11 |
*/ |
| 12 |
|
| 13 |
// Exit if accessed directly. |
| 14 |
if ( ! defined( 'ABSPATH' ) ) { |
| 15 |
exit; |
| 16 |
} |
| 17 |
|
| 18 |
if ( ! interface_exists( 'Charitable_Field_Registry_Interface' ) ) : |
| 19 |
|
| 20 |
/** |
| 21 |
* Charitable_Field_Registry_Interface interface. |
| 22 |
* |
| 23 |
* @since 1.5.0 |
| 24 |
*/ |
| 25 |
interface Charitable_Field_Registry_Interface { |
| 26 |
|
| 27 |
/** |
| 28 |
* Return all the fields. |
| 29 |
* |
| 30 |
* @since 1.5.0 |
| 31 |
* |
| 32 |
* @return array |
| 33 |
*/ |
| 34 |
public function get_fields(); |
| 35 |
|
| 36 |
/** |
| 37 |
* Return a single field. |
| 38 |
* |
| 39 |
* @since 1.5.0 |
| 40 |
* |
| 41 |
* @param string $field_key The field's key. |
| 42 |
* @return array|false Array if the field is registered. False otherwise. |
| 43 |
*/ |
| 44 |
public function get_field( $field_key ); |
| 45 |
|
| 46 |
/** |
| 47 |
* Register a field. |
| 48 |
* |
| 49 |
* @since 1.5.0 |
| 50 |
* |
| 51 |
* @param Charitable_Field_Interface $field Object of type `Charitable_Field_Interface`. |
| 52 |
* @return boolean |
| 53 |
*/ |
| 54 |
public function register_field( Charitable_Field_Interface $field ); |
| 55 |
} |
| 56 |
|
| 57 |
endif; |
| 58 |
|
