User Tools

Site Tools


Sidebar

Dokumentation

vortex:apidoc:import

Import

Import

Filename : /classes/backup/import.php
Extends :

Description

Importing data from file using an xml template

Fields

MAX_PREVIEW_RECORDS

Definition : const MAX_PREVIEW_RECORDS = 10000
Description
Maximum number of records in the preview. Limit set for performance reasons.

Methods

__construct( $display )

Definition : public function __construct( &$display )

Returns :

Description
Constructs a new data importer on the given Display. If done programatically, supply a reference to null as $display

Parameters

$display

Type : Display
Default value :

Description
The display to show the import GUI on, see the Display class documentation for more information

_get( $varname )

Definition : public function _get( $varname )

Returns : String

Description
Gets an internal value from the import script

Parameters

$varname

Type : String
Default value :

Description
Name of the parameter to get

_set( $varname, $value )

Definition : public function _set( $varname, $value )

Returns :

Description
Sets an internal value for the import script

Parameters

$value

Type : String
Default value :

Description
The value to set the parameter to

$varname

Type : String
Default value :

Description
The name of the parameter to set

_setfile( $varname, $file )

Definition : public function _setfile( $varname, $file )

Returns :

Description
Add the file to the queue to import

Parameters

$file

Type : String
Default value :

Description
Path to the file on the file system

$varname

Type : String
Default value :

Description
Name of the file internally

doImportFromCommandLine()

Definition : public funtion doImportFromCommandLine()

Returns :

Description
Initiate a command line import of a single file. Used by the CommandLine interface, not for API use

Parameters

doImportFromTemplate2( $file, $type )

Definition : public function doImportFromTemplate2( $file, $type )

Returns :

Description
Initiate an import programatically

Parameters

$file

Type : Array
Default value :

Description
Filedata on the format of an uploaded file ["name"=>filename, "tmp_name"=>filepath]

$type

Type : String
Default value :

Description
Name of the xml template to use for import, placed in /config/import/ under the DBI localpath.

import( $display )

Definition : public static function import( &$display )

Returns :

Description
Static method to import

Parameters

$display

Type : Display
Default value :

Description
Display to show the GUI on

run()

Definition : public function run()

Returns :

Description
Runs the import

Parameters

vortex/apidoc/import.txt · Last modified: 2019/06/28 07:08 by hubbe