mirror of
https://github.com/Yetangitu/ampache
synced 2025-10-06 03:49:56 +02:00
867 lines
No EOL
32 KiB
HTML
867 lines
No EOL
32 KiB
HTML
<html>
|
|
<head>
|
|
<title>Docs for page ui.lib.php</title>
|
|
<link rel="stylesheet" type="text/css" href="../media/style.css">
|
|
</head>
|
|
<body>
|
|
|
|
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
|
|
<tr>
|
|
<td class="header_top">Web</td>
|
|
</tr>
|
|
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
|
|
<tr>
|
|
<td class="header_menu">
|
|
|
|
|
|
[ <a href="../classtrees_Web.html" class="menu">class tree: Web</a> ]
|
|
[ <a href="../elementindex_Web.html" class="menu">index: Web</a> ]
|
|
[ <a href="../elementindex.html" class="menu">all elements</a> ]
|
|
</td>
|
|
</tr>
|
|
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
|
|
</table>
|
|
|
|
<table width="100%" border="0" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="200" class="menu">
|
|
<div id="todolist">
|
|
<p><a href="../todolist.html">Todo List</a></p>
|
|
</div>
|
|
<b>Packages:</b><br />
|
|
<a href="../li_Ampache.html">Ampache</a><br />
|
|
<a href="../li_Catalog.html">Catalog</a><br />
|
|
<a href="../li_Horde_Browser.html">Horde_Browser</a><br />
|
|
<a href="../li_Search.html">Search</a><br />
|
|
<a href="../li_Web.html">Web</a><br />
|
|
<a href="../li_XMLRPC.html">XMLRPC</a><br />
|
|
<a href="../li_XML_RPC.html">XML_RPC</a><br />
|
|
<br /><br />
|
|
<b>Files:</b><br />
|
|
<div class="package">
|
|
<a href="../Web/_lib---ui.lib.php.html"> ui.lib.php
|
|
</a><br>
|
|
</div><br />
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
|
|
|
|
<h1>Procedural File: ui.lib.php</h1>
|
|
Source Location: /lib/ui.lib.php<br /><br />
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h2>Page Details:</h2>
|
|
UI Function Library<br /><br /><p>This contains functions that are generic, and display information things like a confirmation box, etc and so forth</p><br /><br /><br />
|
|
<br /><br />
|
|
<br /><br />
|
|
<br />
|
|
<hr />
|
|
<a name="functionaccess_denied"></a>
|
|
<h3>access_denied <span class="smalllinenumber">[line 99]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void access_denied(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
access_denied<br /><br /><p>throws an error if they try to do something that they aren't allowed to</p><br /> <br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionajax_include"></a>
|
|
<h3>ajax_include <span class="smalllinenumber">[line 912]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void ajax_include(
|
|
$include)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
ajax_include<br /><br /><p>This does an ob_start, getcontents, clean on the specified require, only works if you don't need to pass data in</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$include</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionflip_class"></a>
|
|
<h3>flip_class <span class="smalllinenumber">[line 57]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void flip_class(
|
|
[ $array = 0])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
flip_class<br /><br /><p>takes an array of 2 class names and flips them back and forth and then echo's out [0]</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$array</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionget_location"></a>
|
|
<h3>get_location <span class="smalllinenumber">[line 338]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void get_location(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
get_location<br /><br /><p>This function gets the information about said persons currently location this is used for A) Sidebar highlighting & submenu showing and B) Titlebar information it returns an array of information about what they are currently doing Possible array elements ['title'] Text name for the page ['page'] actual page name ['section'] name of the section we are in, admin, browse etc (submenu control)</p><br /> <br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionget_user_icon"></a>
|
|
<h3>get_user_icon <span class="smalllinenumber">[line 705]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void get_user_icon(
|
|
$name, [ $title = ''], [ $id = ''])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
get_user_icon<br /><br /><p>this function takes a name and a returns either a text representation or an <img /> tag</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$name</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$title</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$id</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functiongood_email"></a>
|
|
<h3>good_email <span class="smalllinenumber">[line 449]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void good_email(
|
|
$email)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
good_email<br /><br /><p>Don't get me started... I'm sure the indenting is still wrong on this it shouldn't be named this, it should be documented, yea this needs some serious MOJO work</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$email</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionimg_resize"></a>
|
|
<h3>img_resize <span class="smalllinenumber">[line 223]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void img_resize(
|
|
$image, $size, $type, $album_id)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
img_resize<br /><br /><p>this automaticly resizes the image for thumbnail viewing only works on gif/jpg/png this function also checks to make sure php-gd is enabled</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$image</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$size</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$type</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$album_id</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionngettext"></a>
|
|
<h3>ngettext <span class="smalllinenumber">[line 89]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void ngettext(
|
|
$string)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
ngettext<br /><br /><p>checks for ngettext and defines it if it doesn't exist</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$string</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionreturn_referer"></a>
|
|
<h3>return_referer <span class="smalllinenumber">[line 114]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void return_referer(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
return_referer<br /><br /><p>returns the script part of the referer address passed by the web browser this is not %100 accurate. Also because this is not passed by us we need to clean it up, take the filename then check for a /admin/ and dump the rest</p><br /> <br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_album_select"></a>
|
|
<h3>show_album_select <span class="smalllinenumber">[line 483]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_album_select(
|
|
[ $name = 'album'], [ $album_id = 0], [ $allow_add = 0], [ $song_id = 0])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_album_select<br /><br /><p>This displays a select of every album that we've got in Ampache, (it can be hella long) it's used by the Edit page, it takes a $name and a $album_id</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$name</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$album_id</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$allow_add</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$song_id</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_alphabet_list"></a>
|
|
<h3>show_alphabet_list <span class="smalllinenumber">[line 139]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_alphabet_list(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_alphabet_list<br /><br /><p>shows the A-Z,0-9 lists for albums and artist page It takes a selected and an action</p><br /> <br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_artist_select"></a>
|
|
<h3>show_artist_select <span class="smalllinenumber">[line 522]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_artist_select(
|
|
[ $name = 'artist'], [ $artist_id = 0], [ $allow_add = 0], [ $song_id = 0])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_artist_select<br /><br /><p>This is the same as the album select except it's *gasp* for artists how inventive!</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$name</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$artist_id</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$allow_add</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$song_id</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_box_bottom"></a>
|
|
<h3>show_box_bottom <span class="smalllinenumber">[line 694]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_box_bottom(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_box_bottom<br /><br /><p>This function requires the bottom part of the box it does not take any arguments</p><br /> <br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_box_top"></a>
|
|
<h3>show_box_top <span class="smalllinenumber">[line 683]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_box_top(
|
|
[ $title = ''], [ $class = ''])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_box_top<br /><br /><p>This function requires the top part of the box it takes title as an optional argument</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$title</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$class</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_catalog_select"></a>
|
|
<h3>show_catalog_select <span class="smalllinenumber">[line 603]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_catalog_select(
|
|
[ $name = 'catalog'], [ $catalog_id = 0], [ $style = ''])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_catalog_select<br /><br /><p>Yet another one of these buggers. this shows a drop down of all of your catalogs</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$name</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$catalog_id</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$style</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_confirmation"></a>
|
|
<h3>show_confirmation <span class="smalllinenumber">[line 38]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_confirmation(
|
|
$title, $text, $next_url, [ $cancel = 0], [ $form_name = 'confirmation'])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_confirmation<br /><br /><p>shows a confirmation of an action $next_url Where to go next $title The Title of the message $text The details of the message $cancel T/F show a cancel button that uses return_referrer()</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$title</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$text</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$next_url</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$cancel</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$form_name</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_footer"></a>
|
|
<h3>show_footer <span class="smalllinenumber">[line 208]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_footer(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_footer<br /><br /><p>shows the footer of the page</p><br /> <br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_genre"></a>
|
|
<h3>show_genre <span class="smalllinenumber">[line 319]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_genre(
|
|
$genre_id)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_genre<br /><br /><p>this shows a single genre item which is basicly just a link to the albums/artists/songs of said genre</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$genre_id</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_genres"></a>
|
|
<h3>show_genres <span class="smalllinenumber">[line 309]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_genres(
|
|
$genres, $view)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_genres<br /><br /><p>this shows the 'many' genre form, it takes an array of genre objects and the view object</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$genres</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$view</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_genre_select"></a>
|
|
<h3>show_genre_select <span class="smalllinenumber">[line 561]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_genre_select(
|
|
[ $name = 'genre'], [ $genre_id = 1], [ $size = ''], [ $allow_add = 0], [ $song_id = 0])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_genre_select<br /><br /><p>It's amazing we have three of these funtions now, this one shows a select of genres and take s name and a selected genre... Woot!</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$name</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$genre_id</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$size</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$allow_add</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$song_id</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_header"></a>
|
|
<h3>show_header <span class="smalllinenumber">[line 198]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_header(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_header<br /><br /><p>This shows the header.inc.php, it may do something more in the future</p><br /> <br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_playlist_select"></a>
|
|
<h3>show_playlist_select <span class="smalllinenumber">[line 657]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_playlist_select(
|
|
$name, [ $selected = ''], [ $style = ''])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_playlist_select<br /><br /><p>This one is for users! shows a select/option statement so you can pick a user to blame</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$name</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$selected</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$style</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_preference_box"></a>
|
|
<h3>show_preference_box <span class="smalllinenumber">[line 437]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_preference_box(
|
|
$preferences)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_preference_box<br /><br /><p>This shows the preference box for the preferences pages it takes a chunck of the crazy preference array and then displays it out it does not contain the <form> </form> tags</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$preferences</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionshow_user_select"></a>
|
|
<h3>show_user_select <span class="smalllinenumber">[line 629]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void show_user_select(
|
|
$name, [ $selected = ''], [ $style = ''])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
show_user_select<br /><br /><p>This one is for users! shows a select/option statement so you can pick a user to blame</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$name</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$selected</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$style</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functiontoggle_visible"></a>
|
|
<h3>toggle_visible <span class="smalllinenumber">[line 927]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void toggle_visible(
|
|
$element)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
toggle_visible<br /><br /><p>this is identicla to the javascript command that it actually calls</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$element</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functiontruncate_with_ellipsis"></a>
|
|
<h3>truncate_with_ellipsis <span class="smalllinenumber">[line 166]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void truncate_with_ellipsis(
|
|
$text, [ $max = ''])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
truncate_with_ellipsis<br /><br /><p>Correct Spelling function that truncates text to a specific lenght and appends three dots, or an ellipsis to the end</p><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>author:</b> </td><td>Nedko Arnaudov</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$text</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$max</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionxml_from_array"></a>
|
|
<h3>xml_from_array <span class="smalllinenumber">[line 772]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void xml_from_array(
|
|
$array, [ $callback = 0], [ $type = ''])</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
xml_from_array<br /><br /><p>This takes a one dimensional array and creates a XML document form it for use primarly by the ajax mojo</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$array</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$callback</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$type</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionxml_get_footer"></a>
|
|
<h3>xml_get_footer <span class="smalllinenumber">[line 887]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void xml_get_footer(
|
|
$type)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
xml_get_footer<br /><br /><p>This takes the type and returns the correct xml footer</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$type</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="functionxml_get_header"></a>
|
|
<h3>xml_get_header <span class="smalllinenumber">[line 849]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void xml_get_header(
|
|
$type)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
xml_get_header<br /><br /><p>This takes the type and returns the correct xml header</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$type</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
<hr />
|
|
<a name="function_"></a>
|
|
<h3>_ <span class="smalllinenumber">[line 78]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void _(
|
|
$string)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
_<br /><br /><p>checks to see if the alias _ is defined if it isn't it defines it as a simple return</p><br /> <br /><br />
|
|
|
|
<h4>Parameters</h4>
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>$string</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
|
|
</div>
|
|
|
|
<div class="credit">
|
|
<hr />
|
|
Documentation generated on Thu, 12 Feb 2009 08:00:11 +0900 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
|
|
</div>
|
|
</td></tr></table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</body>
|
|
</html> |