mirror of
https://github.com/Yetangitu/ampache
synced 2025-10-06 03:49:56 +02:00
366 lines
No EOL
19 KiB
HTML
366 lines
No EOL
19 KiB
HTML
<html>
|
|
<head>
|
|
<title>Package Catalog Element Index</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">Catalog</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_Catalog.html" class="menu">class tree: Catalog</a> ]
|
|
[ <a href="elementindex_Catalog.html" class="menu">index: Catalog</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_Search.html">Search</a><br />
|
|
<a href="li_XMLRPC.html">XMLRPC</a><br />
|
|
<a href="li_Web.html">Web</a><br />
|
|
<a href="li_Catalog.html">Catalog</a><br />
|
|
<a href="li_XML_RPC.html">XML_RPC</a><br />
|
|
<a href="li_Horde_Browser.html">Horde_Browser</a><br />
|
|
<br /><br />
|
|
<b>Files:</b><br />
|
|
<div class="package">
|
|
<a href="Catalog/_lib---class---catalog.class.php.html"> catalog.class.php
|
|
</a><br>
|
|
</div><br />
|
|
|
|
|
|
<b>Classes:</b><br />
|
|
<div class="package">
|
|
<a href="Catalog/Catalog.html">Catalog</a><br />
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
|
|
|
|
<a name="top"></a>
|
|
<h1>Element index for package Catalog</h1>
|
|
[ <a href="elementindex_Catalog.html#a">a</a> ]
|
|
[ <a href="elementindex_Catalog.html#c">c</a> ]
|
|
[ <a href="elementindex_Catalog.html#d">d</a> ]
|
|
[ <a href="elementindex_Catalog.html#e">e</a> ]
|
|
[ <a href="elementindex_Catalog.html#f">f</a> ]
|
|
[ <a href="elementindex_Catalog.html#g">g</a> ]
|
|
[ <a href="elementindex_Catalog.html#i">i</a> ]
|
|
[ <a href="elementindex_Catalog.html#k">k</a> ]
|
|
[ <a href="elementindex_Catalog.html#l">l</a> ]
|
|
[ <a href="elementindex_Catalog.html#m">m</a> ]
|
|
[ <a href="elementindex_Catalog.html#n">n</a> ]
|
|
[ <a href="elementindex_Catalog.html#o">o</a> ]
|
|
[ <a href="elementindex_Catalog.html#p">p</a> ]
|
|
[ <a href="elementindex_Catalog.html#r">r</a> ]
|
|
[ <a href="elementindex_Catalog.html#s">s</a> ]
|
|
[ <a href="elementindex_Catalog.html#u">u</a> ]
|
|
[ <a href="elementindex_Catalog.html#v">v</a> ]
|
|
[ <a href="elementindex_Catalog.html#_">_</a> ]
|
|
|
|
<hr />
|
|
<a name="_"></a>
|
|
<div>
|
|
<h2>_</h2>
|
|
<dl>
|
|
<dt><b>__construct</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#method__construct">Catalog::__construct()</a><br> Constructor</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="a"></a>
|
|
<div>
|
|
<h2>a</h2>
|
|
<dl>
|
|
<dt><b>add_files</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodadd_files">Catalog::add_files()</a><br> add_files Recurses throught $this->path and pulls out all mp3s and returns the full path in an array. Passes gather_type to determin if we need to check id3 information against the db.</dd>
|
|
<dt><b>add_to_catalog</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodadd_to_catalog">Catalog::add_to_catalog()</a><br> add_to_catalog</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="c"></a>
|
|
<div>
|
|
<h2>c</h2>
|
|
<dl>
|
|
<dt><b>$catalog_type</b></dt>
|
|
<dd>in file catalog.class.php, variable <a href="Catalog/Catalog.html#var$catalog_type">Catalog::$catalog_type</a></dd>
|
|
<dt><b>Catalog</b></dt>
|
|
<dd>in file catalog.class.php, class <a href="Catalog/Catalog.html">Catalog</a><br> Catalog Class This class handles all actual work in regards to the catalog, it contains functions for creating/listing/updated the catalogs.</dd>
|
|
<dt><b>check_album</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodcheck_album">Catalog::check_album()</a><br> check_album</dd>
|
|
<dt><b>check_artist</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodcheck_artist">Catalog::check_artist()</a><br> check_artist</dd>
|
|
<dt><b>check_local_mp3</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodcheck_local_mp3">Catalog::check_local_mp3()</a><br> check_local_mp3</dd>
|
|
<dt><b>check_remote_song</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodcheck_remote_song">Catalog::check_remote_song()</a><br> check_remote_song</dd>
|
|
<dt><b>check_tag</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodcheck_tag">Catalog::check_tag()</a><br> check_tag</dd>
|
|
<dt><b>check_title</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodcheck_title">Catalog::check_title()</a><br> check_title</dd>
|
|
<dt><b>clean</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean">Catalog::clean()</a><br> clean</dd>
|
|
<dt><b>clean_albums</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean_albums">Catalog::clean_albums()</a><br> clean_albums</dd>
|
|
<dt><b>clean_artists</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean_artists">Catalog::clean_artists()</a><br> clean_artists</dd>
|
|
<dt><b>clean_catalog</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean_catalog">Catalog::clean_catalog()</a><br> clean_catalog</dd>
|
|
<dt><b>clean_ext_info</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean_ext_info">Catalog::clean_ext_info()</a><br> clean_ext_info</dd>
|
|
<dt><b>clean_flagged</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean_flagged">Catalog::clean_flagged()</a><br> clean_flagged</dd>
|
|
<dt><b>clean_playlists</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean_playlists">Catalog::clean_playlists()</a><br> clean_playlists</dd>
|
|
<dt><b>clean_shoutbox</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean_shoutbox">Catalog::clean_shoutbox()</a><br> clean_shoutbox</dd>
|
|
<dt><b>clean_single_song</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean_single_song">Catalog::clean_single_song()</a><br> clean_single_song</dd>
|
|
<dt><b>clean_stats</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean_stats">Catalog::clean_stats()</a><br> clean_stats</dd>
|
|
<dt><b>clean_tags</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclean_tags">Catalog::clean_tags()</a><br> clean_tags</dd>
|
|
<dt><b>clear_stats</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodclear_stats">Catalog::clear_stats()</a><br> clear_stats</dd>
|
|
<dt><b>count_songs</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodcount_songs">Catalog::count_songs()</a><br> count_songs</dd>
|
|
<dt><b>count_users</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodcount_users">Catalog::count_users()</a><br> count_users</dd>
|
|
<dt><b>create</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodcreate">Catalog::create()</a><br> create</dd>
|
|
<dt><b>catalog.class.php</b></dt>
|
|
<dd>procedural page <a href="Catalog/_lib---class---catalog.class.php.html">catalog.class.php</a></dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="d"></a>
|
|
<div>
|
|
<h2>d</h2>
|
|
<dl>
|
|
<dt><b>delete</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methoddelete">Catalog::delete()</a><br> delete</dd>
|
|
<dt><b>dump_album_art</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methoddump_album_art">Catalog::dump_album_art()</a><br> dump_album_art (Added by Cucumber 20050216)</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="e"></a>
|
|
<div>
|
|
<h2>e</h2>
|
|
<dl>
|
|
<dt><b>export</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodexport">Catalog::export()</a><br> exports the catalog it exports all songs in the database to the given export type.</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="f"></a>
|
|
<div>
|
|
<h2>f</h2>
|
|
<dl>
|
|
<dt><b>format</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodformat">Catalog::format()</a><br> format</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="g"></a>
|
|
<div>
|
|
<h2>g</h2>
|
|
<dl>
|
|
<dt><b>get_albums</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_albums">Catalog::get_albums()</a></dd>
|
|
<dt><b>get_album_art</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_album_art">Catalog::get_album_art()</a><br> get_album_art</dd>
|
|
<dt><b>get_album_ids</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_album_ids">Catalog::get_album_ids()</a><br> get_album_ids</dd>
|
|
<dt><b>get_catalogs</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_catalogs">Catalog::get_catalogs()</a><br> get_catalogs</dd>
|
|
<dt><b>get_catalog_albums</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_catalog_albums">Catalog::get_catalog_albums()</a><br> get_catalog_albums()</dd>
|
|
<dt><b>get_catalog_files</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_catalog_files">Catalog::get_catalog_files()</a><br> get_catalog_files</dd>
|
|
<dt><b>get_catalog_ids</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_catalog_ids">Catalog::get_catalog_ids()</a><br> get_catalog_ids</dd>
|
|
<dt><b>get_disabled</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_disabled">Catalog::get_disabled()</a><br> get_disabled</dd>
|
|
<dt><b>get_duplicate_info</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_duplicate_info">Catalog::get_duplicate_info()</a><br> get_duplicate_info</dd>
|
|
<dt><b>get_duplicate_songs</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_duplicate_songs">Catalog::get_duplicate_songs()</a><br> get_duplicate_songs This function takes a search type and returns a list of all song_ids that are likely to be duplicates based on teh search method selected.</dd>
|
|
<dt><b>get_files</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_files">Catalog::get_files()</a></dd>
|
|
<dt><b>get_from_path</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_from_path">Catalog::get_from_path()</a><br> get_from_path</dd>
|
|
<dt><b>get_remote_album_images</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_remote_album_images">Catalog::get_remote_album_images()</a><br> get_album_images</dd>
|
|
<dt><b>get_remote_catalog</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_remote_catalog">Catalog::get_remote_catalog()</a><br> get_remote_catalog</dd>
|
|
<dt><b>get_remote_song</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_remote_song">Catalog::get_remote_song()</a><br> get_remote_song</dd>
|
|
<dt><b>get_stats</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodget_stats">Catalog::get_stats()</a><br> get_stats</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="i"></a>
|
|
<div>
|
|
<h2>i</h2>
|
|
<dl>
|
|
<dt><b>import_m3u</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodimport_m3u">Catalog::import_m3u()</a><br> import_m3u</dd>
|
|
<dt><b>insert_local_song</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodinsert_local_song">Catalog::insert_local_song()</a><br> insert_local_song</dd>
|
|
<dt><b>insert_local_video</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodinsert_local_video">Catalog::insert_local_video()</a><br> insert_local_video</dd>
|
|
<dt><b>insert_remote_song</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodinsert_remote_song">Catalog::insert_remote_song()</a><br> insert_remote_song takes the information gotten from XML-RPC and inserts it into the local database. The filename ends up being the url.</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="k"></a>
|
|
<div>
|
|
<h2>k</h2>
|
|
<dl>
|
|
<dt><b>$key</b></dt>
|
|
<dd>in file catalog.class.php, variable <a href="Catalog/Catalog.html#var$key">Catalog::$key</a></dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="l"></a>
|
|
<div>
|
|
<h2>l</h2>
|
|
<dl>
|
|
<dt><b>$last_add</b></dt>
|
|
<dd>in file catalog.class.php, variable <a href="Catalog/Catalog.html#var$last_add">Catalog::$last_add</a></dd>
|
|
<dt><b>$last_update</b></dt>
|
|
<dd>in file catalog.class.php, variable <a href="Catalog/Catalog.html#var$last_update">Catalog::$last_update</a></dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="m"></a>
|
|
<div>
|
|
<h2>m</h2>
|
|
<dl>
|
|
<dt><b>merge_stats</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodmerge_stats">Catalog::merge_stats()</a></dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="n"></a>
|
|
<div>
|
|
<h2>n</h2>
|
|
<dl>
|
|
<dt><b>$name</b></dt>
|
|
<dd>in file catalog.class.php, variable <a href="Catalog/Catalog.html#var$name">Catalog::$name</a></dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="o"></a>
|
|
<div>
|
|
<h2>o</h2>
|
|
<dl>
|
|
<dt><b>optimize_tables</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodoptimize_tables">Catalog::optimize_tables()</a><br> optimize_tables</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="p"></a>
|
|
<div>
|
|
<h2>p</h2>
|
|
<dl>
|
|
<dt><b>$path</b></dt>
|
|
<dd>in file catalog.class.php, variable <a href="Catalog/Catalog.html#var$path">Catalog::$path</a></dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="r"></a>
|
|
<div>
|
|
<h2>r</h2>
|
|
<dl>
|
|
<dt><b>$rename_pattern</b></dt>
|
|
<dd>in file catalog.class.php, variable <a href="Catalog/Catalog.html#var$rename_pattern">Catalog::$rename_pattern</a></dd>
|
|
<dt><b>run_add</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodrun_add">Catalog::run_add()</a><br> run_add</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="s"></a>
|
|
<div>
|
|
<h2>s</h2>
|
|
<dl>
|
|
<dt><b>$sort_pattern</b></dt>
|
|
<dd>in file catalog.class.php, variable <a href="Catalog/Catalog.html#var$sort_pattern">Catalog::$sort_pattern</a></dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="u"></a>
|
|
<div>
|
|
<h2>u</h2>
|
|
<dl>
|
|
<dt><b>update_last_add</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodupdate_last_add">Catalog::update_last_add()</a><br> update_last_add</dd>
|
|
<dt><b>update_remote_album_images</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodupdate_remote_album_images">Catalog::update_remote_album_images()</a></dd>
|
|
<dt><b>update_remote_catalog</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodupdate_remote_catalog">Catalog::update_remote_catalog()</a><br> update_remote_catalog</dd>
|
|
<dt><b>update_settings</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodupdate_settings">Catalog::update_settings()</a><br> update_settings</dd>
|
|
<dt><b>update_single_item</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodupdate_single_item">Catalog::update_single_item()</a><br> update_single_item</dd>
|
|
<dt><b>update_song_from_tags</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodupdate_song_from_tags">Catalog::update_song_from_tags()</a><br> update_song_from_tags</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<hr />
|
|
<a name="v"></a>
|
|
<div>
|
|
<h2>v</h2>
|
|
<dl>
|
|
<dt><b>verify_catalog</b></dt>
|
|
<dd>in file catalog.class.php, method <a href="Catalog/Catalog.html#methodverify_catalog">Catalog::verify_catalog()</a><br> verify_catalog</dd>
|
|
</dl>
|
|
</div>
|
|
<a href="elementindex_Catalog.html#top">top</a><br>
|
|
<div class="credit">
|
|
<hr />
|
|
Documentation generated on Thu, 12 Feb 2009 07:59:47 +0900 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
|
|
</div>
|
|
</td></tr></table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</body>
|
|
</html> |