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

Interface: KuoteInterfaces_Learning

Source Location: /classes/KuoteInterfaces/Learning.php

Interface KuoteInterfaces_Learning

Interface Overview

KuoteInterfaces_Learning This intefaces defines the set of methods that all Learning implementations need to function as part of the Kuote System.

Located in /classes/KuoteInterfaces/Learning.php [line 18]



		
				Author(s):
		
  • Kyle Hall
Information Tags:
Copyright:  2006

Methods

[ Top ]
Method Summary
static array   getLearningsHash()   Returns a hashed array of learnings that are part of the given course.
integer   getCourseId()   Returns the Id of the Course this Learning is part of.
string   getDescription()   Returns the description of the Learning.
boolean   getQuestionsRandom()   Declares if the questions for this Learning's quiz should be displayed randomly.
boolean   getQuestionsRandomByDifficulty()   Declares if the questions for this Learning's quiz should be displayed randomly, but only randomly within increasing difficuly.
string   getTitle()   Returns the title of the Learning.
string   getTutorialFileName()   Returns the name of the tutorial file for this Learning.
boolean   hasTutorial()   Returns true if this learning has a tutorial, false otherwise.
boolean   setCourseId()   Sets the Id of the Course this Learning is part of.
boolean   setDescription()   Sets the description of the Learning
boolean   setQuestionsRandom()   Sets if the questions for this Learning's quiz should be displayed randomly.
boolean   setQuestionsRandomByDifficulty()   Sets if the questions for this Learning's quiz should be displayed randomly by difficutly.
boolean   setTitle()   Sets the title of the Learning
boolean   setTutorialFileName()   Sets the name of the tutorial file for this Learning.

[ Top ]
Methods
static method getLearningsHash  [line 136]

  static array getLearningsHash( integer $courseId  )

Returns a hashed array of learnings that are part of the given course.

Returns a hashed array of the format

  1. $learningId => $learningTitle

Parameters:
integer   $courseId:  Id of the course for which to find created learnings.

API Tags:
Return:  Hashed array of
  1. $learningId => $learningTitle
. OR boolean False if no learnings are found of the given Course Id.
Access:  public


[ Top ]
getCourseId  [line 116]

  integer getCourseId( )

Returns the Id of the Course this Learning is part of.


API Tags:
Return:  Course Id.
Access:  public


[ Top ]
getDescription  [line 46]

  string getDescription( )

Returns the description of the Learning.


API Tags:
Return:  Learning description.
Access:  public


[ Top ]
getQuestionsRandom  [line 79]

  boolean getQuestionsRandom( )

Declares if the questions for this Learning's quiz should be displayed randomly.


API Tags:
Return:  True if questions should be random, false otherwise.
Access:  public


[ Top ]
getQuestionsRandomByDifficulty  [line 98]

  boolean getQuestionsRandomByDifficulty( )

Declares if the questions for this Learning's quiz should be displayed randomly, but only randomly within increasing difficuly.

If true, first ask all difficutly 1 questions randomly, then difficutly 2 questions randomly, and so on in that fashion.


API Tags:
Return:  True if questions should be random by difficutly, false otherwise.
Access:  public


[ Top ]
getTitle  [line 31]

  string getTitle( )

Returns the title of the Learning.


API Tags:
Return:  Learning title.
Access:  public


[ Top ]
getTutorialFileName  [line 64]

  string getTutorialFileName( )

Returns the name of the tutorial file for this Learning.

All tutorial all stored under LEARNINGS_ROOT/CourseId/LearningId/TutorialFileName If the tutorial consists of multiple files, the TutorialFileName will be the first page.


API Tags:
Return:  Tutorial filename.
Access:  public


[ Top ]
hasTutorial  [line 24]

  boolean hasTutorial( )

Returns true if this learning has a tutorial, false otherwise.


API Tags:
Return:  True if tutorial exists, false otherwise.
Access:  public


[ Top ]
setCourseId  [line 124]

  boolean setCourseId( integer $id  )

Sets the Id of the Course this Learning is part of.

Parameters:
integer   $id:  The id of the Course this Learning is part of.

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


[ Top ]
setDescription  [line 54]

  boolean setDescription( string $description  )

Sets the description of the Learning

Parameters:
string   $description:  The description of the Learning.

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


[ Top ]
setQuestionsRandom  [line 87]

  boolean setQuestionsRandom( boolean $bool  )

Sets if the questions for this Learning's quiz should be displayed randomly.

Parameters:
boolean   $bool:  True if they should be random, false otherwise.

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


[ Top ]
setQuestionsRandomByDifficulty  [line 109]

  boolean setQuestionsRandomByDifficulty( boolean $bool  )

Sets if the questions for this Learning's quiz should be displayed randomly by difficutly.

If true, first ask all difficutly 1 questions randomly, then difficutly 2 questions randomly, and so on in that fashion.

Parameters:
boolean   $bool:  True if they should be random by difficulty, false otherwise.

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


[ Top ]
setTitle  [line 39]

  boolean setTitle( string $title  )

Sets the title of the Learning

Parameters:
string   $title:  The title of the Learning.

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


[ Top ]
setTutorialFileName  [line 72]

  boolean setTutorialFileName( string $name  )

Sets the name of the tutorial file for this Learning.

Parameters:
string   $name:  The name of the tutorial file for this Learning.

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


[ Top ]

Documentation generated on Fri, 15 Dec 2006 11:18:03 -0500 by phpDocumentor 1.3.0