Moodle  2.2.1
http://www.collinsharper.com
Session Class Reference
Inheritance diagram for Session:
Collaboration diagram for Session:

Public Member Functions

 __construct ($repository, $ticket)
 createStore ($address, $scheme="workspace")
 getStore ($address, $scheme="workspace")
 getStoreFromString ($value)
 getNode ($store, $id)
 getNodeFromString ($value)
 addNode ($node)
 save ($debug=false)
 clear ()
 query ($store, $query, $language='lucene')
 getTicket ()
 getRepository ()
 getNamespaceMap ()
 getStores ()
 nextSessionId ()

Data Fields

 $authenticationService
 $repositoryService
 $contentService

Detailed Description

Definition at line 31 of file Session.php.


Constructor & Destructor Documentation

__construct ( repository,
ticket 
)

Constructor

Parameters:
userNamethe user name
ticketthe currenlty authenticated users ticket

Definition at line 51 of file Session.php.

Here is the call graph for this function:


Member Function Documentation

addNode ( node)

Adds a new node to the session.

Definition at line 131 of file Session.php.

Here is the caller graph for this function:

clear ( )

Clears the current session by emptying the node cache.

WARNING: all unsaved changes will be lost when clearing the session.

Definition at line 184 of file Session.php.

createStore ( address,
scheme = "workspace" 
)

Creates a new store in the current respository

Parameters:
$addressthe address of the new store
$schemethe scheme of the new store, default value of 'workspace'
Returns:
Store the new store

Definition at line 69 of file Session.php.

Definition at line 243 of file Session.php.

getNode ( store,
id 
)

Definition at line 111 of file Session.php.

Here is the call graph for this function:

getNodeFromString ( value)

Definition at line 122 of file Session.php.

Definition at line 238 of file Session.php.

getStore ( address,
scheme = "workspace" 
)

Get the store

Parameters:
$addressthe address of the store
$schemethe scheme of the store. The default it 'workspace'
Returns:
Store the store

Definition at line 94 of file Session.php.

getStoreFromString ( value)

Get the store from it string representation (eg: workspace://SpacesStore)

Parameters:
$valuethe stores string representation
Returns:
Store the store

Definition at line 105 of file Session.php.

getStores ( )

Definition at line 252 of file Session.php.

getTicket ( )

Definition at line 233 of file Session.php.

Want these methods to be package scope some how!

Definition at line 270 of file Session.php.

query ( store,
query,
language = 'lucene' 
)

Definition at line 218 of file Session.php.

Here is the call graph for this function:

save ( debug = false)

Commits all unsaved changes to the repository

Definition at line 150 of file Session.php.


Field Documentation

$authenticationService

Definition at line 33 of file Session.php.

$contentService

Definition at line 35 of file Session.php.

$repositoryService

Definition at line 34 of file Session.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations