mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-11-19 22:43:27 +01:00
7a3e571376
- reworked plugin interfaces. - charset is now an attribut of plugin_options only - import / export function itselve is not static any more - whiped out silly phpdoc tags generated by umbrello (kde uml modeler) - reworked representation of plugin_options for definitions - many fixes in uiexport and export_csv - lang updates
81 lines
2.0 KiB
PHP
81 lines
2.0 KiB
PHP
<?php
|
|
/**
|
|
* eGroupWare
|
|
*
|
|
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
|
|
* @package importexport
|
|
* @link http://www.egroupware.org
|
|
* @author Cornelius Weiss <nelius@cwtech.de>
|
|
* @copyright Cornelius Weiss <nelius@cwtech.de>
|
|
* @version $Id:$
|
|
*/
|
|
|
|
/**
|
|
* class iface_import_plugin
|
|
* This a the abstract interface for an import plugin of importexport
|
|
*
|
|
* You need to implement this class in
|
|
* EGW_INCLUDE_ROOT/appname/inc/importexport/class.import_<type>.inc.php
|
|
* to attend the importexport framwork with your export.
|
|
*
|
|
* NOTE: This is an easy interface, cause plugins live in theire own
|
|
* space. Means that they are responsible for generating a defintion AND
|
|
* working on that definition.
|
|
* So this interface just garanties the interaction with userinterfaces. It
|
|
* has nothing to do with datatypes.
|
|
*/
|
|
interface iface_import_plugin {
|
|
|
|
/**
|
|
* imports entries according to given definition object.
|
|
*
|
|
* @param stram $_stram
|
|
* @param definition $_definition
|
|
*/
|
|
public function import( $_stream, definition $_definition );
|
|
|
|
/**
|
|
* returns translated name of plugin
|
|
*
|
|
* @return string name
|
|
*/
|
|
public static function get_name();
|
|
|
|
/**
|
|
* returns translated (user) description of plugin
|
|
*
|
|
* @return string descriprion
|
|
*/
|
|
public static function get_description();
|
|
|
|
/**
|
|
* retruns file suffix(s) plugin can handle (e.g. csv)
|
|
*
|
|
* @return string suffix (comma seperated)
|
|
*/
|
|
public static function get_filesuffix();
|
|
|
|
/**
|
|
* return etemplate components for options.
|
|
* @abstract We can't deal with etemplate objects here, as an uietemplate
|
|
* objects itself are scipt orientated and not "dialog objects"
|
|
*
|
|
* @return array (
|
|
* name => string,
|
|
* content => array,
|
|
* sel_options => array,
|
|
* preserv => array,
|
|
* )
|
|
*/
|
|
public function get_options_etpl();
|
|
|
|
/**
|
|
* returns etemplate name for slectors of this plugin
|
|
*
|
|
* @return string etemplate name
|
|
*/
|
|
public function get_selectors_etpl();
|
|
|
|
} // end of iface_export_plugin
|
|
?>
|