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