-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsource-class-Base_Model_Admin_Notice.html
More file actions
215 lines (196 loc) · 16.9 KB
/
source-class-Base_Model_Admin_Notice.html
File metadata and controls
215 lines (196 loc) · 16.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File models/class-base-model-admin-notice.php</title>
<script type="text/javascript" src="resources/combined.js?4058929694"></script>
<script type="text/javascript" src="elementlist.js?2335409893"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Packages</h3>
<ul>
<li><a href="package-None.html">None</a>
</li>
<li class="active"><a href="package-WPMVCBase.html">WPMVCBase<span></span></a>
<ul>
<li><a href="package-WPMVCBase.Controllers.html">Controllers</a>
</li>
<li><a href="package-WPMVCBase.Helper.html">Helper</a>
</li>
<li class="active"><a href="package-WPMVCBase.Models.html">Models</a>
</li>
</ul></li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Base_Model.html">Base_Model</a></li>
<li class="active"><a href="class-Base_Model_Admin_Notice.html">Base_Model_Admin_Notice</a></li>
<li><a href="class-Base_Model_CPT.html">Base_Model_CPT</a></li>
<li><a href="class-Base_Model_Help_Tab.html">Base_Model_Help_Tab</a></li>
<li><a href="class-Base_Model_JS_Object.html">Base_Model_JS_Object</a></li>
<li><a href="class-Base_Model_Menu_Page.html">Base_Model_Menu_Page</a></li>
<li><a href="class-Base_Model_Metabox.html">Base_Model_Metabox</a></li>
<li><a href="class-Base_Model_Plugin.html">Base_Model_Plugin</a></li>
<li><a href="class-Base_Model_Settings.html">Base_Model_Settings</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="package-WPMVCBase.Models.html" title="Summary of WPMVCBase\Models"><span>Package</span></a>
</li>
<li>
<a href="class-Base_Model_Admin_Notice.html" title="Summary of Base_Model_Admin_Notice"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a> <span class="php-comment">/*
</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment">This program is free software; you can redistribute it and/or
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment">modify it under the terms of the GNU General Public License
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">as published by the Free Software Foundation; either version 2
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">of the License, or (at your option) any later version.
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment">
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment">This program is distributed in the hope that it will be useful,
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment">but WITHOUT ANY WARRANTY; without even the implied warranty of
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">GNU General Public License for more details.
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment">
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment">You should have received a copy of the GNU General Public License
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment">along with this program; if not, write to the Free Software
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment">Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">*/</span>
</span><span id="17" class="l"><a class="l" href="#17"> 17: </a>
</span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-keyword1">if</span> ( ! <span class="php-keyword2">class_exists</span>( <span class="php-quote">'Base_Model_Admin_Notice'</span> ) ) {
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a> <span class="php-comment">/**
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * The base admin notice object model.
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> *
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * @package WPMVCBase\Models
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * @version 0.2
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> */</span>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a> <span class="php-keyword1">class</span> <a id="Base_Model_Admin_Notice" href="#Base_Model_Admin_Notice">Base_Model_Admin_Notice</a>
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a> {
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> <span class="php-comment">/**
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * The notice type ( updated or error ).
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> *
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * @var string
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * @access private
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> */</span>
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$type" href="#$type">$type</a></span>;
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a>
</span><span id="37" class="l"><a class="l" href="#37"> 37: </a> <span class="php-comment">/**
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * The admin notice message.
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> *
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * @var string
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * @access private
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$message" href="#$message">$message</a></span>;
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a> <span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The screens on which to display this admin notice.
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> *
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * @var array
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * @access private
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> */</span>
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$screens" href="#$screens">$screens</a></span>;
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a>
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-comment">/**
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * The class constructor.
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> *
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * @param string $type The notice type. Either 'updated' or 'error'.
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * @param string $message The notice message.
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * @param array $screens The WP screen id's on which to display this notice. If not set, notice appears on all screens.
</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * @access public
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>( <span class="php-var">$type</span>, <span class="php-var">$message</span>, <span class="php-keyword1">array</span> <span class="php-var">$screens</span> = <span class="php-keyword1">null</span> )
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a> {
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-var">$this</span>->type = <span class="php-var">$type</span>;
</span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-var">$this</span>->message = <span class="php-var">$message</span>;
</span><span id="68" class="l"><a class="l" href="#68"> 68: </a> <span class="php-var">$this</span>->screens = <span class="php-quote">'all'</span>;
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a>
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword1">isset</span>( <span class="php-var">$screens</span> ) ) {
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-var">$this</span>->screens = <span class="php-var">$screens</span>;
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> }
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> }
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a>
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-comment">/**
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> * Get the notice type.
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> *
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> * @return string $type Either 'updated' or 'error'.
</span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> * @access public
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> */</span>
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_get_type" href="#_get_type">get_type</a>()
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> {
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->type;
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> }
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a>
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-comment">/**
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * Get the admin notice message.
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> *
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * @return string $message
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * @access public
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_get_message" href="#_get_message">get_message</a>()
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a> {
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->message;
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> }
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> <span class="php-comment">/**
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * Get the screen(s) on which to apply this notice.
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> *
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * @return array|string $screens An array of the screens or the string 'all' for all screens.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * @access public
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> */</span>
</span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_get_screens" href="#_get_screens">get_screens</a>()
</span><span id="107" class="l"><a class="l" href="#107">107: </a> {
</span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->screens;
</span><span id="109" class="l"><a class="l" href="#109">109: </a> }
</span><span id="110" class="l"><a class="l" href="#110">110: </a> }
</span><span id="111" class="l"><a class="l" href="#111">111: </a>}
</span><span id="112" class="l"><a class="l" href="#112">112: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>