3 * A local payment discovery class. This class looks in local database for
4 * registered payment types and like all the others it at least returns the
5 * money bank transfer type.
7 * @author Roland Haeder <webmaster@ship-simu.org>
9 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
10 * @license GNU GPL 3.0 or any newer version
11 * @link http://www.ship-simu.org
13 * This program is free software: you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation, either version 3 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 class LocalPaymentDiscovery extends BaseDiscovery implements Discoverable, Registerable {
28 * Protected constructor
32 protected function __construct () {
33 // Call parent constructor
34 parent::__construct(__CLASS__);
38 * Create an instance of this class
40 * @param $filterInstance An instance of a filter
41 * @return $discoveryInstance An instance of this discovery class
43 public static final function createLocalPaymentDiscovery (Filterable $filterInstance) {
44 // Get an instance of this class
45 $discoveryInstance = new LocalPaymentDiscovery();
47 // Set the action from filter
48 $discoveryInstance->setActionName($filterInstance->getActionName());
50 // Return the prepared instance
51 return $discoveryInstance;
55 * Discovers the request
57 * @param $requestInstance An instance of a Requestable class
60 public function discover (Requestable $requestInstance) {
61 // Now get a search criteria and set app name and payment action as search critera
62 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
63 $criteriaInstance->addCriteria('app_name', $requestInstance->getRequestElement('app'));
64 $criteriaInstance->addCriteria('payment_action', $this->getActionName() . '_action');
65 $criteriaInstance->setLimit(1);
67 // Get a wrapper instance
68 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('payment_db_wrapper_class');
71 $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);
73 // Advanced to next entry and assert on it as it should always be there
74 assert($resultInstance->next());
76 // Set the result instance
77 $this->setResultInstance($resultInstance);
81 * Adds the database result in a human-readable format to the helper class
83 * @param $helperInstance An instance of a helper class
87 public function addResultsToHelper (HelpableTemplate $helperInstance) {