Context Navigation

elementindex.html

Revision 759, 76.9 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>Full index</h2>
14	<h3>Package indexes</h3>
15	<ul>
16	<li><a href="elementindex_MvBlog.html">MvBlog</a></li>
17	</ul>
18	<br />
19	<div class="index-letter-menu">
20	<a class="index-letter" href="elementindex.html#a">a</a>
21	<a class="index-letter" href="elementindex.html#b">b</a>
22	<a class="index-letter" href="elementindex.html#c">c</a>
23	<a class="index-letter" href="elementindex.html#d">d</a>
24	<a class="index-letter" href="elementindex.html#e">e</a>
25	<a class="index-letter" href="elementindex.html#f">f</a>
26	<a class="index-letter" href="elementindex.html#g">g</a>
27	<a class="index-letter" href="elementindex.html#h">h</a>
28	<a class="index-letter" href="elementindex.html#i">i</a>
29	<a class="index-letter" href="elementindex.html#l">l</a>
30	<a class="index-letter" href="elementindex.html#m">m</a>
31	<a class="index-letter" href="elementindex.html#o">o</a>
32	<a class="index-letter" href="elementindex.html#p">p</a>
33	<a class="index-letter" href="elementindex.html#r">r</a>
34	<a class="index-letter" href="elementindex.html#s">s</a>
35	<a class="index-letter" href="elementindex.html#t">t</a>
36	<a class="index-letter" href="elementindex.html#u">u</a>
37	<a class="index-letter" href="elementindex.html#v">v</a>
38	<a class="index-letter" href="elementindex.html#w">w</a>
39	<a class="index-letter" href="elementindex.html#_">_</a>
40	</div>
41
42	<a name="a"></a>
43	<div class="index-letter-section">
44	<div style="float: left" class="index-letter-title">a</div>
45	<div style="float: right"><a href="#top">top</a></div>
46	<div style="clear: both"></div>
47	</div>
48	<dl>
49	<dt class="field">
50	<span class="var-title">$active</span>
51	</dt>
52	<dd class="index-item-body">
53	<div class="index-item-details"><a href="MvBlog/MvBlog_plugin.html#var$active">MvBlog_plugin::$active</a> in plugins.php</div>
54	</dd>
55	<dt class="field">
56	<span class="var-title">$active_plugins</span>
57	</dt>
58	<dd class="index-item-body">
59	<div class="index-item-details"><a href="MvBlog/MvBlog_common.html#var$active_plugins">MvBlog_common::$active_plugins</a> in mvblog_common.php</div>
60	</dd>
61	<dt class="field">
62	<span class="var-title">$authors</span>
63	</dt>
64	<dd class="index-item-body">
65	<div class="index-item-details"><a href="MvBlog/MvBlog_common.html#var$authors">MvBlog_common::$authors</a> in mvblog_common.php</div>
66	</dd>
67	<dt class="field">
68	<span class="var-title">$availSettings</span>
69	</dt>
70	<dd class="index-item-body">
71	<div class="index-item-details"><a href="MvBlog/mvblog_IniParser.html#var$availSettings">mvblog_IniParser::$availSettings</a> in mvblog_iniparser.php</div>
72	</dd>
73	<dt class="field">
74	<span class="method-title">activate</span>
75	</dt>
76	<dd class="index-item-body">
77	<div class="index-item-details"><a href="MvBlog/MvBlog_pluginiface.html#methodactivate">MvBlog_pluginiface::activate()</a> in plugins.php</div>
78	</dd>
79	<dt class="field">
80	<span class="method-title">activate_plugin</span>
81	</dt>
82	<dd class="index-item-body">
83	<div class="index-item-details"><a href="MvBlog/MvBlog_pluginmgr.html#methodactivate_plugin">MvBlog_pluginmgr::activate_plugin()</a> in plugins.php</div>
84	<div class="index-item-description">Activate givin plugin If the plugin is not loaded, do nothing</div>
85	</dd>
86	<dt class="field">
87	<span class="method-title">addHook</span>
88	</dt>
89	<dd class="index-item-body">
90	<div class="index-item-details"><a href="MvBlog/MvBlog_pluginiface.html#methodaddHook">MvBlog_pluginiface::addHook()</a> in plugins.php</div>
91	</dd>
92	<dt class="field">
93	<span class="method-title">addHook</span>
94	</dt>
95	<dd class="index-item-body">
96	<div class="index-item-details"><a href="MvBlog/MvBlog_plugin.html#methodaddHook">MvBlog_plugin::addHook()</a> in plugins.php</div>
97	</dd>
98	<dt class="field">
99	<span class="method-title">apply_dbpatch</span>
100	</dt>
101	<dd class="index-item-body">
102	<div class="index-item-details"><a href="MvBlog/Mvblog_upgrade.html#methodapply_dbpatch">Mvblog_upgrade::apply_dbpatch()</a> in mvblog_upgrade.php</div>
103	<div class="index-item-description">Apply a specific database patch</div>
104	</dd>
105	<dt class="field">
106	<span class="method-title">autoload</span>
107	</dt>
108	<dd class="index-item-body">
109	<div class="index-item-details"><a href="MvBlog/mvblog_AutoLoader.html#methodautoload">mvblog_AutoLoader::autoload()</a> in mvblog_autoloader.php</div>
110	<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>
111	</dd>
112	</dl>
113	<a name="b"></a>
114	<div class="index-letter-section">
115	<div style="float: left" class="index-letter-title">b</div>
116	<div style="float: right"><a href="#top">top</a></div>
117	<div style="clear: both"></div>
118	</div>
119	<dl>
120	<dt class="field">
121	<span class="method-title">blog_archive_links</span>
122	</dt>
123	<dd class="index-item-body">
124	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_archive_links">MvBlog::blog_archive_links()</a> in mvblog.php</div>
125	<div class="index-item-description">show 'month archive' menu links</div>
126	</dd>
127	<dt class="field">
128	<span class="method-title">blog_cats_links</span>
129	</dt>
130	<dd class="index-item-body">
131	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_cats_links">MvBlog::blog_cats_links()</a> in mvblog.php</div>
132	<div class="index-item-description">show 'categories' archive menu links</div>
133	</dd>
134	<dt class="field">
135	<span class="method-title">blog_content</span>
136	</dt>
137	<dd class="index-item-body">
138	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_content">MvBlog::blog_content()</a> in mvblog.php</div>
139	<div class="index-item-description">main function to give user correct html depending on action etc</div>
140	</dd>
141	<dt class="field">
142	<span class="method-title">blog_default_links</span>
143	</dt>
144	<dd class="index-item-body">
145	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_default_links">MvBlog::blog_default_links()</a> in mvblog.php</div>
146	<div class="index-item-description">show default menu links</div>
147	</dd>
148	<dt class="field">
149	<span class="method-title">blog_get_description</span>
150	</dt>
151	<dd class="index-item-body">
152	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_get_description">MvBlog::blog_get_description()</a> in mvblog.php</div>
153	<div class="index-item-description">Get blogsetting description from database</div>
154	</dd>
155	<dt class="field">
156	<span class="method-title">blog_get_title</span>
157	</dt>
158	<dd class="index-item-body">
159	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_get_title">MvBlog::blog_get_title()</a> in mvblog.php</div>
160	<div class="index-item-description">get the blog title.</div>
161	</dd>
162	<dt class="field">
163	<span class="method-title">blog_show_dossierlinks</span>
164	</dt>
165	<dd class="index-item-body">
166	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_show_dossierlinks">MvBlog::blog_show_dossierlinks()</a> in mvblog.php</div>
167	<div class="index-item-description">Show list of dossiers.</div>
168	</dd>
169	<dt class="field">
170	<span class="method-title">blog_show_login</span>
171	</dt>
172	<dd class="index-item-body">
173	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_show_login">MvBlog::blog_show_login()</a> in mvblog.php</div>
174	<div class="index-item-description">Show login screen or username</div>
175	</dd>
176	<dt class="field">
177	<span class="method-title">blog_show_menulinks</span>
178	</dt>
179	<dd class="index-item-body">
180	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_show_menulinks">MvBlog::blog_show_menulinks()</a> in mvblog.php</div>
181	<div class="index-item-description">get usersupplied sidebar menu entries</div>
182	</dd>
183	<dt class="field">
184	<span class="method-title">blog_show_search</span>
185	</dt>
186	<dd class="index-item-body">
187	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_show_search">MvBlog::blog_show_search()</a> in mvblog.php</div>
188	<div class="index-item-description">show livesearchbox</div>
189	</dd>
190	<dt class="field">
191	<span class="method-title">blog_show_styleswitcher</span>
192	</dt>
193	<dd class="index-item-body">
194	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodblog_show_styleswitcher">MvBlog::blog_show_styleswitcher()</a> in mvblog.php</div>
195	<div class="index-item-description">show dropdown with styles</div>
196	</dd>
197	</dl>
198	<a name="c"></a>
199	<div class="index-letter-section">
200	<div style="float: left" class="index-letter-title">c</div>
201	<div style="float: right"><a href="#top">top</a></div>
202	<div style="clear: both"></div>
203	</div>
204	<dl>
205	<dt class="field">
206	<span class="var-title">$categories</span>
207	</dt>
208	<dd class="index-item-body">
209	<div class="index-item-details"><a href="MvBlog/MvBlog_common.html#var$categories">MvBlog_common::$categories</a> in mvblog_common.php</div>
210	</dd>
211	<dt class="field">
212	<span class="method-title">check_admin_logged_in</span>
213	</dt>
214	<dd class="index-item-body">
215	<div class="index-item-details"><a href="MvBlog/MvBlog.html#methodcheck_admin_logged_in">MvBlog::check_admin_logged_in()</a> in mvblog.php</div>
216	<div class="index-item-description">Check to see if the admin session is set</div>
217	</dd>
218	<dt class="field">
219	<span class="method-title">check_login</span>
220	</dt>
221	<dd class="index-item-body">
222	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methodcheck_login">MvBlog_admin::check_login()</a> in mvblog_admin.php</div>
223	<div class="index-item-description">Check user supplied data against admin database</div>
224	</dd>
225	<dt class="field">
226	<span class="include-title">captcha.php</span>
227	</dt>
228	<dd class="index-item-body">
229	<div class="index-item-details"><a href="MvBlog/_common---captcha.php.html">captcha.php</a> in captcha.php</div>
230	</dd>
231	<dt class="field">
232	<span class="method-title">configure_plugin</span>
233	</dt>
234	<dd class="index-item-body">
235	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methodconfigure_plugin">MvBlog_admin::configure_plugin()</a> in mvblog_admin.php</div>
236	<div class="index-item-description">Run specified plugins 'show_settings' method.</div>
237	</dd>
238	<dt class="field">
239	<span class="method-title">copy_files</span>
240	</dt>
241	<dd class="index-item-body">
242	<div class="index-item-details"><a href="MvBlog/MvBlog_common.html#methodcopy_files">MvBlog_common::copy_files()</a> in mvblog_common.php</div>
243	<div class="index-item-description">Copies files and directories recursive to dirs under site_images</div>
244	</dd>
245	<dt class="field">
246	<span class="method-title">create_backups</span>
247	</dt>
248	<dd class="index-item-body">
249	<div class="index-item-details"><a href="MvBlog/Mvblog_upgrade.html#methodcreate_backups">Mvblog_upgrade::create_backups()</a> in mvblog_upgrade.php</div>
250	<div class="index-item-description">Create a database backup before running the pathes against it so we can rollback when something goes wrong</div>
251	</dd>
252	</dl>
253	<a name="d"></a>
254	<div class="index-letter-section">
255	<div style="float: left" class="index-letter-title">d</div>
256	<div style="float: right"><a href="#top">top</a></div>
257	<div style="clear: both"></div>
258	</div>
259	<dl>
260	<dt class="field">
261	<span class="var-title">$db</span>
262	</dt>
263	<dd class="index-item-body">
264	<div class="index-item-details"><a href="MvBlog/MvBlog_common.html#var$db">MvBlog_common::$db</a> in mvblog_common.php</div>
265	</dd>
266	<dt class="field">
267	<span class="var-title">$development_hostnames</span>
268	</dt>
269	<dd class="index-item-body">
270	<div class="index-item-details"><a href="MvBlog/MvBlog_debug.html#var$development_hostnames">MvBlog_debug::$development_hostnames</a> in mvblog_debug.php</div>
271	</dd>
272	<dt class="field">
273	<span class="var-title">$dossiers</span>
274	</dt>
275	<dd class="index-item-body">
276	<div class="index-item-details"><a href="MvBlog/MvBlog_common.html#var$dossiers">MvBlog_common::$dossiers</a> in mvblog_common.php</div>
277	</dd>
278	<dt class="field">
279	<span class="method-title">db_quote</span>
280	</dt>
281	<dd class="index-item-body">
282	<div class="index-item-details"><a href="MvBlog/MvBlog_common.html#methoddb_quote">MvBlog_common::db_quote()</a> in mvblog_common.php</div>
283	<div class="index-item-description">Quote a fieldname with the database specific quote style</div>
284	</dd>
285	<dt class="field">
286	<span class="method-title">deactivate</span>
287	</dt>
288	<dd class="index-item-body">
289	<div class="index-item-details"><a href="MvBlog/MvBlog_pluginiface.html#methoddeactivate">MvBlog_pluginiface::deactivate()</a> in plugins.php</div>
290	</dd>
291	<dt class="field">
292	<span class="method-title">deactivate_plugin</span>
293	</dt>
294	<dd class="index-item-body">
295	<div class="index-item-details"><a href="MvBlog/MvBlog_pluginmgr.html#methoddeactivate_plugin">MvBlog_pluginmgr::deactivate_plugin()</a> in plugins.php</div>
296	<div class="index-item-description">deActivate givin plugin If the plugin is not loaded, do nothing</div>
297	</dd>
298	<dt class="field">
299	<span class="method-title">delete_cat</span>
300	</dt>
301	<dd class="index-item-body">
302	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methoddelete_cat">MvBlog_admin::delete_cat()</a> in mvblog_admin.php</div>
303	<div class="index-item-description">Delete category from database</div>
304	</dd>
305	<dt class="field">
306	<span class="method-title">delete_comment</span>
307	</dt>
308	<dd class="index-item-body">
309	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methoddelete_comment">MvBlog_admin::delete_comment()</a> in mvblog_admin.php</div>
310	<div class="index-item-description">Delete a comment from the database</div>
311	</dd>
312	<dt class="field">
313	<span class="method-title">delete_dossier</span>
314	</dt>
315	<dd class="index-item-body">
316	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methoddelete_dossier">MvBlog_admin::delete_dossier()</a> in mvblog_admin.php</div>
317	<div class="index-item-description">Delete dossier from database</div>
318	</dd>
319	<dt class="field">
320	<span class="method-title">delete_inactive_users</span>
321	</dt>
322	<dd class="index-item-body">
323	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methoddelete_inactive_users">MvBlog_admin::delete_inactive_users()</a> in mvblog_admin.php</div>
324	<div class="index-item-description">Delete users that are inactive for some time</div>
325	</dd>
326	<dt class="field">
327	<span class="method-title">delete_post</span>
328	</dt>
329	<dd class="index-item-body">
330	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methoddelete_post">MvBlog_admin::delete_post()</a> in mvblog_admin.php</div>
331	<div class="index-item-description">delete a post from the db</div>
332	</dd>
333	<dt class="field">
334	<span class="method-title">delete_user</span>
335	</dt>
336	<dd class="index-item-body">
337	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methoddelete_user">MvBlog_admin::delete_user()</a> in mvblog_admin.php</div>
338	<div class="index-item-description">remove user from database</div>
339	</dd>
340	</dl>
341	<a name="e"></a>
342	<div class="index-letter-section">
343	<div style="float: left" class="index-letter-title">e</div>
344	<div style="float: right"><a href="#top">top</a></div>
345	<div style="clear: both"></div>
346	</div>
347	<dl>
348	<dt class="field">
349	<span class="var-title">$error_names</span>
350	</dt>
351	<dd class="index-item-body">
352	<div class="index-item-details"><a href="MvBlog/MvBlog_debug.html#var$error_names">MvBlog_debug::$error_names</a> in mvblog_debug.php</div>
353	</dd>
354	<dt class="field">
355	<span class="method-title">edit_author</span>
356	</dt>
357	<dd class="index-item-body">
358	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methodedit_author">MvBlog_admin::edit_author()</a> in mvblog_admin.php</div>
359	<div class="index-item-description">show form to manipulate author</div>
360	</dd>
361	<dt class="field">
362	<span class="method-title">edit_cat</span>
363	</dt>
364	<dd class="index-item-body">
365	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methodedit_cat">MvBlog_admin::edit_cat()</a> in mvblog_admin.php</div>
366	<div class="index-item-description">Show form to edit a category.</div>
367	</dd>
368	<dt class="field">
369	<span class="method-title">edit_dossier</span>
370	</dt>
371	<dd class="index-item-body">
372	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methodedit_dossier">MvBlog_admin::edit_dossier()</a> in mvblog_admin.php</div>
373	<div class="index-item-description">Show form to edit a dossier.</div>
374	</dd>
375	<dt class="field">
376	<span class="method-title">edit_plugin_setting</span>
377	</dt>
378	<dd class="index-item-body">
379	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methodedit_plugin_setting">MvBlog_admin::edit_plugin_setting()</a> in mvblog_admin.php</div>
380	<div class="index-item-description">run $plugin->edit_setting so a plugin can show edit screen</div>
381	</dd>
382	<dt class="field">
383	<span class="method-title">edit_post</span>
384	</dt>
385	<dd class="index-item-body">
386	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methodedit_post">MvBlog_admin::edit_post()</a> in mvblog_admin.php</div>
387	<div class="index-item-description">show user a form to edit the post</div>
388	</dd>
389	<dt class="field">
390	<span class="method-title">edit_user</span>
391	</dt>
392	<dd class="index-item-body">
393	<div class="index-item-details"><a href="MvBlog/MvBlog_admin.html#methodedit_user">MvBlog_admin::edit_user()</a> in mvblog_admin.php</div>
394	<div class="index-item-description">show form to manipulate user</div>
395	</dd>
396	</dl>
397	<a name="f"></a>
398	<div class="index-letter-section">
399	<div style="float: left" class="index-letter-title">f</div>
400	<div style="float: right"><a href="#top">top</a></div>
401	<div style="clear: both"></div>
402	</div>
403	<dl>
404	<dt class="field">
405	<span class="var-title">$filename</span>
406	</dt>
407	<dd class="index-item-body">
408	<div class="index-item-details"><a href="MvBlog/mvblog_IniFileReader.html#var$filename">mvblog_IniFileReader::$filename</a> in mvblog_inifilereader.php</div>
409	</dd>
410	</dl>
411	<a name="g"></a>
412	<div class="index-letter-section">
413	<div style="float: left" class="index-letter-title">g</div>
414	<div style="float: right"><a href="#top">top</a></div>
415	<div style="clear: both"></div>
416	</div>
417	<dl>
418	<dt class="field">
419	<span class="method-title">getSetting</span>
420	</dt>
421	<dd class="index-item-body">
422	<div class="index-item-details"><a href="MvBlog/mvblog_IniParser.html#methodgetSetting">mvblog_IniParser::getSetting()</a> in mvblog_iniparser.php</div>
423	</dd>
424	<dt class="field">
425	<span class="method-title">getSettings</span>
426	</dt>
427	<dd class