[Logicampus-cvs] logicampus/src/logicreate/lib/lesson lc_lesson.php, NONE, 1.1 lc_lesson_sequence.php, NONE, 1.1 lc_lesson_xml.php, NONE, 1.1

[Mark K <har...@us...>]

Update of /cvsroot/logicampus/logicampus/src/logicreate/lib/lesson
In directory sc8-pr-cvs6.sourceforge.net:/tmp/cvs-serv9622/lib/lesson

Added Files:
	lc_lesson.php lc_lesson_sequence.php lc_lesson_xml.php 
Log Message:
Moving libraries into sub folders.


--- NEW FILE: lc_lesson.php ---
<?php
include_once(LIB_PATH.'PBDO/ClassLessons.php');

/**
 * A lesson is the wrapper for content and content sequence for
 *  a particular timeframe.  The time may be based on a semester, or
 *  on the enrollment date for a student.
 */
class LC_Lesson {

	var $lessonDo = null;

	function LC_Lesson($id=-1) {
		if ($id > 0) {
			$this->lessonDo = ClassLessons::load($id);
		}
	}

	/**
	 * Create a LC_Lesson object from a loaded dataobject
	 *
	 * @static
	 */
	function create($do) {
		$x = new LC_Lesson();

		$x->lessonDo = $do;
		return $x;
	}

	/**
	 * Load all lessons for this class
	 *
	 * @static
	 */
	function loadClassLessons($classId) {
		$classId = intval($classId);
		if ($classId ==0 ) {
			lcError::throwError(E_USER_ERROR,'no class id specified');
			return false;
		}
		$db = DB::getHandle();

		$sql = "SELECT
		cl.*
		FROM class_lessons as cl
		WHERE id_classes = ".$classId."
		ORDER BY activeOn ASC";


		$ret = array();
		$db->query($sql);
		while ($db->nextRecord() ) {
			$temp = ClassLessonsPeer::row2Obj($db->record);
			$wrapper = LC_Lesson::create($temp);
			$ret[] = $wrapper;
		}
		return $ret;
	}

	/**
	 * Count 'content' items linked to this lesson in class_lesson_sequence
	 */
	function getContentCount() {
		$db = DB::getHandle();
		$sql = "SELECT
		count(class_lesson_sequence_id) as total
		FROM class_lesson_sequence
		WHERE lesson_id = ".$this->lessonDo->getPrimaryKey()."
		AND lob_type = 'content'
		";

		$db->query($sql);
		$db->nextRecord();
		$db->freeResult();
		return $db->record['total'];
	}

	/**
	 * Count 'interaction' items linked to this lesson in class_lesson_sequence
	 */
	function getObjectCountByType($type='content') {
		$db = DB::getHandle();
		$sql = "SELECT
		count(class_lesson_sequence_id) as total
		FROM class_lesson_sequence
		WHERE lesson_id = ".$this->lessonDo->getPrimaryKey()."
		AND lob_type = '".$type."'
		";

		$db->query($sql);
		$db->nextRecord();
		$db->freeResult();
		return $db->record['total'];
	}


	/**
	 * __TODO__ make this relative to when a user enrolls
	 */
	function getStartDate() {
		return $this->lessonDo->activeOn;
	}

	/**
	 * Returns integer representing the number of days left until this lesson starts
	 */
	function daysTilStart() {
		$days = floor(($this->lessonDo->activeOn - time()) / 86400);
		if ($days < 1) { return 0;}
		return $days;
	}

	/**
	 * Returns integer representing the number of days left until this lesson ends 
	 */
	function daysTilEnd() {
		$days = floor(($this->lessonDo->inactiveOn - time()) / 86400);
		if ($days < 1) { return 0;}
		return $days;
	}

	/**
	 * Access Getters
	 */
	function getId() {
		return $this->lessonDo->getPrimaryKey();
	}

	/**
	 * Access Getters
	 */
	function getTitle() {
		return $this->lessonDo->title;
	}

	/**
	 * Is this lesson over?
	 */
	function isFinished() {
		return $this->lessonDo->inactiveOn < time();
	}

	/**
	 * Store a lesson into the users' session
	 */
	function storeLessonInSession($lessonId, &$u) {
		$ut = time();
		$db = DB::getHandle();
		$sql = "select * from class_lessons
			where id_class_lessons='".$lesson_id."'
			and id_classes='{$u->activeClassTaken->id_classes}'";
		if (!$u->isFaculty())
			$sql .= " and (activeOn < ".time()."
				and inactiveOn > ".time().')';

		$db->queryOne($sql);
		$u->sessionvars['activeLesson'] = $db->record;
	}

	/**
	 * Find a lesson ID for a particular sequence
	 */
	function getLessonIdForSequenceId($seqId) {
		$seqObj = ClassLessonSequence::load($seqId);
		return $seqObj->lessonId;
	}
}
?>

--- NEW FILE: lc_lesson_sequence.php ---
<?php
include_once(LIB_PATH.'PBDO/ClassLessonSequence.php');

class LC_LessonSequence {

	var $lessonId = -1;
	var $classId  = -1;
	var $items    = array();

	function LC_LessonSequence($lessonId,$classId) {
		$this->lessonId = $lessonId;
		$this->classId  = $classId;
	}

	/**
	 *  Load all class_lesson_sequence items and store them in ->items
	 */
	function loadItems() {
		$this->items = ClassLessonSequencePeer::doSelect( 'class_id = '.$this->classId.' and lesson_id = '.$this->lessonId. ' order by rank');
	}

	function fetchObject($sequenceId) {
		$type = 'content';
		$repoId = -1;

		foreach ($this->items as $seqItem) {
			if ($seqItem->classLessonSequenceId == $sequenceId) {
				$type = $seqItem->lobType;
				$repoId = $seqItem->lobClassRepoId;
			}
		}
		if ($repoId == -1) { return null; }

		switch($type) {
			case 'activity':
				$activityLob = new Lc_Lob_ClassActivity($repoId);
				return $activityLob;
				break;
		}
	}

	function getSequence($sequenceId) {
		foreach ($this->items as $seqItem) {
			if ($seqItem->classLessonSequenceId == $sequenceId) {
				return $seqItem;
			}
		}
	}

	function getStartDate(&$lessonObj, $sequenceId) {
		foreach ($this->items as $seqItem) {
			if ($seqItem->classLessonSequenceId == $sequenceId) {
				return $lessonObj->getStartDate() + $seqItem->startOffset;
			}
		}
	}

	function getDueDate(&$lessonObj, $sequenceId) {
		foreach ($this->items as $seqItem) {
			if ($seqItem->classLessonSequenceId == $sequenceId) {
				if ($seqItem->dueOffset == 0) { return 0;}
				return $lessonObj->getStartDate() + $seqItem->dueOffset;
			}
		}
	}

	function isPastDueDate(&$lessonObj, $sequenceId) {
		$dueDate = $this->getDueDate($lessonObj, $sequenceId);
		if ($dueDate <= time() ) {
			return false;
		}
		return true;
	}

	function updateAssignments($contentIds,$lobData) {
		if (count($contentIds) < 1) { $contentIds = array(0);}
		$this->updateSequence($contentIds, $lobData, 'activity');
	}

	function updateTests($contentIds,$lobData) {
		if (count($contentIds) < 1) { $contentIds = array(0);}
		$this->updateSequence($contentIds, $lobData, 'test');
	}

	function updateContent($contentIds,$lobData) {
		if (count($contentIds) < 1) { $contentIds = array(0);}
		$this->updateSequence($contentIds, $lobData, 'content');
	}

	function setStartDay($objIdx, $intDays) {
		$this->items[$objIdx]->startOffset = $intDays * (60*60*24);
	}

	function setStartTime($objIdx, $timestamp) {
		$this->items[$objIdx]->startTime = $timestamp;
	}

	function getStartDay($objIdx) {
		return $this->items[$objIdx]->startOffset / (60/60/24);
	}

	function getStartTime($objIdx) {
		return $this->items[$objIdx]->startTime;
	}

	/**
	 * Must be set after startDay
	 */
	function setDueDay($objIdx, $intDays) {
		if ($intDays == -1) {
			$this->items[$objIdx]->dueOffset = -1;
		} else {
			$this->items[$objIdx]->dueOffset = $intDays * (60*60*24);
			$this->items[$objIdx]->dueOffset += $this->items[$objIdx]->startOffset;
		}
	}

	/**
	 * Sets the hour and minute of the due time, requires unix timestamp
	 */
	function setDueTime($objIdx, $timestamp) {
		$this->items[$objIdx]->dueTime = $timestamp;
	}

	function getDueDay($objIdx) {
		return $this->items[$objIdx]->dueOffset / (60/60/24);
	}

	function getDueTime($objIdx) {
		return $this->items[$objIdx]->dueTime;
	}



	/**
	 * Wrap utility function to update sequence table.
	 */
	function updateSequence($contentIds,$lobData,$type ='content') {
		$db = Db::getHandle();

		//find content objects that we didn't recieve a checkbox for
		$sql = ('SELECT class_lesson_sequence_id, lob_class_repo_id
			FROM class_lesson_sequence
			WHERE lesson_id = '.$this->lessonId.'
			AND class_id = '.$this->classId.'
			AND lob_type = "'.$type.'"
			AND lob_class_repo_id NOT IN ('.implode(',',$contentIds).')');

		//needs work to delete
		$deletes = array();
		$db->query($sql);
		while ($db->nextRecord()) {
			$deletes[] = $db->record['class_lesson_sequence_id'];
		}

		//wipe all previous content links for this lesson
		if (count ($deletes) > 0 ) {
		$db->query('DELETE from class_lesson_sequence
			WHERE class_lesson_sequence_id IN ('.implode(',',$deletes).')');
		}

		//find objects that got a checkbox but are already present in the DB
		$sql = ('SELECT class_lesson_sequence_id, lob_class_repo_id
			FROM class_lesson_sequence
			WHERE lesson_id = '.$this->lessonId.'
			AND class_id = '.$this->classId.'
			AND lob_type = "'.$type.'"
			AND lob_class_repo_id IN ('.implode(',',$contentIds).')');

		$keepers = array();
		$db->query($sql);
		while ($db->nextRecord()) {
			$keepers[] = $db->record['lob_class_repo_id'];
		}

//		debug($contentIds);
//		debug($keepers);
		//so we're only inserting absolutely new checkboxes,
		// this should keep the pkey count down significantly 
		// over other methods of deleting all records in a table
		// and then adding all new records.
		$contentIds = array_diff($contentIds,$keepers);

		//one last thing, we need to find out the maximum rank in the sequence
		$sql = ('SELECT MAX(`rank`) as toprank
			FROM class_lesson_sequence
			WHERE lesson_id = '.$this->lessonId.'
			AND class_id = '.$this->classId);

		$db->query($sql);
		$db->nextRecord();
		$topRank = $db->record['toprank'];


		//insert each new link
		$insert = 'INSERT INTO class_lesson_sequence
		(lesson_id,class_id, lob_class_repo_id, lob_type, lob_sub_type, lob_mime, lob_title, link_text, rank)
		VALUES (%d, %d, %d, "'.$type.'", "%s", "%s", "%s", "%s", %d)';

		//debug($contentIds,1);
		//debug($lobData,1);
		foreach($contentIds as $k=>$v) {
			if ($v < 1 ) continue;
			$lob = $lobData[$v];
			$topRank++;
			$db->query( sprintf($insert, $this->lessonId, $this->classId, $v, $lob['lob_sub_type'], $lob['lob_mime'], $lob['lob_title'], $lob['lob_urltitle'], $topRank));
		}
	}

	function fetchLob() {
	}
}

--- NEW FILE: lc_lesson_xml.php ---
<?php


/**
 * Process Lesson XML formats
 */
class Lc_Lesson_Xml {
}

?>