ClaroCourse Class Reference

Public Member Functions
	ClaroCourse ($creatorFirstName= '', $creatorLastName= '', $creatorEmail= '')
	load ($courseId)
	save ()
	delete ()
	handleForm ()
	validate ()
	validateExtLinkUrl ()
	validateEmailList ()
	displayForm ($cancelUrl=null)
	displayDeleteConfirmation ()
	addHtmlParam ($name, $value)
	getHtmlParamList ($method= 'GET')
	getVisibility ($access, $registration)
	getAccess ($visibility)
	getRegistration ($visibility)
	mailAdministratorOnCourseCreation ($creatorFirstName, $creatorLastName, $creatorEmail)
	buildProgressUrl ()
Data Fields
	$courseId
	$title
	$officialCode
	$titular
	$email
	$category
	$departmentName
	$extLinkUrl
	$language
	$access
	$visibility
	$registration
	$registrationKey
	$publicationDate
	$expirationDate
	$useExpirationDate
	$status
	$backlog
	$htmlParamList = array()

---

Detailed Description

Definition at line 28 of file claroCourse.class.php.

---

Member Function Documentation

addHtmlParam	(	$	name,
		$	value
	)

Add html parameter to list

Parameters:

	$name	string input name
	$value	string input value

Definition at line 980 of file claroCourse.class.php.

buildProgressUrl

(

)

Build progress param url

Returns:

string url

Definition at line 1113 of file claroCourse.class.php.

ClaroCourse	(	$	creatorFirstName = '',
		$	creatorLastName = '',
		$	creatorEmail = ''
	)

Constructor

Definition at line 91 of file claroCourse.class.php.

delete

(

)

delete course data and content

Returns:

boolean success

Definition at line 267 of file claroCourse.class.php.

displayDeleteConfirmation

(

)

Display question of delete confirmation

Parameters:

$cancelUrl

string url of the cancel button

Returns:

string html output of form

Definition at line 943 of file claroCourse.class.php.

displayForm

(

$

cancelUrl = null

)

Display form

Parameters:

$cancelUrl

string url of the cancel button

Returns:

string html output of form

Definition at line 565 of file claroCourse.class.php.

getAccess

(

$

visibility

)

Get access value from visibility field

Parameters:

$visbility

integer value of field

Returns:

boolean public true, private false

Definition at line 1048 of file claroCourse.class.php.

getHtmlParamList

(

$

method = 'GET'

)

Get html representing parameter list depending on method (POST for form, GET for URL's')

Parameters:

$method

string GET OR POST

Returns:

string html output of params for $method method

Definition at line 992 of file claroCourse.class.php.

getRegistration

(

$

visibility

)

Get registration value from visibility field

Parameters:

$visbility

integer value of field

Returns:

boolean open true, close false

Definition at line 1061 of file claroCourse.class.php.

getVisibility	(	$	access,
		$	registration
	)

Get visibility

Parameters:

	$access	string
	$registration	string

Returns:

integer value of visibility field

Deprecated:

1.9

Definition at line 1029 of file claroCourse.class.php.

handleForm

(

)

retrieve course data from form

Definition at line 276 of file claroCourse.class.php.

load

(

$

courseId

)

load course data from database

Parameters:

$courseId

string course identifier

Returns:

boolean success

Definition at line 122 of file claroCourse.class.php.

mailAdministratorOnCourseCreation	(	$	creatorFirstName,
		$	creatorLastName,
		$	creatorEmail
	)

Send course creation information by mail to all platform administrators

Parameters:

	string	creator firstName
	string	creator lastname
	string	creator email

Definition at line 1075 of file claroCourse.class.php.

save

(

)

insert or update course data

Returns:

boolean success

Definition at line 161 of file claroCourse.class.php.

validate

(

)

validate data from object. Error handling with a backlog object.

Returns:

boolean success

Configuration array , define here which field can be left empty or not

Definition at line 369 of file claroCourse.class.php.

validateEmailList

(

)

validate email ( and semi-column separated email list )

Returns:

boolean success

Definition at line 528 of file claroCourse.class.php.

validateExtLinkUrl

(

)

validate url and try to repair it if no protocol specified

Returns:

boolean success

Definition at line 498 of file claroCourse.class.php.

---

Field Documentation

$access

Definition at line 58 of file claroCourse.class.php.

$backlog

Definition at line 82 of file claroCourse.class.php.

$category

Definition at line 46 of file claroCourse.class.php.

$courseId

Definition at line 31 of file claroCourse.class.php.

$departmentName

Definition at line 49 of file claroCourse.class.php.

$email

Definition at line 43 of file claroCourse.class.php.

$expirationDate

Definition at line 73 of file claroCourse.class.php.

$extLinkUrl

Definition at line 52 of file claroCourse.class.php.

$htmlParamList = array()

Definition at line 85 of file claroCourse.class.php.

$language

Definition at line 55 of file claroCourse.class.php.

$officialCode

Definition at line 37 of file claroCourse.class.php.

$publicationDate

Definition at line 70 of file claroCourse.class.php.

$registration

Definition at line 64 of file claroCourse.class.php.

$registrationKey

Definition at line 67 of file claroCourse.class.php.

$status

Definition at line 79 of file claroCourse.class.php.

$title

Definition at line 34 of file claroCourse.class.php.

$titular

Definition at line 40 of file claroCourse.class.php.

$useExpirationDate

Definition at line 76 of file claroCourse.class.php.

$visibility

Definition at line 61 of file claroCourse.class.php.

---

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

• claroline/claroline/inc/lib/claroCourse.class.php