robin-image-optimizer
/
libs
/
factory
/
forms
/
includes
/
providers
/
value-provider.interface.php
index.php
6 months ago
meta-value-provider.class.php
5 months ago
options-value-provider.class.php
5 months ago
value-provider.interface.php
5 months ago
value-provider.interface.php
60 lines
| 1 | <?php |
| 2 | /** |
| 3 | * The file contains an interface for all value provides. |
| 4 | * |
| 5 | * A value provider is a provide to get and save values to some stores (database, metadata and so on). |
| 6 | * |
| 7 | * @package factory-forms |
| 8 | * @since 1.0.0 |
| 9 | */ |
| 10 | // Exit if accessed directly |
| 11 | if ( ! defined( 'ABSPATH' ) ) { |
| 12 | exit; |
| 13 | } |
| 14 | if ( ! class_exists( 'Wbcr_IFactoryForms600_ValueProvider' ) ) { |
| 15 | /** |
| 16 | * The interface for all value provides. |
| 17 | * |
| 18 | * @since 1.0.0 |
| 19 | */ |
| 20 | interface Wbcr_IFactoryForms600_ValueProvider { |
| 21 | |
| 22 | /** |
| 23 | * Inits a form a provider to get data from a storage. |
| 24 | * |
| 25 | * @since 1.0.0 |
| 26 | * @return void |
| 27 | */ |
| 28 | public function init(); |
| 29 | |
| 30 | /** |
| 31 | * Commits all changes. |
| 32 | * |
| 33 | * @since 1.0.0 |
| 34 | * @return void |
| 35 | */ |
| 36 | public function saveChanges(); |
| 37 | |
| 38 | /** |
| 39 | * Gets a value by its name. |
| 40 | * |
| 41 | * @since 1.0.0 |
| 42 | * @param string $name A value name to get. |
| 43 | * @param mixed|null $default A default to return if a given name doesn't exist. |
| 44 | * @param string $name A value name to get. |
| 45 | * @return mixed |
| 46 | */ |
| 47 | public function getValue( $name, $default = null, $multiple = false ); |
| 48 | |
| 49 | /** |
| 50 | * Sets a value by its name. |
| 51 | * |
| 52 | * @since 1.0.0 |
| 53 | * @param string $name A value name to set. |
| 54 | * @param mixed $value A value to set. |
| 55 | * @return void |
| 56 | */ |
| 57 | public function setValue( $name, $value ); |
| 58 | } |
| 59 | } |
| 60 |