class/TermFactory.php
<?php
/**
* This file is part of Internship Inventory.
*
* Internship Inventory is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* Internship Inventory is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License version 3
* along with Internship Inventory. If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2011-2018 Appalachian State University
*/
namespace Intern;
class TermFactory
{
/**
* Get a term object using its term code.
*
* @param string $termCode
* @return Mixed<Term|bool> Returns the requested Term object, or fasle if it doesn't exist in the intern_term table.
*/
public static function getTermByTermCode(string $termCode) {
$db = PdoFactory::getPdoInstance();
$stmt = $db->prepare('SELECT * from intern_term where term = :termCode');
$stmt->execute(array('termCode' => $termCode));
$stmt->setFetchMode(\PDO::FETCH_CLASS, '\Intern\TermRestored');
return $stmt->fetch();
}
/**
* Get an associative array of every term
* in the database. Looks like: { 201840 => 'Fall 2018' }
* @return Array Associative array of term codes and their descriptions
*/
public static function getTermsAssoc()
{
$db = PdoFactory::getPdoInstance();
$stmt = $db->prepare('SELECT * from intern_term ORDER BY term DESC');
$stmt->execute();
$stmt->setFetchMode(\PDO::FETCH_CLASS, '\Intern\TermRestored');
$results = $stmt->fetchAll();
$terms = array();
foreach ($results as $term) {
$terms[$term->getTermCode()] = $term->getDescription();
}
return $terms;
}
public static function getNextTerm(Term $term) {
$db = PdoFactory::getPdoInstance();
$stmt = $db->prepare('SELECT * FROM intern_term WHERE start_timestamp > :currentTermStart ORDER BY start_timestamp ASC LIMIT 1');
$stmt->execute(array('currentTermStart' => $term->getStartTimestamp()));
$stmt->setFetchMode(\PDO::FETCH_CLASS, '\Intern\TermRestored');
$result = $stmt->fetch();
if($result === false){
return null;
}
return $result;
}
/**
* Get an associative array of terms > current term
* in the database. Looks like: { raw_term => readable_string }
*/
public static function getFutureTermsAssoc()
{
$db = PdoFactory::getPdoInstance();
$stmt = $db->prepare('SELECT * from intern_term where census_date_timestamp > :currentTimestamp ORDER BY term asc');
$stmt->execute(array('currentTimestamp'=>time()));
$stmt->setFetchMode(\PDO::FETCH_CLASS, '\Intern\TermRestored');
$terms = $stmt->fetchAll();
return $terms;
}
public static function getAvailableTerms()
{
$db = PdoFactory::getPdoInstance();
$stmt = $db->prepare('SELECT * from intern_term
where
extract(epoch from now())::int >= available_on_timestamp AND
extract(epoch from now())::int < census_date_timestamp');
$stmt->execute();
$stmt->setFetchMode(\PDO::FETCH_CLASS, '\Intern\TermRestored');
$results = $stmt->fetchAll();
return $results;
}
//gets current term as of current date
public static function getMajorTerm(){
$db = PdoFactory::getPdoInstance();
$stmt = $db->prepare('SELECT * from intern_term where
extract(epoch from now())::int >= start_timestamp AND
extract(epoch from now())::int <= end_timestamp');
$stmt->execute();
$stmt->setFetchMode(\PDO::FETCH_CLASS, '\Intern\TermRestored');
$results = $stmt->fetchAll();
return $results;
}
/**
* Determine if a term exists in the database.
* Useful for deciding if a future term is "ready" yet
*
* @param $targetTerm Term to decide if exists or not
* @return bool True if the given term eixsts in the database, false otherwise
*/
public static function termExists(string $targetTermCode)
{
$terms = self::getTermsAssoc();
return in_array($targetTerm, array_keys($terms));
}
}