1	<?php
2	declare(strict_types=1);
3
4	namespace Korobochkin\WPKit\DataComponents;
5
6	use Symfony\Component\Form\DataTransformerInterface;
7	use Symfony\Component\Validator\ConstraintValidatorInterface;
8	use Symfony\Component\Validator\ConstraintViolationInterface;
9	use Symfony\Component\Validator\Validator\ValidatorInterface;
10
11	interface NodeInterface
12	{
13
14	/**
15	* The main method to retrieve value.
16	*
17	* Should always returns the value of this node.
18	*
19	* @return mixed Value of this node.
20	*/
21	public function get();
22
23	/**
24	* Alias for $this->setLocalValue().
25	*
26	* @param $value mixed A value for this node.
27	*
28	* @return $this For chain calls.
29	*/
30	public function set($value);
31
32	/**
33	* Returns node name which can be used in functions like update_option(option_name).
34	*
35	* @return string
36	*/
37	public function getName();
38
39	/**
40	* Setup node name, required for each node.
41	*
42	* @param $name string Node name.
43	*
44	* @return $this For chain calls.
45	*/
46	public function setName($name);
47
48	/**
49	* Get a local value.
50	*
51	* @return mixed Local value.
52	*/
53	public function getLocalValue();
54
55	/**
56	* Save value in this instance but not actually in DB.
57	*
58	* You can setup local value via this method, validate it and push to the DB if needed or just
59	* delete it (set to null). To save value in DB you need call $this->flush().
60	*
61	* @param $value mixed Value which need to be stored in this instance.
62	*
63	* @return $this For chain calls.
64	*/
65	public function setLocalValue($value);
66
67	/**
68	* Returns a default value for this instance or null if it not setted up.
69	*
70	* @return mixed Default value for this instance.
71	*/
72	public function getDefaultValue();
73
74	/**
75	* Setup default value for instance. This value should be returned (used) by default if value
76	* not exists in WordPress DB.
77	*
78	* @param $defaultValue mixed Value which need to be stored as default value for this instance.
79	*
80	* @return $this For chain calls.
81	*/
82	public function setDefaultValue($defaultValue);
83
84	/**
85	* Returns set of Constraints (or just one) for Validator.
86	*
87	* @return ConstraintValidatorInterface[]|ConstraintValidatorInterface Constraint which defines
88	* how to validate your value.
89	*/
90	public function getConstraint();
91
92	/**
93	* Setup set of Constraints (or just one) for Validator.
94	*
95	* @param $constraints ConstraintValidatorInterface[]|ConstraintValidatorInterface Set of constraints
96	* with validator rules.
97	*
98	* @return $this For chain calls.
99	*/
100	public function setConstraint($constraints);
101
102	/**
103	* This function automatically builds the set of constraints for your instance and return it.
104	*
105	* Because constraints is a instances of classes with custom constructors is much better init them on demand (only
106	* if they needed right now). So you can easily describe how to build your constraints here and that's all.
107	*
108	* After init them you should save it. Example: $this->setConstraint($this->buildConstraint()).
109	*
110	* @return ConstraintValidatorInterface|ConstraintValidatorInterface[] Constraints for this instance.
111	*/
112	public function buildConstraint();
113
114	/**
115	* Validator can validate your value of this instance. This method returns validator.
116	*
117	* @return ValidatorInterface Symfony's validator which work with Constraints.
118	*/
119	public function getValidator();
120
121	/**
122	* Setup your Symfony Validator.
123	*
124	* @param ValidatorInterface $validator Validator which should validate values.
125	*
126	* @return $this For chain calls.
127	*/
128	public function setValidator(ValidatorInterface $validator);
129
130	/**
131	* Returns an array with Violations after validating.
132	*
133	* May returns empty array if validation was successful.
134	*
135	* @throws \Exception Different exceptions can be throw by Symfony Validator. Usually this happens if value
136	* have a non expected variable type.
137	*
138	* @return ConstraintViolationInterface[] Array of validation results.
139	*/
140	public function validate();
141
142	/**
143	* Returns boolean flag which means is your validation successful or not.
144	*
145	* @return bool True means all is ok, False otherwise.
146	*/
147	public function isValid();
148
149	/**
150	* Performs fully deletion of option.
151	*
152	* Values in DB and value in this object will be deleted. Default value not deleted by this method.
153	*
154	* @return bool Result of deletion.
155	*/
156	public function delete();
157
158	/**
159	* Performs deletion of value in this instance.
160	*
161	* @return true Always true after resetting local value.
162	*/
163	public function deleteLocal();
164
165	/**
166	* Returns the data transformer which transform the data.
167	*
168	* @return DataTransformerInterface
169	*/
170	public function getDataTransformer();
171
172	/**
173	* Sets the data transformer.
174	*
175	* @param DataTransformerInterface $transformer
176	*
177	* @return $this For chain calls.
178	*/
179	public function setDataTransformer(DataTransformerInterface $transformer);
180	}