Some more comments added, selfInstance rewritten to registryInstance
[core.git] / inc / classes / main / filter / payment / class_PaymentDiscoveryFilter.php
1 <?php
2 /**
3  * A filter for payment discovery. This class discovers the payment type and
4  * returns an object holding all available payment system for the requested
5  * type.
6  *
7  * @author              Roland Haeder <webmaster@ship-simu.org>
8  * @version             0.0.0
9  * @copyright   Copyright (c) 2007 - 2009 Roland Haeder, this is free software
10  * @license             GNU GPL 3.0 or any newer version
11  * @link                http://www.ship-simu.org
12  *
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.
17  *
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.
22  *
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/>.
25  */
26 class PaymentDiscoveryFilter extends BaseFilter implements Filterable {
27         /**
28          * Action name for payment discovery
29          */
30         private $actionName = "";
31
32         /**
33          * Protected constructor
34          *
35          * @return      void
36          */
37         protected function __construct () {
38                 // Call parent constructor
39                 parent::__construct(__CLASS__);
40         }
41
42         /**
43          * Creates an instance of this filter class
44          *
45          * @param       $actionInstance         A performable action
46          * @return      $filterInstance         An instance of this filter class
47          * @throws      NullPointerException    If the resolver is not set
48          */
49         public final static function createPaymentDiscoveryFilter (PerformableAction $actionInstance) {
50                 // Get a new instance
51                 $filterInstance = new PaymentDiscoveryFilter();
52
53                 // Get resolver from action
54                 $resolverInstance = $actionInstance->getResolverInstance();
55
56                 // Is the resolver set?
57                 if (is_null($resolverInstance)) {
58                         // Throw an exception here
59                         throw new NullPointerException($filterInstance, self::EXCEPTION_IS_NULL_POINTER);
60                 } // END - if
61
62                 // Get the action name from resolver
63                 $actionName = $resolverInstance->getActionName();
64
65                 // Store it away in this class
66                 $filterInstance->setActionName($actionName);
67
68                 // Return the instance
69                 return $filterInstance;
70         }
71
72         /**
73          * Protected setter for action name
74          *
75          * @param       $actionName             Action name to set
76          * @return      void
77          */
78         protected final function setActionName ($actionName) {
79                 $this->actionName = (string) $actionName;
80         }
81
82         /**
83          * Getter for action name
84          *
85          * @return      $actionName             Action name to set
86          */
87         public final function getActionName () {
88                 return $this->actionName;
89         }
90
91         /**
92          * Executes the filter with given request and response objects
93          *
94          * @param       $requestInstance        An instance of a class with an Requestable interface
95          * @param       $responseInstance       An instance of a class with an Responseable interface
96          * @return      void
97          * @todo        0% done
98          */
99         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
100                 // Try to get real discovery class
101                 try {
102                         // Get an instance from the object factory
103                         $discoveryInstance = ObjectFactory::createObjectByConfiguredName($this->getActionName().'_payment_discovery', array($this));
104
105                         // Call the discovery method
106                         $discoveryInstance->discover($requestInstance);
107
108                         // Remember this instance if all wents fine
109                         Registry::getRegistry()->addInstance('payments', $discoveryInstance);
110                 } catch (ConfigEntryNotFoundException $e) {
111                         // Something bad happend
112                         $requestInstance->requestIsValid(false);
113
114                         // Add a message to the response
115                         $responseInstance->addFatalMessage('payment_config_entry_error');
116                         $responseInstance->addFatalMessagePlain($e->getMessage());
117
118                         // Abort here
119                         return false;
120                 } catch (ClassNotFoundException $e) {
121                         // Something bad happend
122                         $requestInstance->requestIsValid(false);
123
124                         // Add a message to the response
125                         $responseInstance->addFatalMessage('payment_class_error');
126                         $responseInstance->addFatalMessagePlain($e->getMessage());
127
128                         // Abort here
129                         return false;
130                 }
131         }
132 }
133
134 // [EOF]
135 ?>