-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathWebserviceModel.php
More file actions
136 lines (109 loc) · 2.55 KB
/
WebserviceModel.php
File metadata and controls
136 lines (109 loc) · 2.55 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<?php
namespace App\Model;
use App\Model\Trait\Format;
use App\Model\Trait\Module;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
abstract class WebserviceModel
{
use Module;
use Format;
private string $_class = '';
/**
* The type of webservice, can be used for categorizing.
*
* @var string
*/
public string $type = '';
/**
* Human-readable name used in the interface.
*
* @var string
*/
public string $name = '';
/**
* Human-readable description used in the interface.
*
* @var string
*/
public string $description = '';
public function __construct()
{
// Construct.
}
public function getType(): string
{
return $this->type;
}
public function getName(): string
{
return $this->name;
}
public function getDescription(): string
{
return $this->description;
}
public function getFields(): array
{
return [
'request' => [
//'label' => 'Request',
'nested' => $this->getRequestFields(),
],
'response' => [
//'label' => 'Response',
'nested' => [
'format' => $this->getFormatDecodeField(),
],
],
];
}
abstract public function getAuthFields(): array;
abstract public function getRequestFields( $defaults = [] ): array;
abstract public function getRequestUrl( array $config ): string;
public function authorize( array $config ): array
{
return $config;
}
abstract public function retrieve( array $config );
abstract public function send( array $config, $data );
public function handleRequest( Request $request, ConnectionModel $connection ): Response
{
return new Response();
}
public function normalize(): array
{
$props = [
'_class' => $this->getClassName(),
'type' => $this->getType(),
'name' => $this->getName(),
'description' => $this->getDescription(),
'fields' => $this->getFields(),
'auth' => $this->getAuthFields(),
];
if ( $this->isFromModule() ) {
$props['module'] = $this->getModule()->getName();
}
return $props;
}
final static function isWebservice( $class ): bool
{
return $class instanceof WebserviceModel;
}
final public function getClassName(): string
{
if ( ! $this->_class ) {
$this->parseClassName();
}
$prefix = '';
if ( $this->isFromModule() ) {
$prefix = $this->getModule()->getName() . ':';
}
return $prefix . $this->_class;
}
private function parseClassName(): void
{
$pos = strrpos( static::class, '\\' );
$this->_class = false === $pos ? static::class : substr( static::class, $pos + 1 );
}
}