<?php
/**
 * Provides the payment class, an interface to the payment table in the database
 *
 * @author Camil Staps
 *
 * BusinessAdmin: administrative software for small companies
 * Copyright (C) 2015 Camil Staps (ViviSoft)
 *
 * This program 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.
 *
 * This program 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
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * An interface to the payment table in the database
 */
class Payment extends Model {
	/** {@inheritDoc} */
	public
		$table = 'payment',
		$fillable_columns = ['offerId', 'date', 'braintree_id'];

	/**
	 * Get the offer that this payment is linked to
	 *
	 * @return offer                The offer
	 */
	public function getOffer() {
		return new Offer($this->pdo, $this->offerId);
	}

	/**
	 * {@inheritDoc}
	 * @param $key {@inheritDoc}
	 * @param $value {@inheritDoc}
	 */
	protected function accessor($key, $value) {
		switch ($key) {
			case 'date':
				return strtotime($value);
				break;
			default:
				return parent::accessor($key, $value);
		}
	}

	/**
	 * {@inheritDoc}
	 * @param $key {@inheritDoc}
	 * @param $value {@inheritDoc}
	 */
	protected function mutator($key, $value) {
		switch ($key) {
			case 'date':
				return is_string($value) ? $value : date('Y-m-d H:i:s', $value);
				break;
			default:
				return parent::mutator($key, $value);
		}
	}

	/**
	 * Make a mailer to send about this payment
	 *
	 * @return Mailer                   The mailer
	 */
	public function mailer() {
		$mailer = new Mailer($this->pdo);
		$mailer->setOffer($this->getOffer());

		$mailer->Subject = 'Your invoice has been paid';
		$mailer->Body = Correspondence::__r('mail-offer-paid', $this->getOffer()->getContact()->language, $this);

		return $mailer;
	}

	/**
	 * Send the payment notification to the offer's contact
	 *
	 * @return bool                     The result of Mailer::send
	 */
	public function send() {
		return $this->mailer()->send();
	}
}