root/docs/phpdoc_generated/elementindex_MvBlog.html

Revision 759, 77.1 KB (checked in by michiel, 12 months ago)

regenerate api docs now the input_formats branch is merged in

Line 
1<?xml version="1.0" encoding="iso-8859-1"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3  <html xmlns="http://www.w3.org/1999/xhtml">
4                <head>
5                        <!-- template designed by Marco Von Ballmoos -->
6                        <title></title>
7                        <link rel="stylesheet" href="media/stylesheet.css" />
8                        <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9                </head>
10                <body>
11                                               
12<a name="top"></a>
13<h2>[MvBlog] element index</h2>
14<a href="elementindex.html">All elements</a>
15<br />
16<div class="index-letter-menu">
17        <a class="index-letter" href="elementindex_MvBlog.html#a">a</a>
18        <a class="index-letter" href="elementindex_MvBlog.html#b">b</a>
19        <a class="index-letter" href="elementindex_MvBlog.html#c">c</a>
20        <a class="index-letter" href="elementindex_MvBlog.html#d">d</a>
21        <a class="index-letter" href="elementindex_MvBlog.html#e">e</a>
22        <a class="index-letter" href="elementindex_MvBlog.html#f">f</a>
23        <a class="index-letter" href="elementindex_MvBlog.html#g">g</a>
24        <a class="index-letter" href="elementindex_MvBlog.html#h">h</a>
25        <a class="index-letter" href="elementindex_MvBlog.html#i">i</a>
26        <a class="index-letter" href="elementindex_MvBlog.html#l">l</a>
27        <a class="index-letter" href="elementindex_MvBlog.html#m">m</a>
28        <a class="index-letter" href="elementindex_MvBlog.html#o">o</a>
29        <a class="index-letter" href="elementindex_MvBlog.html#p">p</a>
30        <a class="index-letter" href="elementindex_MvBlog.html#r">r</a>
31        <a class="index-letter" href="elementindex_MvBlog.html#s">s</a>
32        <a class="index-letter" href="elementindex_MvBlog.html#t">t</a>
33        <a class="index-letter" href="elementindex_MvBlog.html#u">u</a>
34        <a class="index-letter" href="elementindex_MvBlog.html#v">v</a>
35        <a class="index-letter" href="elementindex_MvBlog.html#w">w</a>
36        <a class="index-letter" href="elementindex_MvBlog.html#_">_</a>
37</div>
38
39        <a name="_"></a>
40        <div class="index-letter-section">
41                <div style="float: left" class="index-letter-title">_</div>
42                <div style="float: right"><a href="#top">top</a></div>
43                <div style="clear: both"></div>
44        </div>
45        <dl>
46                        <dt class="field">
47                                                <span class="var-title">$_selected_menuitem</span>
48                                        </dt>
49                <dd class="index-item-body">
50                        <div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#var$_selected_menuitem">MvBlog_admin::$_selected_menuitem</a> in mvblog_admin.php</div>
51                                        </dd>
52                        <dt class="field">
53                                                <span class="var-title">$_selected_submenuitem</span>
54                                        </dt>
55                <dd class="index-item-body">
56                        <div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#var$_selected_submenuitem">MvBlog_admin::$_selected_submenuitem</a> in mvblog_admin.php</div>
57                                        </dd>
58                        <dt class="field">
59                                                <span class="method-title">_activate_plugin</span>
60                                        </dt>
61                <dd class="index-item-body">
62                        <div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#method_activate_plugin">MvBlog_admin::_activate_plugin()</a> in mvblog_admin.php</div>
63                                                        <div class="index-item-description">Activate plugin and save state to db</div>
64                                        </dd>
65                        <dt class="field">
66                                                <span class="method-title">_deactivate_plugin</span>
67                                        </dt>
68                <dd class="index-item-body">
69                        <div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#method_deactivate_plugin">MvBlog_admin::_deactivate_plugin()</a> in mvblog_admin.php</div>
70                                                        <div class="index-item-description">Deactivate plugin and save state to db</div>
71                                        </dd>
72                        <dt class="field">
73                                                <span class="method-title">_get_active_plugins</span>
74                                        </dt>
75                <dd class="index-item-body">
76                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_get_active_plugins">MvBlog_common::_get_active_plugins()</a> in mvblog_common.php</div>
77                                                        <div class="index-item-description">Read active plugins from settings and unserialize it so plugmrg can handle it</div>
78                                        </dd>
79                        <dt class="field">
80                                                <span class="method-title">_get_authors</span>
81                                        </dt>
82                <dd class="index-item-body">
83                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_get_authors">MvBlog_common::_get_authors()</a> in mvblog_common.php</div>
84                                                        <div class="index-item-description">Get all the authors into an array.</div>
85                                        </dd>
86                        <dt class="field">
87                                                <span class="method-title">_get_categories</span>
88                                        </dt>
89                <dd class="index-item-body">
90                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_get_categories">MvBlog_common::_get_categories()</a> in mvblog_common.php</div>
91                                                        <div class="index-item-description">Get all the categories into an array</div>
92                                        </dd>
93                        <dt class="field">
94                                                <span class="method-title">_get_dossiers</span>
95                                        </dt>
96                <dd class="index-item-body">
97                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_get_dossiers">MvBlog_common::_get_dossiers()</a> in mvblog_common.php</div>
98                                                        <div class="index-item-description">Get all the dossiers into an array</div>
99                                        </dd>
100                        <dt class="field">
101                                                <span class="method-title">_get_menuitems</span>
102                                        </dt>
103                <dd class="index-item-body">
104                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_get_menuitems">MvBlog_common::_get_menuitems()</a> in mvblog_common.php</div>
105                                                        <div class="index-item-description">Get all the user configured menuitems from db</div>
106                                        </dd>
107                        <dt class="field">
108                                                <span class="method-title">_get_posts</span>
109                                        </dt>
110                <dd class="index-item-body">
111                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_get_posts">MvBlog_common::_get_posts()</a> in mvblog_common.php</div>
112                                                        <div class="index-item-description">Get posts based on optional options</div>
113                                        </dd>
114                        <dt class="field">
115                                                <span class="method-title">_get_settings</span>
116                                        </dt>
117                <dd class="index-item-body">
118                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_get_settings">MvBlog_common::_get_settings()</a> in mvblog_common.php</div>
119                                                        <div class="index-item-description">Get all the settings into an array</div>
120                                        </dd>
121                        <dt class="field">
122                                                <span class="method-title">_get_webroot</span>
123                                        </dt>
124                <dd class="index-item-body">
125                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_get_webroot">MvBlog_common::_get_webroot()</a> in mvblog_common.php</div>
126                                                        <div class="index-item-description">Get the webroot for the mvblog install  Sets the value in class var webroot.</div>
127                                        </dd>
128                        <dt class="field">
129                                                <span class="method-title">_handle_magic_quotes</span>
130                                        </dt>
131                <dd class="index-item-body">
132                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_handle_magic_quotes">MvBlog_common::_handle_magic_quotes()</a> in mvblog_common.php</div>
133                                                        <div class="index-item-description">Detect wether magic_quotes_gpc is on.</div>
134                                        </dd>
135                        <dt class="field">
136                                                <span class="method-title">_handle_php_bugs</span>
137                                        </dt>
138                <dd class="index-item-body">
139                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_handle_php_bugs">MvBlog_common::_handle_php_bugs()</a> in mvblog_common.php</div>
140                                                        <div class="index-item-description">Handle some php bugs.</div>
141                                        </dd>
142                        <dt class="field">
143                                                <span class="method-title">_init_db</span>
144                                        </dt>
145                <dd class="index-item-body">
146                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_init_db">MvBlog_common::_init_db()</a> in mvblog_common.php</div>
147                                                        <div class="index-item-description">Create database connection using the PEAR::MDB2 framework and puts this object in class variable db</div>
148                                        </dd>
149                        <dt class="field">
150                                                <span class="method-title">_magic_quotes_strip</span>
151                                        </dt>
152                <dd class="index-item-body">
153                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_magic_quotes_strip">MvBlog_common::_magic_quotes_strip()</a> in mvblog_common.php</div>
154                                                        <div class="index-item-description">strip escape \ signs when magic_quotes_gpc is on in php.ini</div>
155                                        </dd>
156                        <dt class="field">
157                                                <span class="method-title">_mysql_backup_db</span>
158                                        </dt>
159                <dd class="index-item-body">
160                        <div class="index-item-details"><a href="MvBlog/Mvblog_upgrade.html#method_mysql_backup_db">Mvblog_upgrade::_mysql_backup_db()</a> in mvblog_upgrade.php</div>
161                                                        <div class="index-item-description">Create mysql backup</div>
162                                        </dd>
163                        <dt class="field">
164                                                <span class="method-title">_psql_backup_db</span>
165                                        </dt>
166                <dd class="index-item-body">
167                        <div class="index-item-details"><a href="MvBlog/Mvblog_upgrade.html#method_psql_backup_db">Mvblog_upgrade::_psql_backup_db()</a> in mvblog_upgrade.php</div>
168                                                        <div class="index-item-description">Create postgresql backup. Code and ideas borrowed from phpPgAdmin.</div>
169                                        </dd>
170                        <dt class="field">
171                                                <span class="method-title">_sanitize</span>
172                                        </dt>
173                <dd class="index-item-body">
174                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method_sanitize">MvBlog_common::_sanitize()</a> in mvblog_common.php</div>
175                                                        <div class="index-item-description">Sanitize given data.</div>
176                                        </dd>
177                        <dt class="field">
178                                                <span class="method-title">_strip_attributes</span>
179                                        </dt>
180                <dd class="index-item-body">
181                        <div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#method_strip_attributes">MvBlog_admin::_strip_attributes()</a> in mvblog_admin.php</div>
182                                                        <div class="index-item-description">strip evil attributes from tags</div>
183                                        </dd>
184                        <dt class="field">
185                                                <span class="method-title">_strip_tags</span>
186                                        </dt>
187                <dd class="index-item-body">
188                        <div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#method_strip_tags">MvBlog_admin::_strip_tags()</a> in mvblog_admin.php</div>
189                                                        <div class="index-item-description">strip all html tags cept for some tags we like.</div>
190                                        </dd>
191                        <dt class="field">
192                                                <span class="method-title">__autoload</span>
193                                        </dt>
194                <dd class="index-item-body">
195                        <div class="index-item-details"><a href="MvBlog/_common---mvblog.php.html#function__autoload">__autoload()</a> in mvblog.php</div>
196                                        </dd>
197                        <dt class="field">
198                                                <span class="method-title">__construct</span>
199                                        </dt>
200                <dd class="index-item-body">
201                        <div class="index-item-details"><a href="MvBlog/Mvblog_upgrade.html#method__construct">Mvblog_upgrade::__construct()</a> in mvblog_upgrade.php</div>
202                                                        <div class="index-item-description">Class constructor</div>
203                                        </dd>
204                        <dt class="field">
205                                                <span class="method-title">__construct</span>
206                                        </dt>
207                <dd class="index-item-body">
208                        <div class="index-item-details"><a href="MvBlog/mvblog_IniParser.html#method__construct">mvblog_IniParser::__construct()</a> in mvblog_iniparser.php</div>
209                                        </dd>
210                        <dt class="field">
211                                                <span class="method-title">__construct</span>
212                                        </dt>
213                <dd class="index-item-body">
214                        <div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#method__construct">MvBlog_admin::__construct()</a> in mvblog_admin.php</div>
215                                                        <div class="index-item-description">Class constructor. Check some defaults etc</div>
216                                        </dd>
217                        <dt class="field">
218                                                <span class="method-title">__construct</span>
219                                        </dt>
220                <dd class="index-item-body">
221                        <div class="index-item-details"><a href="MvBlog/mvblog_IniFileReader.html#method__construct">mvblog_IniFileReader::__construct()</a> in mvblog_inifilereader.php</div>
222                                        </dd>
223                        <dt class="field">
224                                                <span class="method-title">__construct</span>
225                                        </dt>
226                <dd class="index-item-body">
227                        <div class="index-item-details"><a href="MvBlog/MvBlog_pluginmgr.html#method__construct">MvBlog_pluginmgr::__construct()</a> in plugins.php</div>
228                                                        <div class="index-item-description">Load all plugins into plugins array</div>
229                                        </dd>
230                        <dt class="field">
231                                                <span class="method-title">__construct</span>
232                                        </dt>
233                <dd class="index-item-body">
234                        <div class="index-item-details"><a href="MvBlog/MvBlog_import.html#method__construct">MvBlog_import::__construct()</a> in mvblog_import.php</div>
235                                                        <div class="index-item-description">Class constructor that populates the supported_blogs variable.</div>
236                                        </dd>
237                        <dt class="field">
238                                                <span class="method-title">__construct</span>
239                                        </dt>
240                <dd class="index-item-body">
241                        <div class="index-item-details"><a href="MvBlog/mvblog_AutoLoader.html#method__construct">mvblog_AutoLoader::__construct()</a> in mvblog_autoloader.php</div>
242                                                        <div class="index-item-description">Create a new mvblog_AutoLoader object. It will automatically parse</div>
243                                        </dd>
244                        <dt class="field">
245                                                <span class="method-title">__construct</span>
246                                        </dt>
247                <dd class="index-item-body">
248                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#method__construct">MvBlog_common::__construct()</a> in mvblog_common.php</div>
249                                                        <div class="index-item-description">Setup stuff and handle settings etc and populate the data containers.</div>
250                                        </dd>
251                        <dt class="field">
252                                                <span class="method-title">__construct</span>
253                                        </dt>
254                <dd class="index-item-body">
255                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#method__construct">MvBlog::__construct()</a> in mvblog.php</div>
256                                                        <div class="index-item-description">Constructor to set some defaults</div>
257                                        </dd>
258                        <dt class="field">
259                                                <span class="method-title">__construct</span>
260                                        </dt>
261                <dd class="index-item-body">
262                        <div class="index-item-details"><a href="MvBlog/mvblog_Exception.html#method__construct">mvblog_Exception::__construct()</a> in mvblog_exception.php</div>
263                                        </dd>
264                        <dt class="field">
265                                                <span class="method-title">__construct</span>
266                                        </dt>
267                <dd class="index-item-body">
268                        <div class="index-item-details"><a href="MvBlog/MvBlog_import_wordpress.html#method__construct">MvBlog_import_wordpress::__construct()</a> in mvblog_import_wordpress.php</div>
269                                        </dd>
270                </dl>
271        <a name="a"></a>
272        <div class="index-letter-section">
273                <div style="float: left" class="index-letter-title">a</div>
274                <div style="float: right"><a href="#top">top</a></div>
275                <div style="clear: both"></div>
276        </div>
277        <dl>
278                        <dt class="field">
279                                                <span class="var-title">$active</span>
280                                        </dt>
281                <dd class="index-item-body">
282                        <div class="index-item-details"><a href="MvBlog/MvBlog_plugin.html#var$active">MvBlog_plugin::$active</a> in plugins.php</div>
283                                        </dd>
284                        <dt class="field">
285                                                <span class="var-title">$active_plugins</span>
286                                        </dt>
287                <dd class="index-item-body">
288                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#var$active_plugins">MvBlog_common::$active_plugins</a> in mvblog_common.php</div>
289                                        </dd>
290                        <dt class="field">
291                                                <span class="var-title">$authors</span>
292                                        </dt>
293                <dd class="index-item-body">
294                        <div class="index-item-details"><a href="MvBlog/MvBlog_common.html#var$authors">MvBlog_common::$authors</a> in mvblog_common.php</div>
295                                        </dd>
296                        <dt class="field">
297                                                <span class="var-title">$availSettings</span>
298                                        </dt>
299                <dd class="index-item-body">
300                        <div class="index-item-details"><a href="MvBlog/mvblog_IniParser.html#var$availSettings">mvblog_IniParser::$availSettings</a> in mvblog_iniparser.php</div>
301                                        </dd>
302                        <dt class="field">
303                                                <span class="method-title">activate</span>
304                                        </dt>
305                <dd class="index-item-body">
306                        <div class="index-item-details"><a href="MvBlog/MvBlog_pluginiface.html#methodactivate">MvBlog_pluginiface::activate()</a> in plugins.php</div>
307                                        </dd>
308                        <dt class="field">
309                                                <span class="method-title">activate_plugin</span>
310                                        </dt>
311                <dd class="index-item-body">
312                        <div class="index-item-details"><a href="MvBlog/MvBlog_pluginmgr.html#methodactivate_plugin">MvBlog_pluginmgr::activate_plugin()</a> in plugins.php</div>
313                                                        <div class="index-item-description">Activate givin plugin  If the plugin is not loaded, do nothing</div>
314                                        </dd>
315                        <dt class="field">
316                                                <span class="method-title">addHook</span>
317                                        </dt>
318                <dd class="index-item-body">
319                        <div class="index-item-details"><a href="MvBlog/MvBlog_pluginiface.html#methodaddHook">MvBlog_pluginiface::addHook()</a> in plugins.php</div>
320                                        </dd>
321                        <dt class="field">
322                                                <span class="method-title">addHook</span>
323                                        </dt>
324                <dd class="index-item-body">
325                        <div class="index-item-details"><a href="MvBlog/MvBlog_plugin.html#methodaddHook">MvBlog_plugin::addHook()</a> in plugins.php</div>
326                                        </dd>
327                        <dt class="field">
328                                                <span class="method-title">apply_dbpatch</span>
329                                        </dt>
330                <dd class="index-item-body">
331                        <div class="index-item-details"><a href="MvBlog/Mvblog_upgrade.html#methodapply_dbpatch">Mvblog_upgrade::apply_dbpatch()</a> in mvblog_upgrade.php</div>
332                                                        <div class="index-item-description">Apply a specific database patch</div>
333                                        </dd>
334                        <dt class="field">
335                                                <span class="method-title">autoload</span>
336                                        </dt>
337                <dd class="index-item-body">
338                        <div class="index-item-details"><a href="MvBlog/mvblog_AutoLoader.html#methodautoload">mvblog_AutoLoader::autoload()</a> in mvblog_autoloader.php</div>
339                                                        <div class="index-item-description">The autoloader. It looks through all the paths and tries to find a file that contains the class to include.</div>
340                                        </dd>
341                </dl>
342        <a name="b"></a>
343        <div class="index-letter-section">
344                <div style="float: left" class="index-letter-title">b</div>
345                <div style="float: right"><a href="#top">top</a></div>
346                <div style="clear: both"></div>
347        </div>
348        <dl>
349                        <dt class="field">
350                                                <span class="method-title">blog_archive_links</span>
351                                        </dt>
352                <dd class="index-item-body">
353                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_archive_links">MvBlog::blog_archive_links()</a> in mvblog.php</div>
354                                                        <div class="index-item-description">show 'month archive' menu links</div>
355                                        </dd>
356                        <dt class="field">
357                                                <span class="method-title">blog_cats_links</span>
358                                        </dt>
359                <dd class="index-item-body">
360                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_cats_links">MvBlog::blog_cats_links()</a> in mvblog.php</div>
361                                                        <div class="index-item-description">show 'categories' archive menu links</div>
362                                        </dd>
363                        <dt class="field">
364                                                <span class="method-title">blog_content</span>
365                                        </dt>
366                <dd class="index-item-body">
367                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_content">MvBlog::blog_content()</a> in mvblog.php</div>
368                                                        <div class="index-item-description">main function to give user correct html depending on action etc</div>
369                                        </dd>
370                        <dt class="field">
371                                                <span class="method-title">blog_default_links</span>
372                                        </dt>
373                <dd class="index-item-body">
374                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_default_links">MvBlog::blog_default_links()</a> in mvblog.php</div>
375                                                        <div class="index-item-description">show default menu links</div>
376                                        </dd>
377                        <dt class="field">
378                                                <span class="method-title">blog_get_description</span>
379                                        </dt>
380                <dd class="index-item-body">
381                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_get_description">MvBlog::blog_get_description()</a> in mvblog.php</div>
382                                                        <div class="index-item-description">Get blogsetting description from database</div>
383                                        </dd>
384                        <dt class="field">
385                                                <span class="method-title">blog_get_title</span>
386                                        </dt>
387                <dd class="index-item-body">
388                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_get_title">MvBlog::blog_get_title()</a> in mvblog.php</div>
389                                                        <div class="index-item-description">get the blog title.</div>
390                                        </dd>
391                        <dt class="field">
392                                                <span class="method-title">blog_show_dossierlinks</span>
393                                        </dt>
394                <dd class="index-item-body">
395                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_show_dossierlinks">MvBlog::blog_show_dossierlinks()</a> in mvblog.php</div>
396                                                        <div class="index-item-description">Show list of dossiers.</div>
397                                        </dd>
398                        <dt class="field">
399                                                <span class="method-title">blog_show_login</span>
400                                        </dt>
401                <dd class="index-item-body">
402                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_show_login">MvBlog::blog_show_login()</a> in mvblog.php</div>
403                                                        <div class="index-item-description">Show login screen or username</div>
404                                        </dd>
405                        <dt class="field">
406                                                <span class="method-title">blog_show_menulinks</span>
407                                        </dt>
408                <dd class="index-item-body">
409                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_show_menulinks">MvBlog::blog_show_menulinks()</a> in mvblog.php</div>
410                                                        <div class="index-item-description">get usersupplied sidebar menu entries</div>
411                                        </dd>
412                        <dt class="field">
413                                                <span class="method-title">blog_show_search</span>
414                                        </dt>
415                <dd class="index-item-body">
416                        <div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_show_search">MvBlog::blog_show_search()</a> in mvblog.php</div>
417