Object.php — Advanced Access Manager – Access Governance for WordPress 5.9

advanced-access-manager / Application / Core / Object.php

advanced-access-manager / Application / Core Last commit date

Api 7 years ago ConfigPress 7 years ago Object 7 years ago Policy 7 years ago Subject 7 years ago API.php 7 years ago Cache.php 7 years ago Compatibility.php 7 years ago Config.php 7 years ago ConfigPress.php 7 years ago Console.php 7 years ago Exporter.php 7 years ago Gateway.php 7 years ago Importer.php 7 years ago JwtAuth.php 7 years ago Login.php 7 years ago Media.php 7 years ago Object.php 7 years ago Request.php 7 years ago Server.php 7 years ago Subject.php 7 years ago

Object.php

224 lines

1	<?php
2
3	/**
4	* ======================================================================
5	* LICENSE: This file is subject to the terms and conditions defined in *
6	* file 'license.txt', which is part of this source code package. *
7	* ======================================================================
8	*/
9
10	/**
11	* Abstract object class
12	*
13	* @package AAM
14	* @author Vasyl Martyniuk <vasyl@vasyltech.com>
15	*/
16	abstract class AAM_Core_Object {
17
18	/**
19	* Subject
20	*
21	* @var AAM_Core_Subject
22	*
23	* @access private
24	*/
25	private $_subject = null;
26
27	/**
28	* Object options
29	*
30	* @var array
31	*
32	* @access private
33	*/
34	private $_option = array();
35
36	/**
37	* Inheritance indicator
38	*
39	* @var null\|string
40	*
41	* @access private
42	*/
43	private $_inherited = null;
44
45	/**
46	* Overwritten indicator
47	*
48	* If settings for specific object were detected befor inheritance mechanism
49	* kicked off, then it it considered overwritten
50	*
51	* @var boolean
52	*
53	* @access private
54	*/
55	private $_overwritten = false;
56
57	/**
58	* Constructor
59	*
60	* @param AAM_Core_Subject $subject
61	*
62	* @return void
63	*
64	* @access public
65	*/
66	public function __construct(AAM_Core_Subject $subject) {
67	$this->setSubject($subject);
68	}
69
70	/**
71	* Read object option
72	*
73	* @return void
74	*
75	* @access public
76	*/
77	public function initialize() {}
78
79	/**
80	* Set current subject
81	*
82	* Either it is User or Role
83	*
84	* @param AAM_Core_Subject $subject
85	*
86	* @return void
87	*
88	* @access public
89	*/
90	public function setSubject(AAM_Core_Subject $subject) {
91	$this->_subject = $subject;
92	}
93
94	/**
95	* Get Subject
96	*
97	* @return AAM_Core_Subject
98	*
99	* @access public
100	*/
101	public function getSubject() {
102	return $this->_subject;
103	}
104
105	/**
106	* Set Object options
107	*
108	* @param mixed $option
109	*
110	* @return void
111	*
112	* @access public
113	*/
114	public function setOption($option) {
115	$this->_option = (is_array($option) ? $option : array());
116	}
117
118	/**
119	* Get Object options
120	*
121	* @return mixed
122	*
123	* @access public
124	*/
125	public function getOption() {
126	return $this->_option;
127	}
128
129	/**
130	*
131	* @param type $external
132	* @return type
133	*/
134	public function mergeOption($external) {
135	return $external;
136	}
137
138	/**
139	* Update single option item
140	*
141	* @param string $item
142	* @param mixed $value
143	*
144	* @return boolean Always true
145	*
146	* @access public
147	*/
148	public function updateOptionItem($item, $value) {
149	$option = $this->getOption();
150	$option[$item] = $value;
151	$this->setOption($option);
152
153	return true;
154	}
155
156	/**
157	* Set Inherited flag
158	*
159	* @param string $inherited
160	*
161	* @return void
162	*/
163	public function setInherited($inherited) {
164	$this->_inherited = $inherited;
165	}
166
167	/**
168	* Get Inherited flag
169	*
170	* @return null\|string
171	*
172	* @access public
173	*/
174	public function getInherited() {
175	return $this->_inherited;
176	}
177
178	/**
179	* Set overwritten flat
180	*
181	* @param boolean $overwritten
182	*
183	* @return void
184	*
185	* @access public
186	*/
187	public function setOverwritten($overwritten = true) {
188	$this->_overwritten = $overwritten;
189	}
190
191	/**
192	* Check if options are overwritten
193	*
194	* @return boolean
195	*
196	* @access public
197	*/
198	public function isOverwritten() {
199	return $this->_overwritten;
200	}
201
202	/**
203	* Check if access is allowed
204	*
205	* @return bool
206	*
207	* @access public
208	*/
209	public function allowed() {
210	return !call_user_func_array(array($this, 'has'), func_get_args());
211	}
212
213	/**
214	* Check if access is denied
215	*
216	* @return boolean
217	*
218	* @access public
219	*/
220	public function denied() {
221	return call_user_func_array(array($this, 'has'), func_get_args());
222	}
223
224	}