Docs For Class Session

Description

Description of Session

author: jkraaijeveld

Located in /models/Session.php (line 11)

ResearchToolObject
   |
   --Session

Variable Summary

mixed $creationdate

mixed $creator

mixed $pipeline

mixed $title

Method Summary

static void create ( $obj)

static void get (type $arguments)

Session __construct ([type $uid = null], [type $title = null], [type $creator = null], [type $creationdate = null], [type $pipeline = null])

void evaluate ()

void save ()

void toSPSS (type $location)

Variables

mixed $creationdate (line 17)

access: public

mixed $creator (line 16)

access: public

mixed $pipeline (line 18)

access: public

mixed $title (line 15)

access: public

Inherited Variables

Inherited from ResearchToolObject

ResearchToolObject::$uid

Methods

static create (line 323)

access: public

void create ( $obj)

$obj

static get (line 155)

function get()

access: public

void get (type $arguments)

type $arguments: : An array containing one or more of the following elements: 'uid', 'title', 'creationdate', 'applications', 'surveys'

Constructor __construct (line 29)

Constructor for a Session object

access: public

Session __construct ([type $uid = null], [type $title = null], [type $creator = null], [type $creationdate = null], [type $pipeline = null])

type $uid
type $title
type $creator
type $creationdate
type $pipeline

evaluate (line 46)

access: public

void evaluate ()

Redefinition of:

ResearchToolObject::evaluate()

save (line 84)

function save() Saves the current object into the database.

access: public

void save ()

toSPSS (line 216)

function toSPSS

access: public

void toSPSS (type $location)

type $location: Writes an SPSS parseable file at the given location, named '$datetime_$title.txt' One big note about toSPSS: If this session contains multiple instances of THE SAME Survey, the world burns, people die, etcetera. (or, in a more fortunate case, the latest values are written to the file whilst the others get lost.

Inherited Methods

Inherited From ResearchToolObject

ResearchToolObject::createArguments()
ResearchToolObject::evaluate()
ResearchToolObject::getUid()
ResearchToolObject::load()
ResearchToolObject::stripUri()