AutoInsert Class Reference

Public Member Functions
	__construct ()
	saveUser ($user_id, $status=false)

Static Public Member Functions
static	instance ()
static	checkSeminar ($seminar_id, $domain_id=false)
static	saveSeminar ($seminar_id, $status, $domain_id)
static	updateSeminar ($seminar_id, $domain, $status, $remove=false)
static	deleteSeminar ($seminar_id)
static	getAllSeminars ($only_sem_id=false)
static	getSeminar ($seminar_id)
static	saveAutoInsertUser ($seminar_id, $user_id)
static	checkAutoInsertUser ($seminar_id, $user_id)

Static Protected Member Functions
static	getSeminarCache ()

Static Protected Attributes
static	$seminar_cache = null

Detailed Description

AutoInsert.class.php Provides functions required by StEP00216:

• Assign seminars for automatic registration of certain user types
• Maintenance of registration rules

Example of use:

# show all auto insert seminars
$auto_sems = AutoInsert::getAllSeminars();

# Save a new auto insert seminar with the user status
AutoInsert::saveSeminar($sem_id, $rechte);

Constructor & Destructor Documentation

__construct()

__construct

(

)

Member Function Documentation

checkAutoInsertUser()

static checkAutoInsertUser (   $seminar_id,   $user_id  )

static

Tests whether a user was already automatically registered for a certain seminar.

Parameters

string	$seminar_id	Id of the seminar
string	$user_id	If of the user

Returns

bool Indicates whether the user was already registered

checkSeminar()

static checkSeminar (   $seminar_id,   $domain_id = false  )

static

Tests if a seminar already has an autoinsert record

Parameters

string

$seminar_id

Id of the seminar

Returns

bool Indicating whether the seminar already has an autoinsert record

deleteSeminar()

static deleteSeminar (   $seminar_id )

static

Removes a seminar from the autoinsertion process.

Parameters

string

$seminar_id

Id of the seminar

getAllSeminars()

static getAllSeminars (   $only_sem_id = false )

static

Returns a list of all seminars enabled for autoinsertion

Parameters

bool	Indicates whether only the seminar ids (true) or the full dataset shall be returned (false)

Returns

array The list of all enabled seminars (format according to $only_sem_id)

getSeminar()

static getSeminar (   $seminar_id )

static

Returns a seminar's info for autoinsertion

Parameters

string

$seminar_id

Id of the seminar

Returns

array The seminar's data as an associative array

getSeminarCache()

static getSeminarCache ( )

staticprotected

Returns the cache for seminars.

instance()

static instance ( )

static

saveAutoInsertUser()

static saveAutoInsertUser (   $seminar_id,   $user_id  )

static

Store the user's automatic registration in a seminar redundantly to avoid an annoying reregistration although the user explicitely left the according seminar

Parameters

string	$user_id	Id of the user
string	$seminar_id	Id of the seminar

saveSeminar()

static saveSeminar (   $seminar_id,   $status,   $domain_id  )

static

Enables a seminar for autoinsertion of users with the given status(ses)

Parameters

string	$seminar_id	Id of the seminar
mixed	$status	Either a single string or an array of strings containing the status(ses) to enable for autoinsertion

saveUser()

saveUser	(		$user_id,
			$status = false
	)

Trägt den Benutzer in den Eingestellten veranstaltungen automatisch ein.

Parameters

string	$user_id
string | bool	$status	Wenn Status nicht angegeben wird, wird der Status des Users aus user_id genommen

Returns

array 'added' Namen der Seminare in die der User eingetragen wurde array 'removed' Namen der Seminare aus denen der User ausgetragen wurde

updateSeminar()

static updateSeminar (   $seminar_id,   $domain,   $status,   $remove = false  )

static

Updates an autoinsert record for a given seminar, dependent on the parameter $remove it either inserts or removes the record for the given parameters

Parameters

string	$seminar_id	Id of the seminar
string	$status	Status for autoinsertion
bool	$remove	Whether the record should be added or removed

Field Documentation

$seminar_cache

$seminar_cache = null

staticprotected

---

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

• lib/classes/AutoInsert.class.php