ptut-vhost/build/api/module/professorController.php

<?php
/**
 * Created by PhpStorm.
 * User: lucas
 * Date: 27/02/18
 * Time: 16:19
 */

namespace api\module;


use database\core\Repo;
use database\repo\professor;
use error\core\Error;
use error\core\Err;

class professorController{

	/* (1) Returns 1 or all professors
	*
	* @prof_id<int>						[OPT] The professor UID
	*
	* @return professors<array>			The professor(s) data
	*
	---------------------------------------------------------*/
	public static function get($args){
		$prof_id = null;
		$with_vh = 0;
		extract($args);

		/* Get the professor repo */
		/** @var professor $prof_repo */
		$prof_repo = Repo::getRepo('professor');


		/* (1) If with VH data
		---------------------------------------------------------*/
		if( is_int($with_vh) && $with_vh === 1 ){

			/* (1) Get All professors or 1 by its id (if set) */
			$fetched = $prof_repo->getWithVH($prof_id);

			/* (2) Return data */
			return ['professors' => $fetched];

		}


		/* (2) If without VH data (only Professor.*)
		---------------------------------------------------------*/
		/* (1) Get All professors or 1 by its id (if set) */
		$fetched = $prof_repo->get($prof_id);

		/* (3) Return data */
		return ['professors' => $fetched];

	}


	/* (2) Creates a new professor
	*
	* @lastName<String>					The professor's lastName
	* @firstName<String>				The professor's firstName
	* @category<int>					The professor's category ID
	* @hoursToDo<int>					The professor's number of hours to do
	* @initials<int>					The professor's initials
	* @isAdmin<bool>					Whether the professor is an admin
	* @casLogin<String>					The professor's CAS username
	*
	* @return prof_id<int>				The created professor UID (if no error)
	*
	---------------------------------------------------------*/
	public static function post($args){
		$lastName  = "";
		$firstName = "";
		$category  = 0;
		$hoursToDo = 0;
		$initials  = "";
		$isAdmin   = false;
		$casLogin  = null;
		extract($args);

		/* Get the professor repo */
		/** @var professor $prof_repo */
		$prof_repo = Repo::getRepo('professor');

		/* (1) Check if professor already exists */
		$exists = $prof_repo->exists($lastName, $firstName);

		/* (2) If found -> already exists */
		if( !is_null($exists) )
			return ['error' => new Error(Err::AlreadyExists)];

		/* (3) Else try to create */
		$repo_rtn = $prof_repo->create(
			$lastName,
			$firstName,
			$category,
			$hoursToDo,
			$initials,
			$isAdmin,
			is_null($casLogin) ? "" : $casLogin
		);


		/* (4) If repo error -> return it */
		if( is_null($repo_rtn) )
			return ['error' => new Error(Err::RepoError)];


		/* (5) Else return UID */
		return ['created_uid' => $repo_rtn];

	}


	/* (3) Deletes an existing professor
	*
	* @prof_id<int>						The professor UID
	*
	* @return deleted<bool>				Whether it has been removed
	*
	---------------------------------------------------------*/
	public static function delete($args){
		$prof_id = 0;
		extract($args);

		/* Get the professor repo */
		/** @var professor $prof_repo */
		$prof_repo = Repo::getRepo('professor');

		/* (1) Try to delete */
		return ['deleted' => $prof_repo->delete($prof_id)];

	}


	/* (4) Edits an existing professor
	*
	* @prof_id<int>						The professor UID
	* @lastName<String>					[OPT] The professor's lastName
	* @firstName<String>				[OPT] The professor's firstName
	* @category<int>					[OPT] The professor's category ID
	* @hoursToDo<int>					[OPT] The professor's number of hours to do
	* @initials<int>					[OPT] The professor's initials
	* @isAdmin<bool>					[OPT] Whether the professor is an admin
	* @casLogin<String>					[OPT] The professor's CAS username
	* @remCas<bool>						[OPT] Whether to remove the CAS login (only works if @casLogin is NULL)
	*
	* @return updated<bool>				Whether it has been updated
	*
	---------------------------------------------------------*/
	public static function put($args){
		$prof_id   = 0;
		$lastName  = null;
		$firstName = null;
		$category  = null;
		$hoursToDo = null;
		$initials  = null;
		$isAdmin   = null;
		$casLogin  = null;
		$remCas    = false;
		extract($args);

		/* Get the professor repo */
		/** @var professor $prof_repo */
		$prof_repo = Repo::getRepo('professor');

		/* (1) Try to update */
		return ['updated' => $prof_repo->update(
			$prof_id,
			$lastName,
			$firstName,
			$category,
			$hoursToDo,
			$initials,
			$isAdmin,
			$remCas === true && is_null($casLogin) ? '' : $casLogin
		)];

	}

}