Commit | Line | Data |
---|---|---|
9abe1c3b TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 5 | | |
5 | +--------------------------------------------------------------------+ | |
f299f7db | 6 | | Copyright CiviCRM LLC (c) 2004-2020 | |
9abe1c3b TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | namespace Civi\API\Provider; | |
29 | ||
9abe1c3b TO |
30 | /** |
31 | * A wrapping provider overrides an existing API. It has discretion to pass-through | |
32 | * to the original API (0 or many times) or to substitute with entirely different | |
33 | * behavior. | |
34 | * | |
35 | * The WrappingProvider does yield any metadata of its own. It's primarily | |
36 | * intended for dynamically decorating an existing API. | |
37 | */ | |
38 | class WrappingProvider implements ProviderInterface { | |
39 | ||
40 | /** | |
41 | * @var callable | |
42 | * Function($apiRequest, callable $continue) | |
43 | */ | |
44 | protected $callback; | |
45 | ||
46 | /** | |
47 | * @var ProviderInterface | |
48 | */ | |
49 | protected $original; | |
50 | ||
51 | /** | |
52 | * WrappingProvider constructor. | |
53 | * @param callable $callback | |
54 | * @param \Civi\API\Provider\ProviderInterface $original | |
55 | */ | |
56 | public function __construct($callback, \Civi\API\Provider\ProviderInterface $original) { | |
57 | $this->callback = $callback; | |
58 | $this->original = $original; | |
59 | } | |
60 | ||
61 | public function invoke($apiRequest) { | |
62 | // $continue = function($a) { return $this->original->invoke($a); }; | |
63 | $continue = [$this->original, 'invoke']; | |
64 | return call_user_func($this->callback, $apiRequest, $continue); | |
65 | } | |
66 | ||
67 | public function getEntityNames($version) { | |
68 | // return $version == $this->version ? [$this->entity] : []; | |
69 | throw new \API_Exception("Not support: WrappingProvider::getEntityNames()"); | |
70 | } | |
71 | ||
72 | public function getActionNames($version, $entity) { | |
73 | // return $version == $this->version && $this->entity == $entity ? [$this->action] : []; | |
74 | throw new \API_Exception("Not support: WrappingProvider::getActionNames()"); | |
75 | } | |
76 | ||
77 | } |