1	<?php
2	declare(strict_types=1);
3
4	namespace Korobochkin\WPKit\Options;
5
6	use Korobochkin\WPKit\DataComponents\NodeInterface;
7
8	/**
9	* Interface OptionInterface
10	*
11	* Represent single option with non nested values.
12	*
13	* @package Korobochkin\WPKit\Options
14	*/
15	interface OptionInterface extends NodeInterface
16	{
17	/**
18	* Retrieve value of node from WordPress DB.
19	*
20	* @throws \LogicException If name of option not setted up.
21	*
22	* @return string|bool|array String value of node if exists,
23	* false if some cases (option not exists in DB) or array if option saved as array.
24	*/
25	public function getValueFromWordPress();
26
27	/**
28	* Describes if this option should be autoloaded by WordPress or not.
29	*
30	* @return bool true if it autoloaded, false otherwise.
31	*/
32	public function isAutoload();
33
34	/**
35	* Setup how this option should be loaded. This setting not effects immediately. You need call $this->updateValue()
36	* or $this->flush() to persist changes.
37	*
38	* @param $autoload bool True for autoload, false for disable autoload.
39	*
40	* @return $this For chain calls.
41	*/
42	public function setAutoload($autoload);
43
44	/**
45	* Performs deletion of option only in DB.
46	*
47	* Delete option only in DB, local value (if presented) will still stored in this object.
48	*
49	* @throws \LogicException If name of option not setted up.
50	*
51	* @return bool Result of deletion.
52	*/
53	public function deleteFromWP();
54
55	/**
56	* Performs pushing local value ($this->value) into the DB (actually save the value from instance
57	* and remove $this->value because other code can use options directly with get|update|delete_option functions).
58	*
59	* @throws \LogicException If name of option not setted up.
60	*
61	* @return bool Result of pushing (saving) option in DB.
62	*/
63	public function flush();
64
65	/**
66	* Set value to object and then immediately save it into the DB (call $this->flush()).
67	*
68	* If operation was unsuccessful then return false and don't delete local value.
69	*
70	* @param $value mixed Any type of value which can be passed to $this->setValue().
71	* @param null|bool $autoload This value passed to $this->setAutoload()
72	*
73	* @return bool Result of $this->flush() call.
74	*/
75	public function updateValue($value, $autoload = null);
76	}