[Phpgroupware-cvs] phpgwapi/inc class.ipc_.inc.php,1.1

[uid65887]

Update of phpgwapi/inc

Added Files:
     Branch: MAIN
            class.ipc_.inc.php 

Log Message:
added classes for ipc_layer

====================================================
Index: class.ipc_.inc.php
<?php
/**
 * IPC Layer
 *
 * @author      Dirk Schaller <address@hidden>
 * @copyright   Copyright (C) 2003 Free Software Foundation http://www.fsf.org/
 * @license     http://www.fsf.org/licenses/gpl.html GNU General Public License
 * @package     phpgwapi
 * @subpackage  ipc
 * @version     $Id: class.ipc_.inc.php,v 1.1 2003/12/23 16:08:01 uid65887 Exp $
 */

/**
 * Abstract IPC Application Class for the IPC Layer
 *
 * @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
         * @access  public
         * @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__);
        }


        /**
         * 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__);
        }


        /**
         * 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__);
        }


        /**
         * 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__);
        }

}