1
1
<?php
2
2
3
+ namespace Joserick \Plex \Server ;
4
+
5
+ use Joserick \Plex \Plex_Server ;
6
+ use Joserick \Plex \Exception \Server \Plex_Exception_Server_Library ;
7
+ use Joserick \Plex \Server \Library \Plex_Server_Library_ItemAbstract ;
8
+ use Joserick \Plex \Server \Library \Plex_Server_Library_SectionAbstract ;
9
+
3
10
/**
4
11
* Plex Server Library
5
12
*
@@ -106,6 +113,8 @@ class Plex_Server_Library extends Plex_Server
106
113
/**
107
114
* Generic way of building a url agains the Plex library.
108
115
*
116
+ * @param string $endpoint A URL endpoint of a Plex service.
117
+ *
109
118
* @uses Plex_MachineAbstract::getBaseUrl()
110
119
* @uses Plex_Server_Library::ENDPOINT_LIBRARY
111
120
*
@@ -136,6 +145,8 @@ protected function buildUrl($endpoint)
136
145
/**
137
146
* Generic way of requesting Plex library items.
138
147
*
148
+ * @param string $endpoint A URL endpoint of a Plex service.
149
+ *
139
150
* @uses Plex_MachineAbstract::$name
140
151
* @uses Plex_MachineAbstract::$address
141
152
* @uses Plex_MachineAbstract::$port
@@ -144,7 +155,7 @@ protected function buildUrl($endpoint)
144
155
* @uses Plex_Server_Library_ItemAbstract::factory()
145
156
* @uses Plex_Server_Library_ItemInterface::setAttributes()
146
157
*
147
- * return Plex_Server_Library_Item[] An array of plex library items.
158
+ * @ return Plex_Server_Library_Item[] An array of plex library items.
148
159
*/
149
160
protected function getItems ($ endpoint )
150
161
{
@@ -173,7 +184,7 @@ protected function getItems($endpoint)
173
184
174
185
/**
175
186
* Given a function name, uses that name to decide what Plex library item
176
- * item type with whic the function is associated. This is useful when
187
+ * item type with which the function is associated. This is useful when
177
188
* trying to polymorphically request items because we can use the calling
178
189
* function to abstractly identify what type of item with which we are
179
190
* dealing.
@@ -212,7 +223,7 @@ public function functionToType($function)
212
223
213
224
/**
214
225
* Returns an array of user defined Plex library sections that can be used
215
- * to interact with th eitems contained within.
226
+ * to interact with the items contained within.
216
227
*
217
228
* @uses Plex_MachineAbstract::$name
218
229
* @uses Plex_MachineAbstract::$address
@@ -250,7 +261,7 @@ public function getSections()
250
261
}
251
262
252
263
/**
253
- * Returns a Plex library section by its given key. Here we simpoly run
264
+ * Returns a Plex library section by its given key. Here we simply run
254
265
* self::getSections() because the endpoint /library/sections/ID does not
255
266
* return full section data, it returns the categories below the section.
256
267
*
@@ -263,7 +274,7 @@ public function getSections()
263
274
*
264
275
* @throws Plex_Exception_Server_Library()
265
276
*
266
- * @deprecated This method is deprectated in lieu of the new getSection()
277
+ * @deprecated This method is deprecated in lieu of the new getSection()
267
278
* method.
268
279
*/
269
280
public function getSectionByKey ($ key )
@@ -327,7 +338,7 @@ public function getSection($polymorphicData)
327
338
* @uses Plex_Server_Library::getItem()
328
339
* @uses Plex_Server_Library::ENPOINT_RECENTLY_ADDED
329
340
*
330
- * return Plex_Server_Library_Item[] An array of plex library items.
341
+ * @ return Plex_Server_Library_Item[] An array of plex library items.
331
342
*/
332
343
public function getRecentlyAddedItems ()
333
344
{
@@ -340,7 +351,7 @@ public function getRecentlyAddedItems()
340
351
* @uses Plex_Server_Library::getItem()
341
352
* @uses Plex_Server_Library::ENPOINT_RECENTLY_ADDED
342
353
*
343
- * return Plex_Server_Library_Item[] An array of plex library items.
354
+ * @ return Plex_Server_Library_Item[] An array of plex library items.
344
355
*/
345
356
public function getOnDeckItems ()
346
357
{
0 commit comments