khosb/modules/service/classes/model/service.php

<?php defined('SYSPATH') or die('No direct access allowed.');

/**
 * This class supports Services
 *
 * @package    OSB
 * @subpackage Service
 * @category   Models
 * @author     Deon George
 * @copyright  (c) 2010 Open Source Billing
 * @license    http://dev.osbill.net/license.html
 */
class Model_Service extends ORMOSB {
	// Relationships
	protected $_has_many = array(
		'invoice'=>array('through'=>'invoice_item'),
	);
	protected $_belongs_to = array(
		'product'=>array(),
		'account'=>array(),
	);

	/**
	 * Filters used to format the display of values into friendlier values
	 */
	protected $_display_filters = array(
		'active'=>array(
			array('StaticList_YesNo::display',array(':value')),
		),
		'date_last_invoice'=>array(
			array('Config::date',array(':value')),
		),
		'date_next_invoice'=>array(
			array('Config::date',array(':value')),
		),
		'recur_schedule'=>array(
			array('StaticList_RecurSchedule::display',array(':value')),
		),
		'price'=>array(
			array('Tax::add',array(':value')),
			array('Currency::display',array(':value')),
		),
	);

	/**
	 * The service_name should be implemented in child objects.
	 * It renders the name of the service, typically used on invoice
	 */
	protected function _service_name() {
		throw new Kohana_Exception(':method not defined in child class :class',array(':method'=>__METHOD__,':class'=>get_class($this)));
	}

	/**
	 * The service_view should be implemented in child objects.
	 * It renders the details of the ordered service
	 */
	protected function _service_view() {
		throw new Kohana_Exception(':method not defined in child class :class',array(':method'=>__METHOD__,':class'=>get_class($this)));
	}

	/**
	 * The _details should be implemented in child objects.
	 */
	protected function _details($type) {
		throw new Kohana_Exception(':method not defined in child class :class',array(':method'=>__METHOD__,':class'=>get_class($this)));
	}

	protected function _admin_update() {
		throw new Kohana_Exception(':method not defined in child class :class',array(':method'=>__METHOD__,':class'=>get_class($this)));
	}

	/**
	 * Return the object of the product plugin
	 */
	public function plugin() {
		if (! $this->product->prod_plugin_file)
			return NULL;

		if (! is_numeric($this->product->prod_plugin_data))
			throw new Kohana_Exception('Missing plugin_id for :product (:type)',array(':product'=>$this->product->id,':type'=>$this->product->prod_plugin_file));

		return ORM::factory(sprintf('service_plugin_%s',$this->product->prod_plugin_file),array('service_id'=>$this->id));
	}

	/**
	 * Display the service number
	 */
	public function id() {
		return sprintf('%05s',$this->id);
	}

	/**
	 * Display the service product name
	 */
	public function name() {
		return is_null($plugin=$this->plugin()) ? $this->product->name() : $plugin->name();
	}

	public function service_name() {
		return is_null($plugin=$this->plugin()) ? $this->name() : $plugin->service_name();
	}

	public function service_view() {
		return is_null($plugin=$this->plugin()) ? HTML::nbsp('') : $plugin->service_view();
	}

	/**
	 * Display the product feature summary
	 */
	public function product_feature_summary() {
		return $this->product->feature_summary();
	}

	/**
	 * Render some details for specific calls, eg: invoice
	 */
	public function details($type) {
		switch ($type) {
			case 'invoice_detail_items':
				if (is_null($plugin = $this->plugin()))
					return array();
				else
					return $plugin->_details($type);
				break;

			default:
				throw new Kohana_Exception('Unkown detail request :type',array(':type'=>$type));
		}
	}

	public function admin_update() {
		if (is_null($plugin = $this->plugin()))
			return NULL;
		else
			return $plugin->_admin_update();
	}

	// @todo To implement
	/**
	 * Calculate the tax for this item
	 */
	public function tax() {
		return $this->price * .1;
	}

	public function list_active() {
		return $this->where('active','=','1')->find_all();
	}

	public function list_bylistgroup($cat) {
		$result = array();

		$cats = ORM::factory('product_category')->list_bylistgroup($cat);

		foreach ($this->list_active() as $so) {
			if (! $so->product->avail_category_id OR ! preg_match('/^a:/',$so->product->avail_category_id))
				continue;

			$pc = unserialize($so->product->avail_category_id);
			if (array_intersect($pc,array_keys($cats)))
				array_push($result,$so);
		}

		return $result;
	}

	/**
	 * List services that need to be billed.
	 */
	public function list_invoicesoon() {
		$result = array();

		foreach ($this->list_active() as $so)
			// @todo This should be configurable
			if (! $so->suspend_billing AND $so->date_next_invoice < time()+35*86400)
				array_push($result,$so);

		return $result;
	}
}
?>