Your IP : 216.73.216.85
<?php
/**
* @package Sven.Bluege
* @subpackage com_eventgallery
*
* @copyright Copyright (C) 2005 - 2019 Sven Bluege All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Svenbluege\Component\Eventgallery\Site\Library\Interface;
use Joomla\CMS\Form\Form;
use Svenbluege\Component\Eventgallery\Site\Library\Common\Money;
use Svenbluege\Component\Eventgallery\Site\Library\LineitemContainer;
use Svenbluege\Component\Eventgallery\Site\Library\Order;
defined('_JEXEC') or die();
/**
* This interface provides a general interface for all methods. All methods are configured using the database.
*
* Class Method
*/
interface Method
{
/**
* Returns the id of the current method.
*
* @return string the id
*/
public function getId();
/**
* Returns the price of the method. If a lineitemcontainer is
* provided, possible dynamic prices can be calculated.
*
* @param LineitemContainer $lineitemcontainer
* @return Money the price value
*/
public function getPrice($lineitemcontainer = null);
/**
* Returns the name of the method
*
* @return string display name
*/
public function getName();
/**
* Returns the display name of the method for the current locale
*
* @return string display name
*/
public function getDisplayName();
/**
* Returns the description of the method for the current locale
*
* @return string display name
*/
public function getDescription();
/**
* returns true if this is the default method.
*
* @return bool
*/
public function isDefault();
/**
* Returns an object containing the data of a method.
*
* @return mixed|null
*/
public function getData();
/**
* @param \stdClass $data
*/
public function setData(\stdClass $data);
/**
* calculates the included tax. If a lineitemcontainer is
* provided, possible dynamic prices can be calculated.
*
*
* returns the amount of tax for this item
* @param LineitemContainer $lineitemcontainer
* @return float
*/
public function getTax($lineitemcontainer = null);
/**
* Return the tax rate. 100 == 100%
*
* @return int
*/
public function getTaxrate();
/**
* returns the percentage value of the field price_percentaged. It does NOT calculate the price!
*
* @return float
*/
public function getPercentagedPrice();
/**
* Returns if this method can be used with the current cart.
*
* @param LineitemContainer $cart
*
* @return bool
*/
public function isEligible($cart);
/**
* returns the type code of this method
*
* @return int
*/
public function getTypeCode();
/**
*
* Event which is called if an order is about to be submitted
*
* @param $lineitemcontainer LineitemContainer
*
* @return bool|array true or array with errors
*/
public function processOnOrderSubmit($lineitemcontainer);
/**
* is called if there is an incoming request from an external system for a payment method.
*
* @return
*/
public function onIncomingExternalRequest();
/**
* Call this method if you want to prepare the form to edit this method
*
* @param Form $form
* @return Form
*/
public function onPrepareAdminForm($form);
/**
* Once the editing is done any the data has to be saved, call this method
*
* @param array $validData
* @return boolean
*/
public function onSaveAdminForm($validData);
/**
* This method returns content which can be shown if the method is displayed on a review page.
* A review page is a page where the method is attached to a cart instead of an order
*
* @param $lineitemcontainer LineitemContainer
* @param $isContentForMail defines if the rendered content is for an email instead of a html page
* @return String
*/
public function getMethodReviewContent($lineitemcontainer, $isContentForMail);
/**
* This method returns content which can be shown if the method is displayed on a review page.
* A review page is a page where the method is attached to an order instead of a cart
* Keep in mind that this content is also part of emails.
*
* @param $lineitemcontainer LineitemContainer
* @param $isContentForMail defines if the rendered content is for an email instead of a html page
* @return String
*/
public function getMethodConfirmContent($lineitemcontainer, $isContentForMail);
/**
* Gets triggered if the order status changes.
*
* @param $order Order
* @return void
*/
public function onOrderStatusChange($order);
/**
* Gets triggered if the shipping status changes.
*
* @param $order Order
* @return void
*/
public function onShippingStatusChange($order);
/**
* Gets triggered if the payment status changes.
*
* @param $order Order
* @return void
*/
public function onPaymentStatusChange($order);
}