Congegni/sintonia
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Forgotten doxygen comments added.

Browse source
This commit is contained in:
tomas 2004-09-12 22:21:26 +00:00
parent f62c1fab5d
commit 72d8984500
1 changed files with 93 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

106
livesupport/modules/storageServer/var/LocStor.php
View file

@ -1,19 +1,49 @@
<?
/**
* LocStor class
*
* Livesupport local storage interface
*/
/*------------------------------------------------------------------------------
Copyright (c) 2004 Media Development Loan Fund
This file is part of the LiveSupport project.
http://livesupport.campware.org/
To report bugs, send an e-mail to bugs@campware.org
LiveSupport is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
LiveSupport is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with LiveSupport; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Author : $Author: tomas $
Version : $Revision: 1.2 $
Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/storageServer/var/LocStor.php,v $
------------------------------------------------------------------------------*/
require_once '../GreenBox.php';
/**
* LocStor class
*
* Livesupport local storage interface
*/
class LocStor extends GreenBox{
/*
*
*
* @param gunid string
* @param sessid string
* @return boolean
*/
* Check if audio clip exists
*
* @param sessid string
* @param gunid string
* @return boolean
* @see GreenBox
*/
function existsAudioClip($sessid, $gunid)
{
$ac =& StoredFile::recall(&$this, '', $gunid);
@ -31,6 +61,15 @@ class LocStor extends GreenBox{
return $res;
return $ac->exists();
}
/*
* Store or replace existing audio clip
*
* @param sessid string
* @param gunid string
* @param mediaFileLP string, local path to media file
* @param mdataFileLP string, local path to metadata XML file
* @return string gunid or PEAR::error
*/
function storeAudioClip($sessid, $gunid, $mediaFileLP, $mdataFileLP)
{
// test if specified gunid exists:
@ -64,13 +103,18 @@ class LocStor extends GreenBox{
&$this, $oid, '', $mediaFileLP, $mdataFileLP
);
if(PEAR::isError($ac)) return $ac;
// $this->debugLog("parid=$parid, gunid={$ac->gunid},
// mediaFileLP=$mediaFileLP");
$res = $this->renameFile($oid, $ac->gunid, $sessid);
if(PEAR::isError($res)) return $res;
}
return $ac->gunid;
}
/*
* Delete existing audio clip
*
* @param sessid string
* @param gunid string
* @return boolean or PEAR::error
*/
function deleteAudioClip($sessid, $gunid)
{
$ac =& StoredFile::recall(&$this, '', $gunid);
@ -81,6 +125,14 @@ class LocStor extends GreenBox{
if(PEAR::isError($res)) return $res;
return TRUE;
}
/*
* Update existing audio clip metadata
*
* @param sessid string
* @param gunid string
* @param mdataFileLP string, local path to metadata XML file
* @return boolean or PEAR::error
*/
function updateAudioClipMetadata($sessid, $gunid, $mdataFileLP)
{
$ac =& StoredFile::recall(&$this, '', $gunid);
@ -89,6 +141,13 @@ class LocStor extends GreenBox{
return $res;
return $ac->replaceMetaData($mdataFileLP);
}
/*
* Make access to audio clip
*
* @param sessid string
* @param gunid string
* @return string - access symlink path or PEAR::error
*/
function accessRawAudioData($sessid, $gunid)
{
$ac =& StoredFile::recall(&$this, '', $gunid);
@ -97,6 +156,13 @@ class LocStor extends GreenBox{
return $res;
return $ac->accessRawMediaData($sessid);
}
/*
* Release access to audio clip
*
* @param sessid string
* @param tmpLink string
* @return boolean or PEAR::error
*/
function releaseRawAudioData($sessid, $tmpLink)
{
$ac =& StoredFile::recallFromLink(&$this, $tmpLink, $sessid);
@ -105,11 +171,25 @@ class LocStor extends GreenBox{
return $res;
return $ac->releaseRawMediaData($sessid);
}
/*
* Search in metadata database
*
* @param sessid string
* @param criteria string
* @return array or PEAR::error
*/
function searchMetadata($sessid, $criteria)
{
$res = $this->localSearch($criteria, $sessid);
return $res;
}
/*
* Return metadata as XML
*
* @param sessid string
* @param gunid string
* @return string or PEAR::error
*/
function getAudioClip($sessid, $gunid)
{
$ac =& StoredFile::recall(&$this, '', $gunid);