eduadmin-api-phpclient/odata-client.php at master · MultinetInteractive/eduadmin-api-phpclient · GitHub

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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<?php

/**
 * Class EduAdminODataClient
 */
class EduAdminODataClient extends EduAdminRESTClient {
	protected $user_agent = 'EduAdmin OData API Client';

	/**
	 * @param string|null $select
	 * @param string|null $filter
	 * @param string|null $expand
	 * @param string|null $orderby
	 * @param int|null    $top
	 * @param int|null    $skip
	 * @param bool        $count
	 * @param bool        $use_cache
	 *
	 * @return mixed
	 */
	public function Search( $select = null, $filter = null, $expand = null, $orderby = null, $top = null, $skip = null, $count = false, $use_cache = true ) {
		$params = array();
		if ( isset( $select ) && ! empty( $select ) ) {
			$params['$select'] = $select;
		}
		if ( isset( $filter ) && ! empty( $filter ) ) {
			$params['$filter'] = $filter;
		}
		if ( isset( $expand ) && ! empty( $expand ) ) {
			$params['$expand'] = $expand;
		}
		if ( isset( $orderby ) && ! empty( $orderby ) ) {
			$params['$orderby'] = $orderby;
		}
		if ( isset( $top ) && ! empty( $top ) ) {
			$params['$top'] = $top;
		}
		if ( isset( $skip ) && ! empty( $skip ) ) {
			$params['$skip'] = $skip;
		}

		if ( ! empty( $use_cache ) && ! $use_cache ) {
			$params['cache'] = 'false';
		}

		$params['$count'] = $count ? 'true' : 'false';

		return parent::GET( '', $params, get_called_class() . '|' . __FUNCTION__ );
	}

	/**
	 * @param int         $id
	 * @param string|null $select
	 * @param string|null $expand
	 * @param bool        $use_cache
	 *
	 * @return mixed
	 */
	public function GetItem( $id, $select = null, $expand = null, $use_cache = true ) {
		$params = array();
		if ( isset( $select ) && ! empty( $select ) ) {
			$params['$select'] = $select;
		}
		if ( isset( $expand ) && ! empty( $expand ) ) {
			$params['$expand'] = $expand;
		}

		if ( ! empty( $use_cache ) && $use_cache === false ) {
		}

		$params['cache'] = 'false';

		return parent::GET( "($id)", $params, get_called_class() . '|' . __FUNCTION__ );
	}

	/**
	 * @param string       $endpoint
	 * @param array|object $params
	 * @param string       $method_name
	 * @param bool         $is_json
	 *
	 * @return mixed|void
	 * @throws Exception
	 * @deprecated Not allowed in OData
	 *
	 */
	final public function GET( $endpoint, $params, $method_name, $is_json = true ) {
		throw new Exception( 'This is OData, not REST, use Search or GetItem' );
	}

	/**
	 * @param string       $endpoint
	 * @param array|object $params
	 * @param string       $method_name
	 * @param bool         $is_json
	 *
	 * @return mixed|void
	 * @throws Exception
	 * @deprecated Not allowed in OData
	 *
	 */
	final public function POST( $endpoint, $params, $method_name, $is_json = true ) {
		throw new Exception( 'This is OData, not REST, use Search or GetItem' );
	}

	/**
	 * @param string       $endpoint
	 * @param array|object $params
	 * @param string       $method_name
	 * @param bool         $is_json
	 *
	 * @return mixed|void
	 * @throws Exception
	 * @deprecated Not allowed in OData
	 *
	 */
	final public function PATCH( $endpoint, $params, $method_name, $is_json = true ) {
		throw new Exception( 'This is OData, not REST, use Search or GetItem' );
	}

	/**
	 * @param string       $endpoint
	 * @param array|object $params
	 * @param string       $method_name
	 * @param bool         $is_json
	 *
	 * @return mixed|void
	 * @throws Exception
	 * @deprecated Not allowed in OData
	 *
	 */
	final public function DELETE( $endpoint, $params, $method_name, $is_json = true ) {
		throw new Exception( 'This is OData, not REST, use Search or GetItem' );
	}

	/**
	 * @param string       $endpoint
	 * @param array|object $params
	 * @param string       $method_name
	 * @param bool         $is_json
	 *
	 * @return mixed|void
	 * @throws Exception
	 * @deprecated Not allowed in OData
	 *
	 */
	final public function PUT( $endpoint, $params, $method_name, $is_json = true ) {
		throw new Exception( 'This is OData, not REST, use Search or GetItem' );
	}
}