superUnitObject::superUnitObject($id, $title)
Parameters | |
| Id | Id the uniquely identifies this superunit in the database |
| Title | Title of this superunit |
Get the unique id for this superunit (this is the id that acts as the primary key forsuperunits in the database).
superUnitObject::get_id()
Parameters | |
| None |
Returns an integer which is the unique id of this superunit
Set the unique id for this superunit (which will be used as the primary key to identifythis superunit in the database.
superUnitObject::set_id($valIn)
Parameters | |
| ValIn | Integer representing the id of this superunit |
Return the title of this superunit.
superUnitObject::get_title()
Parameters | |
| None |
Returns string containing the title of this superunit
Sets the title of this superunit.
superUnitObject::set_title($valIn)
Parameters | |
| ValIn | String containing the title of this superunit |
unitObject::unitObject($id, $title, $header_image, $superunit_id)
Parameters | |
| Id | Id of the unit (which is the primary key for unit in the database) |
| Title | Title of the unit |
| Header_image | Image that is shown at the top of the unit page |
| Superunit_id | The superunit this unit belongs to |
Returns the id of the unit.
unitObject::get_id()
Parameters | |
| None |
Integer which represents unit id
This sets the id of the unit (which is the primary key for this unit in the database).
unitObject::set_id($valIn)
Parameters | |
| ValIn | Integer which represents unit id |
Returns the title of the unit.
unitObject::get_title()
Parameters | |
| None |
String which represents the title of the unit
Sets the title of the unit.
unitObject::set_title($valIn)
Parameters | |
| ValIn | String which represents the title of the unit |
Returns name of the image file which is displayed at the top of this unit.
unitObject::get_header_image()
Parameters | |
| None |
Returns string which contains file name of the image displayed for this unit
Sets name of the image file which is displayed at the top of this unit.
unitObject::set_header_image($valIn)
Parameters | |
| ValIn | File name of image to be shown at the top of this unit |
Returns integer containing id of the superunit this unit belongs to.
unitObject::get_superunit_id()
Parameters | |
| None |
Returns integer of id for superunit this unit belongs to
Sets the id of the superunit this unit belongs to.
unitObject::set_superunit_id($valIn)
Parameters | |
| ValIn | Returns integer of id for superunit this unit belongs to |
bookObject::bookObject($id, $title, $difficulty, $created, $cover_image, $status, $active, $unit_id)
Parameters | |
| Id | Id of the book (i.e., primary key for the book in the database) |
| Title | Title of the book |
| Difficulty | Integer value indicating difficulty of book |
| Created | Integer indicitive of time/date book was created in the format of a unix timestamp |
| Cover_image | File name for image shown on book cover |
| Status | Approval status, such as "approved", "rejected", or "pending" |
| Active | "y" or "n" indicating if the book is active or not |
| Unit_id | Integer containing unit id of the unit this book belongs to |
Returns id of the book (which is the primary key of the book in the database).
bookObject::get_id()
Parameters | |
| None |
Returns integer with the id of the book
Sets the id of the book (which is the primary key of the book in the database).
bookObject::set_id($valIn)
Parameters | |
| ValIn | Integer value to set the id of the book |
Returns the title of the book.
bookObject::get_title()
Parameters | |
| None |
Returns string for the title of the book
Sets the title of the book.
bookObject::set_title($valIn)
Parameters | |
| ValIn | String which contains the title of the book |
Returns the difficult of the book.
bookObject::get_difficulty()
Parameters | |
| None |
Returns integer which indicates the difficulty of the book
Sets the difficulty of the book.
bookObject::set_difficulty($valIn)
Parameters | |
| ValIn | Postive integer (99 or less) which indicates the difficulty of the book |
Returns time/date the book was created.
bookObject::get_created()
Parameters | |
| None |
Integer which has the unix timestamp of the book
Returns the date the book was created formatted as a human-readable date.
bookObject::get_created_formatted()
Parameters | |
| None |
Sets the time/date this book was created.
bookObject::set_created($valIn)
Parameters | |
| ValIn | Integer (unix timestamp) indicating when book was created. |
Returns the image file name of the cover image of this book.
bookObject::get_cover_image()
Parameters | |
| None |
String for the file name of the cover image of this book
Sets the image file name of the book.
bookObject::set_cover_image($valIn)
Parameters | |
| ValIn | String for the file name of the cover image of this book |
Set the status of this book, such as "pending", "approved", or "rejected".
bookObject::set_status($statusIn)
Parameters | |
| StatusIn | String for the status of this book, such as "pending", "approved", or "rejected" |
Returns the status of this book.
bookObject::get_status()
Parameters | |
| None |
Returns the status of this book, such as "pending", "approved", or "rejected"
Set whether the book is active in this unit or not.
bookObject::set_active($valIn)
Parameters | |
| ValIn | Either "y" or "n" which indicates if book is active or not |
Returns if book is active or not.
bookObject::get_active()
Parameters | |
| None |
Either "y" or "n" which indicates if book is active or not
Unit id of the unit this book belongs to.
bookObject::set_unit_id($unit_idIn)
Parameters | |
| Unit_idIn | Integer indicating id of unit to which this book belongs |
Returns id (p_key) of this unit.
bookObject::get_unit_id()
Parameters | |
| None |
Returns title of the unit this book belongs to.
bookObject::get_unit_title()
Parameters | |
| None |
String for the title of the unit this book belongs to
pageObject::pageObject($id, $image_right, $sentence_top, $blackboard_text, $blackboard_reread, $type, $f_key_book, $f_key_prevpage)
Parameters | |
| Id | Id of the page |
| Image_right | Filename of image shown on the right side of the page |
| Sentence_top | Sentence shown at the top of the page |
| Blackboard_text | Text shown on the blackboard when reading in "let's read this book for |
| Blackboard_reread | Text shown on the blackboard when reading in "let's reread this book". |
| Type | "old" or "new" page. Should always be "new" unless this page was migrated |
| F_key_book | Id of the book this page belongs to |
| F_key_prevpage | Id of the page before this. -1 if this is the first page |
Returns id of the page (which is the primary key for the page in the database).
pageObject::get_id()
Parameters | |
| None |
Integer with the id of the page
Sets the id of the page (which is the primary key for the page in the database).
pageObject::set_id($valIn)
Parameters | |
| ValIn | Integer with the id of the page |
Returns the filename of the image on the top right of the page (this is the main image shown on the page).
pageObject::get_image_right()
Parameters | |
| None |
String for the filename of the image
Sets the filename of the image on the top right of the page (this is the main image shown on the page).
pageObject::set_image_right($valIn)
Parameters | |
| ValIn | String for the file name of the image |
Returns the sentence shown on the page.
pageObject::get_sentence_top()
Parameters | |
| None |
String for the setence shown at the top of the page
Sets the sentence shown on this page.
pageObject::set_sentence_top($valIn)
Parameters | |
| ValIn | String for the sentence shown at the top of the page |
Returns the text shown on the blackboard. in some cases, this may not be text, but the file nameof an image -- an image file name is only shown on old pages (i.e., pages of type "old").
pageObject::get_blackboard_text()
Parameters | |
| None |
String for the text on the blackboard (except on "old" pages, where the string is actually
Sets the text shown on the blackboard. in some cases, this may not be text, but the file nameof an image -- an image file name is only shown on old pages (i.e., pages of type "old").
pageObject::set_blackboard_text()
Parameters | |
| None |
String for the text on the blackboard (except on "old" pages, where the string is actually
Same function as "get_blackboard_text" except this is for the blackboard shown when you go to"let's reread this book together".
pageObject::get_blackboard_reread()
Parameters | |
| None |
String for the text on the blackboard (except on "old" pages, where the string is actually a file name)
Same function as "set_blackboard_text" except this is for the blackboard shown when you go toi"let's reread this book together".
pageObject::set_blackboard_reread($valIn)
Parameters | |
| ValIn | String for the text on the blackbaord (except on "old" pages, where the string is atually a filae name) |
Gets the type of page this is, either "old" or "new". Old pages should no longer be created, theythey were only used when migrating old content to this new site because blackboard text could not be parsed and an image had to be used instead.
pageObject::get_type()
Parameters | |
| None |
Type of page this is, either "old" or "new"
Sets the type of page this is, either "old" or "new". Old pages should no longer be created, theythey were only used when migrating old content to this new site because blackboard text could not be parsed and an image had to be used instead.
pageObject::set_type($valIn)
Parameters | |
| ValIn | Type of page this is, either "old" or "new" |
Gets the id of the book this page belongs to.
pageObject::get_f_key_book()
Parameters | |
| None |
Integer for the id of the book this page belongs to
Set the id of the book this page belongs to.
pageObject::set_f_key_book($valIn)
Parameters | |
| ValIn | Integer for the id of the book this page belongs to |
Return the page id of the previous page, or -1 if this is the first page.
pageObject::get_f_key_prevpage()
Parameters | |
| None |
Integer for the id of the previous page or -1 if this is the first page
Set the the page id of the previous page. set this to -1 if this is the first page.
pageObject::set_f_key_prevpage($valIn)
Parameters | |
| ValIn | Integer for the id of the previous page or -1 if this is the first page |
questionObject::questionObject($id, $f_key_page, $question_content)
Parameters | |
| Id | Id of this question (primary key of the question in the database) |
| F_key_page | Id of the page this question is on |
| Question_content | String for the actual question |
Returns the id of this question.
questionObject::get_id()
Parameters | |
| None |
Integer for the id of this question
Sets the id of this question.
questionObject::set_id($valIn)
Parameters | |
| ValIn | Integer for the id of this question |
Returns the id of the page this question belongs to.
questionObject::get_f_key_page()
Parameters | |
| None |
Integer for the id of the page this question belongs to
Sets the id of the page this question belongs to.
questionObject::set_f_key_page($valIn)
Parameters | |
| ValIn | Integer for the id of the page this question belongs to |
Returns the question.
questionObject::get_question_content()
Parameters | |
| None |
String for the question itself
Sets the question.
questionObject::set_question_content($valIn)
Parameters | |
| ValIn | String for the question itself |
answerObject::answerObject($id, $answer_content, $blackboard_content, $f_key_question)
Parameters | |
| Id | Id for the answer |
| Answer_content | The answer itself |
| Blackboard_content | What should be displayed on the blackboard when this answer is selected |
| F_key_question | The id of the question this answer belongs to |
Return the unique id which identifies this answer.
answerObject::get_id()
Parameters | |
| None |
Unique id for this answer
Sets the id to uniquely identify this answer.
answerObject::set_id($valIn)
Parameters | |
| ValIn | The value for the id of this answer. remember this is what |
Returns the answer.
answerObject::get_answer_content()
Parameters | |
| None |
String containing answer to question
Sets the answer to the question.
answerObject::set_answer_content($valIn)
Parameters | |
| ValIn | String (of maximum length = 50) containing the answer |
Return the text set for the blackbaord on this answer. in other words, whatthe blackboard should say when the student selects this answer.
answerObject::get_blackboard_content()
Parameters | |
| None |
Returns the string for the blackboard text on this page
Sets the text on the blackboard for this answer. in other words, whatthe blackboard should say when the student selects this answer.
answerObject::set_blackboard_content($valIn)
Parameters | |
| ValIn | String containing text for blackboard |
Returns the question number that belongs to this answer.
answerObject::get_f_key_question()
Parameters | |
| None |
Integer value for the question's key in the database
Sets which question belongs to this answer (the id of the questionstored in the database).
answerObject::set_f_key_question($valIn)
Parameters | |
| ValIn | Integer value for the question's key in the database |