CourseDescription Class Reference

Public Member Functions
	__construct ($course_id=null)
	load ($id)
	save ()
	insert ()
	update ()
	delete ()
	validate ()
	getId ()
	setId ($id)
	getCategory ()
	setCategory ($category)
	getTitle ()
	setTitle ($title)
	getContent ()
	setContent ($content)
	getLastEditDate ()
	setLastEditDate ($date)
	getVisibility ()
	setVisibility ($visibility)
Protected Attributes
	$id
	$category
	$title
	$content
	$lastEditDate
	$visibility

---

Detailed Description

CLAROLINE

Version:

1.9

Revision

10562

(c) 2001-2008 Universite catholique de Louvain (UCL)

http://www.gnu.org/copyleft/gpl.html (GPL) GENERAL PUBLIC LICENSE

Author:

Claro Team <cvs@claroline.net>

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

---

Constructor & Destructor Documentation

__construct

(

$

course_id = null

)

constructor

Parameters:

$course_id

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

---

Member Function Documentation

delete

(

)

delete description

Returns:

boolean true if delete is successfull false otherwise

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 219 of file courseDescription.class.php.

getCategory

(

)

get category of description

Returns:

integer category of description

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 288 of file courseDescription.class.php.

getContent

(

)

get content of description

Returns:

integer content of description

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 340 of file courseDescription.class.php.

getId

(

)

get id of description

Returns:

integer id of description

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 262 of file courseDescription.class.php.

getLastEditDate

(

)

get last edition date

Returns:

integer last edition date timestamp

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 365 of file courseDescription.class.php.

getTitle

(

)

get title of description

Returns:

integer title of description

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 315 of file courseDescription.class.php.

getVisibility

(

)

get visibility of description

Returns:

string visibility of description 'VISIBLE' or 'INVISIBLE'

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 391 of file courseDescription.class.php.

insert

(

)

insert a new description to DB

Returns:

mixed false or id of the record

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 156 of file courseDescription.class.php.

load

(

$

id

)

load a description from DB

Parameters:

integer

$id id of description

Returns:

boolean true if load is successfull false otherwise

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 98 of file courseDescription.class.php.

save

(

)

save description to DB

Returns:

mixed false or id of the record

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 136 of file courseDescription.class.php.

setCategory

(

$

category

)

set category of description

Parameters:

integer

category of description, < 0 for others, > 0 for predefined categories

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 301 of file courseDescription.class.php.

setContent

(

$

content

)

set content of description

Parameters:

string

content of description

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 352 of file courseDescription.class.php.

setId

(

$

id

)

set id of description

Parameters:

integer

id of description

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 275 of file courseDescription.class.php.

setLastEditDate

(

$

date

)

set last edition date timestamp

Parameters:

integer

last edition date timestamp

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 378 of file courseDescription.class.php.

setTitle

(

$

title

)

set title of description

Parameters:

string

title of description

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 327 of file courseDescription.class.php.

setVisibility

(

$

visibility

)

set visibility

Parameters:

string

visibility of description 'VISIBLE' or 'INVISIBLE'

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 403 of file courseDescription.class.php.

update

(

)

update description to DB

Returns:

mixed false or id of the record

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 189 of file courseDescription.class.php.

validate

(

)

validate object content

Returns:

boolean true if delete is successfull false otherwise

Author:

Sebastien Piraux <pir@cerdecam.be>

Definition at line 242 of file courseDescription.class.php.

---

Field Documentation

$category [protected]

$category id of predefined 'type' of description, > 0 for predefined categories, -1 for "others"

Definition at line 47 of file courseDescription.class.php.

$content [protected]

$content description text

Definition at line 57 of file courseDescription.class.php.

$id [protected]

$id id of description, -1 if description doesn't exist already

Definition at line 42 of file courseDescription.class.php.

$lastEditDate [protected]

$lastEditDate last edition date of the description timestamp

Definition at line 62 of file courseDescription.class.php.

$title [protected]

$title name of the description

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

$visibility [protected]

$visibility

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

---

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

• claroline/claroline/course_description/lib/courseDescription.class.php