Class Horde_Data_Base
Abstract class that Data drivers extend.
Copyright 1999-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.horde.org/licenses/lgpl21.
Methods summary
public
|
#
__construct( array $params = array() )
Constructor.
Parameters
- $params
- Parameters:
<pre>OPTIONAL:
---------
browser - (Horde_Browser) A browser object.
cleanup - (callback) A callback to call at cleanup <span class="php-keyword2">time</span>.
vars - (Horde_Variables) Form data.</pre>
|
public
|
#
importData( mixed $text )
Stub to import passed data.
Stub to import passed data.
|
abstract public
|
#
exportData( mixed $data, mixed $method = 'REQUEST' )
Stub to return exported data.
Stub to return exported data.
|
public
|
|
abstract public
|
#
exportFile( mixed $filename, mixed $data )
Stub to export data to a file.
Stub to export data to a file.
|
public
string
|
#
getNewline( )
Tries to determine the expected newline character based on the
platform information passed by the browser's agent header.
Tries to determine the expected newline character based on the
platform information passed by the browser's agent header.
Returns
stringThe guessed expected newline characters, either \n, \r
or \r\n.
|
public
string
|
#
getFilename( string $basename )
Returns the full filename including the basename and extension.
Returns the full filename including the basename and extension.
Parameters
- $basename
- Basename for the file.
Returns
string
The file name.
|
public
string
|
#
getContentType( )
Returns the content type.
Returns the content type.
Returns
string
The content type.
|
public
array
|
#
warnings( )
Returns a list of warnings that have been raised during the last
operation.
Returns a list of warnings that have been raised during the last
operation.
Returns
array
A (possibly empty) list of warnings.
|
public
mixed
|
#
nextStep( integer $action, array $param = array() )
Takes all necessary actions for the given import step, parameters and
form values and returns the next necessary step.
Takes all necessary actions for the given import step, parameters and
form values and returns the next necessary step.
Parameters
- $action
- The current step. One of the IMPORT_* constants.
- $param
- <p>An associative array containing needed
parameters for the current step.</p>
Returns
mixedEither the next step as an integer constant or imported
data set after the final step.
Throws
|
public
mixed
|
#
cleanup( )
Cleans the session data up and removes any uploaded and moved
files.
Cleans the session data up and removes any uploaded and moved
files.
Returns
mixedIf callback called, the return value of this call.
This should be the value of the first import step.
|