<?php

if (!defined("BASEPATH")) exit("No direct script access allowed");

/**
 * Job Queue Worker
 *
 * This controller acts as interface of the JobsQueueLib that contains all the needed functionalities to operate with
 * the Jobs Queue System
 * This is an abstract class that provide basic functionalities, it has to be extended to broaden its logic
 */
abstract class JQW_Controller extends JOB_Controller
{
	/**
	 * Constructor
	 */
	public function __construct()
	{
		parent::__construct();

		// Loads LogLib with different parameters
		$this->load->library('LogLib', array(
			'classIndex' => 5,
			'functionIndex' => 5,
			'lineIndex' => 4,
			'dbLogType' => 'job', // required
			'dbExecuteUser' => 'Jobs queue system'
		));

		// Loads JobsQueueLib library
		$this->load->library('JobsQueueLib');
	}

	//------------------------------------------------------------------------------------------------------------------
	// Protected methods

	/**
	 * To get all the most recently added jobs using the given job type
	 */
	protected function getLastJobs($type)
	{
		$jobs = $this->jobsqueuelib->getLastJobs($type);

		// If an error occurred then log it in database
		if (isError($jobs)) $this->logError(getError($jobs), $type);

		return $jobs;
	}

	/**
	 * Add new jobs in the jobs queue with the given type
	 * jobs is an array of job objects
	 */
	protected function addNewJobsToQueue($type, $jobs)
	{
		$result = $this->jobsqueuelib->addNewJobsToQueue($type, $jobs);

		// If an error occurred then log it in database
		if (isError($result)) $this->logError(getError($result), $type);

		return $result;
	}

	/**
	 * Updates jobs already present in the jobs queue
	 * jobs is an array of job objects
	 */
	protected function updateJobsQueue($type, $jobs)
	{
		$result = $this->jobsqueuelib->updateJobsQueue($type, $jobs);

		// If an error occurred then log it in database
		if (isError($result)) $this->logError(getError($result), $type);

		return $result;
	}
}