Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
DBSchemaVersion Class Reference
Inheritance diagram for DBSchemaVersion:
SchemaVersion

Public Member Functions

 __construct ($domain= 'studip', $branch=0)
 
 getDomain ()
 
 getBranch ()
 
 getAllBranches ()
 
 get ($branch=0)
 
 set ($version, $branch=0)
 

Constructor & Destructor Documentation

__construct (   $domain = 'studip',
  $branch = 0 
)

Initialize a new DBSchemaVersion for a given domain. The default domain name is 'studip'.

Parameters
string$domaindomain name (optional)
string$branchschema branch (optional)

Member Function Documentation

get (   $branch = 0)

Retrieve the current schema version.

Parameters
string$branchschema branch (optional)
Returns
int schema version

Implements SchemaVersion.

getAllBranches ( )

Retrieve all branches of this schema.

Returns
array all schema branches

Implements SchemaVersion.

getBranch ( )

Retrieve the branch of this schema.

Returns
string schema branch

Implements SchemaVersion.

getDomain ( )

Retrieve the domain name of this schema.

Returns
string domain name
set (   $version,
  $branch = 0 
)

Set the current schema version.

Parameters
int$versionnew schema version
string$branchschema branch (optional)

Implements SchemaVersion.


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