update docs for 1.7 release
[phpfspot.git] / docs / elementindex_phpfspot.html
index 274fc90785ca337940129fa31688691ad86bbb33..7f33f8ee382a430c3eb23de71eb3e36ccaba4e8b 100644 (file)
                                        </dd>
                        <dt class="field">
                                                <img src="media/images/Method.png" alt="Method" title="Method" /></title>
-                       <span class="method-title">check_config_table</span>
+                       <span class="method-title">check_phpfspot_db</span>
                                        </dt>
                <dd class="index-item-body">
-                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodcheck_config_table">PHPFSPOT::check_config_table()</a> in phpfspot.class.php</div>
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodcheck_phpfspot_db">PHPFSPOT::check_phpfspot_db()</a> in phpfspot.class.php</div>
                                                        <div class="index-item-description">create phpfspot own sqlite database</div>
                                        </dd>
                        <dt class="field">
                                        </dd>
                        <dt class="field">
                                                <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">db_check_column_exists</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#methoddb_check_column_exists">PHPFSPOT_DB::db_check_column_exists()</a> in phpfspot_db.php</div>
+                                                       <div class="index-item-description">PHPFSPOT_DB check column exist</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
                        <span class="method-title">db_check_table_exists</span>
                                        </dt>
                <dd class="index-item-body">
                                        </dd>
                        <dt class="field">
                                                <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">db_commit_transaction</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#methoddb_commit_transaction">PHPFSPOT_DB::db_commit_transaction()</a> in phpfspot_db.php</div>
+                                                       <div class="index-item-description">commit transaction</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
                        <span class="method-title">db_exec</span>
                                        </dt>
                <dd class="index-item-body">
                                        </dd>
                        <dt class="field">
                                                <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">db_rollback_transaction</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#methoddb_rollback_transaction">PHPFSPOT_DB::db_rollback_transaction()</a> in phpfspot_db.php</div>
+                                                       <div class="index-item-description">rollback transaction()</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">db_start_transaction</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#methoddb_start_transaction">PHPFSPOT_DB::db_start_transaction()</a> in phpfspot_db.php</div>
+                                                       <div class="index-item-description">start transaction</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
                        <span class="method-title">delTag</span>
                                        </dt>
                <dd class="index-item-body">
                                        </dt>
                <dd class="index-item-body">
                        <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgen_thumb">PHPFSPOT::gen_thumb()</a> in phpfspot.class.php</div>
-                                                       <div class="index-item-description">Generates a thumbnail from photo idx</div>
+                                                       <div class="index-item-description">generates thumbnails</div>
                                        </dd>
                        <dt class="field">
                                                <img src="media/images/Page.png" alt="Page" title="Page" /></title>
                                        </dd>
                        <dt class="field">
                                                <img src="media/images/Method.png" alt="Method" title="Method" /></title>
-                       <span class="method-title">getCurrentPhoto</span>
-                                       </dt>
-               <dd class="index-item-body">
-                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetCurrentPhoto">PHPFSPOT::getCurrentPhoto()</a> in phpfspot.class.php</div>
-                                                       <div class="index-item-description">return the current photo</div>
-                                       </dd>
-                       <dt class="field">
-                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
                        <span class="method-title">getExport</span>
                                        </dt>
                <dd class="index-item-body">
                                        </dd>
                        <dt class="field">
                                                <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">get_current_photo</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_current_photo">PHPFSPOT::get_current_photo()</a> in phpfspot.class.php</div>
+                                                       <div class="index-item-description">return the current photo</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">get_current_version</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_current_version">PHPFSPOT::get_current_version()</a> in phpfspot.class.php</div>
+                                                       <div class="index-item-description">current selected photo version</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">get_db_version</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_db_version">PHPFSPOT::get_db_version()</a> in phpfspot.class.php</div>
+                                                       <div class="index-item-description">get database version</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">get_latest_version</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_latest_version">PHPFSPOT::get_latest_version()</a> in phpfspot.class.php</div>
+                                                       <div class="index-item-description">returns latest available photo version</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
                        <span class="method-title">get_meta_informations</span>
                                        </dt>
                <dd class="index-item-body">
                                        </dt>
                <dd class="index-item-body">
                        <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_photo_details">PHPFSPOT::get_photo_details()</a> in phpfspot.class.php</div>
-                                                       <div class="index-item-description">extract all photo details</div>
+                                                       <div class="index-item-description">get all photo details from F-Spot database</div>
                                        </dd>
                        <dt class="field">
                                                <img src="media/images/Method.png" alt="Method" title="Method" /></title>
                                        </dd>
                        <dt class="field">
                                                <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">get_photo_versions</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_photo_versions">PHPFSPOT::get_photo_versions()</a> in phpfspot.class.php</div>
+                                                       <div class="index-item-description">get photo versions</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">get_photo_version_name</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_photo_version_name">PHPFSPOT::get_photo_version_name()</a> in phpfspot.class.php</div>
+                                                       <div class="index-item-description">get photo version name</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
                        <span class="method-title">get_random_photo</span>
                                        </dt>
                <dd class="index-item-body">
                        <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodisValidDate">PHPFSPOT::isValidDate()</a> in phpfspot.class.php</div>
                                                        <div class="index-item-description">validates provided date</div>
                                        </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">is_valid_version</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodis_valid_version">PHPFSPOT::is_valid_version()</a> in phpfspot.class.php</div>
+                                                       <div class="index-item-description">check for invalid version of photo</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">is_valid_width</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodis_valid_width">PHPFSPOT::is_valid_width()</a> in phpfspot.class.php</div>
+                                       </dd>
                </dl>
        <a name="p"></a>
        <div class="index-letter-section">
                                        </dd>
                        <dt class="field">
                                                <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">smarty_photo_version_select_list</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodsmarty_photo_version_select_list">PHPFSPOT::smarty_photo_version_select_list()</a> in phpfspot.class.php</div>
+                                                       <div class="index-item-description">photo version select list</div>
+                                       </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
                        <span class="method-title">smarty_sort_select_list</span>
                                        </dt>
                <dd class="index-item-body">
                        <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodupdateSortOrder">PHPFSPOT::updateSortOrder()</a> in phpfspot.class.php</div>
                                                        <div class="index-item-description">updates sort order in session variable</div>
                                        </dd>
+                       <dt class="field">
+                                               <img src="media/images/Method.png" alt="Method" title="Method" /></title>
+                       <span class="method-title">update_photo_version</span>
+                                       </dt>
+               <dd class="index-item-body">
+                       <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodupdate_photo_version">PHPFSPOT::update_photo_version()</a> in phpfspot.class.php</div>
+                                                       <div class="index-item-description">update photo version in session variable</div>
+                                       </dd>
                </dl>
        <a name="w"></a>
        <div class="index-letter-section">