StoredUserData Class Reference

Public Member Functions
	__construct ($user_id)
	getUserId ()
	hasData ()
	addTabularData ($name, $key, array $value, SimpleORMap $context=null)
	addFileRef (FileRef $fileref, SimpleORMap $context=null)
	addFileAtPath ($name, $path, SimpleORMap $context=null)
	addFileWithContents ($name, $contents, SimpleORMap $context=null)
	getFileData (SimpleORMap $context=null)
	getTabularData (SimpleORMap $context=null)

Data Fields
	$user_id

Protected Member Functions
	addData ($type, $data, SimpleORMap $context=null)
	getData ($type, SimpleORMap $context=null)

Protected Attributes
	$data

Detailed Description

This class is used to transport all data a plugin might have stored for a specific user. Stored data may be a number of files, tabular data or urls.

GPL2 or any later version

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Constructor & Destructor Documentation

__construct()

__construct

(

$user_id

)

Construct a storage object for a specific user.

Parameters

User

$user

User object

Member Function Documentation

addData()

addData (   $type,   $data, SimpleORMap  $context = null  )

protected

Adds stored data. By passing an optional context, the data may be associated with this context.

Parameters

string	$type	Type of data
mixed	$data
SimpleORMap	$context	Optional context

addFileAtPath()

addFileAtPath	(		$name,
			$path,
		SimpleORMap	$context = null
	)

Adds a local file on disk. By passing an optional context, the data may be associated with this context.

Parameters

string	$name	File name
string	$path	File path
SimpleORMap	$context	Optional context

addFileRef()

addFileRef	(	FileRef	$fileref,
		SimpleORMap	$context = null
	)

Adds a file reference. By passing an optional context, the data may be associated with this context.

Parameters

FileRef	$fileref
SimpleORMap	$context	Optional context

addFileWithContents()

addFileWithContents	(		$name,
			$contents,
		SimpleORMap	$context = null
	)

Adds content as a file. By passing an optional context, the data may be associated with this context.

Parameters

string	$name	File name
string	$contents	File contents (text or binary)
SimpleORMap	$context	Optional context

addTabularData()

addTabularData	(		$name,
			$key,
		array	$value,
		SimpleORMap	$context = null
	)

Adds tabular data under the specified key. By passing an optional context, the data may be associated with this context.

Parameters

string	$name	Display label
string	$key	Table name (e.g. database table)
array	$value	Array containing the rows
SimpleORMap	$context	Optional context

getData()

getData (   $type, SimpleORMap  $context = null  )

protected

Returns the stored data of the given type for all contexts (if $context is null) or a specific context.

Parameters

string	$type	Type of data
SimpleORMap	$context	Optional context

Returns

array

getFileData()

getFileData

(

SimpleORMap

$context = null

)

Returns the stored file data for all contexts (if $context is null) or a specific context.

Parameters

SimpleORMap

$context

Optional context

Returns

array

getTabularData()

getTabularData

(

SimpleORMap

$context = null

)

Returns the stored tabular data for all contexts (if $context is null) or a specific context.

Parameters

SimpleORMap

$context

Optional context

Returns

array

getUserId()

getUserId

(

)

Returns the associated user.

Returns

User object

hasData()

hasData

(

)

Returns whether this object actually contains any data.

Returns

bool

Field Documentation

$data

$data

protected

Initial value:

= [
        'file'    => []

$user_id

$user_id

---

The documentation for this class was generated from the following file:

• lib/classes/StoredUserData.php