\hhu\z\modelsCharacterrolesModel

Model to interact with characterroles-table.

Summary

Methods
Properties
Constants
__construct()
load()
factory()
getCharacterrolesForCharacterById()
addCharacterroleToCharacter()
removeCharacterroleFromCharacter()
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 CharacterrolesModel.

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

getCharacterrolesForCharacterById()

getCharacterrolesForCharacterById(  $characterId) : array

Get all characterroles for a Character referenced by its ID.

Parameters

$characterId

Returns

array —

Characterroles for a Character

addCharacterroleToCharacter()

addCharacterroleToCharacter(integer  $characterId, string  $characterrole) 

Add a role to a Character.

Parameters

integer $characterId

ID of Character to add role to

string $characterrole

Role to add

removeCharacterroleFromCharacter()

removeCharacterroleFromCharacter(integer  $characterId, string  $characterrole) 

Remove a role from a Character.

Parameters

integer $characterId

ID of Character to remove role from

string $characterrole

Role to remove

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