\hhu\z\modelsXplevelsModel

Model for XP-levels.

Summary

Methods
Properties
Constants
__construct()
load()
factory()
getXPLevelById()
getXPLevelsForSeminary()
createXPLevel()
editXPLevel()
deleteXPLevel()
No public properties found
No constants found
No protected methods found
$db
N/A
loadDriver()
connect()
getClassName()
loadModels()
No private properties found
N/A

Properties

$db

$db : \nre\models\DatabaseDriver

Database connection

Type

\nre\models\DatabaseDriver

Methods

__construct()

__construct() 

Construct a new XplevelsModel.

TODO Catch exception

load()

load(string  $modelName) 

Load the class of a Model.

Parameters

string $modelName

Name of the Model to load

Throws

\nre\exceptions\ModelNotFoundException
\nre\exceptions\ModelNotValidException

factory()

factory(string  $modelName) 

Instantiate a Model (Factory Pattern).

Parameters

string $modelName

Name of the Model to instantiate

getXPLevelById()

getXPLevelById(integer  $xplevelId) : array

Get XP-level by its ID.

Parameters

integer $xplevelId

ID of XP-level

Throws

\nre\exceptions\IdNotFoundException

Returns

array —

XP-level data

getXPLevelsForSeminary()

getXPLevelsForSeminary(integer  $seminaryId) : array

Get all XP-levels for a Seminary.

Parameters

integer $seminaryId

ID of Seminary

Throws

\nre\exceptions\IdNotFoundException

Returns

array —

List of XP-level

createXPLevel()

createXPLevel(integer  $userId, integer  $seminaryId, integer  $xps, string  $name = null) 

Create a new XP-level for a Seminary.

Parameters

integer $userId

ID of creating user

integer $seminaryId

ID of Seminary

integer $xps

XPs of new XP-level

string $name

Name of new XP-level (optional)

editXPLevel()

editXPLevel(integer  $xplevelId, integer  $xps, string  $name = null) 

Edit a XP-level.

Parameters

integer $xplevelId

ID of XP-level to edit

integer $xps

New XPs of XP-level

string $name

New name of XP-level (optional)

deleteXPLevel()

deleteXPLevel(integer  $xplevel) 

Delete a XP-level.

Parameters

integer $xplevel

XP-level to delete

loadDriver()

loadDriver(string  $driverName) 

Load the database driver.

Parameters

string $driverName

Name of the database driver

Throws

\nre\exceptions\DriverNotFoundException
\nre\exceptions\DriverNotValidException

connect()

connect(string  $driverName, array  $config) 

Establish a connection to the database.

Parameters

string $driverName

Name of the database driver

array $config

Connection settings

Throws

\nre\exceptions\DatamodelException

getClassName()

getClassName(string  $modelName) : string

Determine the classname for the given Model name.

Parameters

string $modelName

Model name to get classname of

Returns

string —

Classname fore the Model name

loadModels()

loadModels() 

Load the Models of this Model.

Throws

\nre\exceptions\DatamodelException
\nre\exceptions\DriverNotFoundException
\nre\exceptions\DriverNotValidException
\nre\exceptions\ModelNotValidException
\nre\exceptions\ModelNotFoundException