Docs For Class KuoteInterfaces

Methods

static method getCoursesHash [line 128]

static array getCoursesHash(
KuoteObjects_User
$user 
)

Returns a hashed array of courses created by the given user.

Returns a hashed array of the format

$courseId => $courseTitle

Parameters:

KuoteObjects_User

$user:

User for which to find created courses.

API Tags:

Return:	Hashed array of $courseId => $courseTitle OR boolean False if no courses are found.
Access:	public

[ Top ]

getDescription [line 53]

string getDescription(
)

Returns the description of the course

API Tags:

Return:	Course description.
Access:	public

[ Top ]

getIsOpen [line 106]

boolean getIsOpen(
)

Returns the state of openness of the course.

If the course Is Open, this means that any instructor can offer the course. Returns true if the course is open, false if it is not.

API Tags:

Return:	Is Open.
Access:	public

[ Top ]

getIsPublic [line 86]

boolean getIsPublic(
)

Returns the state of public availability of the course.

If the course Is Public, this means that any user can enroll is the course. Returns true if the course is public, false if it is not.

API Tags:

Return:	Is Public.
Access:	public

[ Top ]

getTitle [line 38]

string getTitle(
)

Returns the title of the course.

API Tags:

Return:	Course title.
Access:	public

[ Top ]

getUserId [line 68]

int getUserId(
)

Returns the unique user id of the course's creator

API Tags:

Return:	User Id.
Access:	public

[ Top ]

isOpen [line 24]

boolean isOpen(
)

If true, the course may be used by other instructors.

API Tags:

Return:	True if open, false if not.
Access:	public

[ Top ]

isPublic [line 31]

boolean isPublic(
)

If true, the course may be used by any student.

API Tags:

Return:	True if open, false if not.
Access:	public

[ Top ]

setDescription [line 61]

boolean setDescription(
string
$description 
)

Sets the description of the course

Parameters:

string

$description:

Course Description

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

setIsOpen [line 116]

boolean setIsOpen(
boolean
$bool 
)

Sets the state of openness of the course.

If the course Is Open, this means that any instructor can offer the course.

Parameters:

boolean

$bool:

Is Open.

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

setIsPublic [line 96]

boolean setIsPublic(
boolean
$bool 
)

Sets the state of public availability of the course.

True means the course is public, false means it is not.

Parameters:

boolean

$bool:

Is Public.

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

setTitle [line 46]

boolean setTitle(
string
$title 
)

Sets the title of the course.

Parameters:

string

$title:

Course Title

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

setUserId [line 76]

boolean setUserId(
integer
$id 
)

Sets the unique user id of the course's creator.

Parameters:

integer

$id:

User Id of the Course Creator.

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

Interface: KuoteInterfaces_Course

Interface KuoteInterfaces_Course

	KuoteInterfaces Object

[ class tree: KuoteInterfaces ] [ index: KuoteInterfaces ] [ all elements ]