[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Phpgroupware-cvs] phpgwapi/inc/class.ipc_.inc.php, 1.5
From: |
nomail |
Subject: |
[Phpgroupware-cvs] phpgwapi/inc/class.ipc_.inc.php, 1.5 |
Date: |
Thu, 30 Dec 2004 07:47:30 +0100 |
Update of /phpgwapi/inc
Added Files:
Branch:
class.ipc_.inc.php
date: 2004/12/30 06:47:30; author: skwashd; state: Exp; lines: +1 -1
Log Message:
new HEAD
=====================================================================
<?php
/**
* Abstract IPC Application class for the IPC Layer
* @author Dirk Schaller <address@hidden>
* @copyright Copyright (C) 2003-2004 Free Software Foundation, Inc.
http://www.fsf.org/
* @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General
Public License
* @package phpgwapi
* @subpackage communication
* @version $Id: class.ipc_.inc.php,v 1.5 2004/12/30 06:47:30 skwashd
Exp $
*/
/**
* Abstract IPC Application class for the IPC Layer
* @package phpgwapi
* @subpackage communication
* @abstract
*/
class ipc_
{
/**
* Constructor
*
* @abstract
* @access public
*/
function ipc_()
{
die('call abstract method:
'.__class__.'::'.__function__);
}
/**
* Add data in a certain mime type format to the application.
*
* @abstract
* @param mixed $data data for adding to the application,
the datatype depends on the mime type
* @param string $type specifies the mime type of the
passed data
* @return integer id of the added data
*/
function addData($data, $type)
{
die('call abstract method:
'.__class__.'::'.__function__);
}
/**
* Convert data from a mime type to another.
*
* @abstract
* @access public
* @param mixed $data data for converting, the datatype
depends on the input mime type
* @param string $typeIn specifies the input mime type of
the passed data
* @param string $typeOut specifies the output mime type of
the passed data
* @return mixed converted data from application,
the datatype depends on the passed output mime type
*/
function convertData($data, $typeIn, $typeOut)
{
die('call abstract method:
'.__class__.'::'.__function__);
}
/**
* Checks if data for the passed id exists.
*
* @abstract
* @param integer $id id to check
* @return boolean true if the data with id exist,
otherwise false
*/
function existData($id)
{
die('call abstract method:
'.__class__.'::'.__function__);
}
/**
* Get data from the application in a certain mime type format.
*
* @abstract
* @param integer $id id of data to get from the
application
* @param string $type specifies the mime type of the
returned data
* @return mixed data from application, the datatype
depends on the passed mime type, false if no data exists for the passed id
*/
function getData($id, $type)
{
die('call abstract method:
'.__class__.'::'.__function__);
}
/**
* Return a list with the available id's in the application.
* The optional lastmod parameter allows a limitations of the
data id list.
* The list contains all the id's of the modified data since the
passed lastmod timestamp.
*
* @abstract
* @param integer $lastmod last modification time, default
is -1 and means return all data id's
* @return array list of data id's
*/
function getIdList($time=-1)
{
die('call abstract method:
'.__class__.'::'.__function__);
}
/**
* Remove data of the passed id.
*
* @abstract
* @param integer $id id of data to remove from the
application
* @return boolean true if the data is removed, otherwise
false
*/
function removeData($id)
{
die('call abstract method:
'.__class__.'::'.__function__);
}
/**
* Replace the existing data of the passed id with the passed
data in a certain mime type format.
*
* @abstract
* @param integer $id id of data to replace
* @param mixed $data the new data, the datatype depends
on the passed mime type
* @param string $type specifies the mime type of the
passed data
* @return boolean true if the data is replaced,
otherwise false
*/
function replaceData($id, $data, $type)
{
die('call abstract method:
'.__class__.'::'.__function__);
}
}
?>
- [Phpgroupware-cvs] phpgwapi/inc/class.ipc_.inc.php, 1.5,
nomail <=