1	<?php
2	declare(strict_types=1);
3
4	namespace Korobochkin\WPKit\Transients;
5
6	use Korobochkin\WPKit\DataComponents\NodeInterface;
7
8	/**
9	* Interface TransientInterface
10	*
11	* Represent single transient with non nested values.
12	*
13	* @package Korobochkin\WPKit\Transients
14	*/
15	interface TransientInterface 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 (transient not exists in DB) or array if option saved as array.
24	*/
25	public function getValueFromWordPress();
26
27	/**
28	* Get current value of expiration.
29	*
30	* @return int Expiration in seconds.
31	*/
32	public function getExpiration();
33
34	/**
35	* Set the expiration.
36	*
37	* @param int $expiration
38	*
39	* @return $this For chain calls.
40	*/
41	public function setExpiration($expiration);
42
43	/**
44	* Performs deletion of transient only in DB.
45	*
46	* Delete transient only in DB, local value (if presented) will still stored in this object.
47	*
48	* @throws \LogicException If name of option not setted up.
49	*
50	* @return bool Result of deletion.
51	*/
52	public function deleteFromWP();
53
54	/**
55	* Performs pushing local value ($this->value) into the DB (actually save the value from instance
56	* and remove $this->value because other code can use transients directly
57	* with get|update|delete_transient functions).
58	*
59	* @throws \LogicException If name of option not setted up.
60	*
61	* @return bool Result of pushing (saving) transient 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 integer $expiration The maximum of seconds to keep the data before refreshing.
72	*
73	* @return bool Result of $this->flush() call.
74	*/
75	public function updateValue($value, $expiration = null);
76	}