Skip to content

Commit 01b8024

Browse files
letrunghieuletrunghieu
committed
Update comments
1 parent 641d4d7 commit 01b8024

File tree

1 file changed

+54
-26
lines changed

1 file changed

+54
-26
lines changed

‎src/WordpressClient.php

+54-26
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ class WordpressClient
3636
* Create a new client with credentials
3737
*
3838
* @param string $xmlrpcEndPoint The wordpress XML-RPC endpoint
39-
* @param string $username The client's username
40-
* @param string $password The client's password
39+
* @param string $username The client's username
40+
* @param string $password The client's password
4141
* @param \Illuminate\Log\Writer $logger
4242
*/
4343
public function __construct($xmlrpcEndPoint, $username, $password, Writer $logger = null)
@@ -137,8 +137,9 @@ function getAuth()
137137
/**
138138
* Retrieve a post of any registered post type.
139139
*
140-
* @param integer $postId post id The id of selected post
141-
* @param array $fields Optional. List of field or meta-field names to include in response.
140+
* @param integer $postId the id of selected post
141+
* @param array $fields (optional) list of field or meta-field names to include in response.
142+
*
142143
* @return array
143144
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.getPosts
144145
*/
@@ -158,8 +159,9 @@ function getPost($postId, array $fields = array())
158159
/**
159160
* Retrieve list of posts of any registered post type.
160161
*
161-
* @param array $filters Optional
162-
* @param array $fields Optional
162+
* @param array $filters optional
163+
* @param array $fields optional
164+
*
163165
* @return array array of struct
164166
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.getPosts
165167
*/
@@ -176,11 +178,12 @@ function getPosts(array $filters = array(), array $fields = array())
176178
/**
177179
* Create a new post of any registered post type.
178180
*
179-
* @param string $title the post title
180-
* @param string $body the post body
181-
* @param array $categorieIds the list of category ids
182-
* @param integer $thumbnailId the thumbnail id
183-
* @param array $content the content array, see more at wordpress documentation
181+
* @param string $title the post title
182+
* @param string $body the post body
183+
* @param array $categorieIds the list of category ids
184+
* @param integer $thumbnailId the thumbnail id
185+
* @param array $content the content array, see more at wordpress documentation
186+
*
184187
* @return integer the new post id
185188
*
186189
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.newPost
@@ -202,12 +205,13 @@ function newPost($title, $body, array $content = array())
202205
/**
203206
* Edit an existing post of any registered post type.
204207
*
205-
* @param integer $postId the id of selected post
206-
* @param string $title the new title
207-
* @param string $body the new body
208-
* @param array $categorieIds the new list of category ids
209-
* @param integer $thumbnailId the new thumbnail id
210-
* @param array $content the advanced array
208+
* @param integer $postId the id of selected post
209+
* @param string $title the new title
210+
* @param string $body the new body
211+
* @param array $categorieIds the new list of category ids
212+
* @param integer $thumbnailId the new thumbnail id
213+
* @param array $content the advanced array
214+
*
211215
* @return boolean
212216
*
213217
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.editPost
@@ -221,7 +225,8 @@ function editPost($postId, array $content)
221225
/**
222226
* Delete an existing post of any registered post type.
223227
*
224-
* @param integer $postId the id of selected post
228+
* @param integer $postId the id of selected post
229+
*
225230
* @return boolean
226231
*
227232
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.deletePost
@@ -236,7 +241,8 @@ function deletePost($postId)
236241
* Retrieve a registered post type.
237242
*
238243
* @param string $postTypeName the post type name
239-
* @param array $fields Optional. List of field or meta-field names to include in response.
244+
* @param array $fields (optional) list of field or meta-field names to include in response.
245+
*
240246
* @return array
241247
*
242248
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.getPostType
@@ -252,6 +258,7 @@ function getPostType($postTypeName, array $fields = array())
252258
*
253259
* @param array $filter
254260
* @param array $fields
261+
*
255262
* @return array list of struct
256263
*
257264
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.getPostTypes
@@ -292,6 +299,7 @@ function getPostStatusList()
292299
* Retrieve information about a taxonomy.
293300
*
294301
* @param string $taxonomy the name of the selected taxonomy
302+
*
295303
* @return array taxonomy information
296304
*
297305
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.getTaxonomy
@@ -319,7 +327,8 @@ function getTaxonomies()
319327
* Retrieve a taxonomy term.
320328
*
321329
* @param integer $termId
322-
* @param string $taxonomy
330+
* @param string $taxonomy
331+
*
323332
* @return array
324333
*
325334
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.getTerm
@@ -334,7 +343,8 @@ function getTerm($termId, $taxonomy)
334343
* Retrieve list of terms in a taxonomy.
335344
*
336345
* @param string $taxonomy
337-
* @param array $filter
346+
* @param array $filter
347+
*
338348
* @return array
339349
*
340350
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.getTerms
@@ -353,6 +363,7 @@ function getTerms($taxonomy, array $filter = array())
353363
* @param string $slug
354364
* @param string $description
355365
* @param integer $parentId
366+
*
356367
* @return integer new term id
357368
*
358369
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.newTerm
@@ -385,6 +396,7 @@ function newTerm($name, $taxomony, $slug = null, $description = null, $parentId
385396
* @param integer $termId
386397
* @param string $taxonomy
387398
* @param array $content
399+
*
388400
* @return boolean
389401
*
390402
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.editTerm
@@ -401,6 +413,7 @@ function editTerm($termId, $taxonomy, array $content = array())
401413
*
402414
* @param integer $termId
403415
* @param string $taxonomy
416+
*
404417
* @return boolean
405418
*
406419
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.deleteTerm
@@ -415,6 +428,7 @@ function deleteTerm($termId, $taxonomy)
415428
* Retrieve a media item (i.e, attachment).
416429
*
417430
* @param integer $itemId
431+
*
418432
* @return array
419433
*
420434
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Media#wp.getMediaItem
@@ -429,6 +443,7 @@ function getMediaItem($itemId)
429443
* Retrieve list of media items.
430444
*
431445
* @param array $filter
446+
*
432447
* @return array
433448
*
434449
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Media#wp.getMediaLibrary
@@ -442,9 +457,12 @@ function getMediaLibrary(array $filter = array())
442457
/**
443458
* Upload a media file.
444459
*
445-
* @param string $name
446-
* @param string $mime
447-
* @param string $bits Binary data (no encoded)
460+
* @param string $name file name
461+
* @param string $mime file mime type
462+
* @param string $bits binary data (no encoded)
463+
* @param boolean $overwrite (optional)
464+
* @param int $postId (optional)
465+
*
448466
* @return array
449467
*
450468
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Media#wp.uploadFile
@@ -473,6 +491,7 @@ function uploadFile($name, $mime, $bits, $overwrite = null, $postId = null)
473491
* Retrieve comment count for a specific post.
474492
*
475493
* @param integer $postId
494+
*
476495
* @return integer
477496
*
478497
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Comments#wp.getCommentCount
@@ -501,6 +520,7 @@ function getComment($commentId)
501520
* Retrieve list of comments.
502521
*
503522
* @param array $filter
523+
*
504524
* @return array
505525
*
506526
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Comments#wp.getComments
@@ -515,7 +535,8 @@ function getComments(array $filter = array())
515535
* Create a new comment.
516536
*
517537
* @param integer $post_id
518-
* @param array $comment
538+
* @param array $comment
539+
*
519540
* @return integer new comment_id
520541
*
521542
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Comments#wp.newComment
@@ -530,7 +551,8 @@ function newComment($post_id, array $comment)
530551
* Edit an existing comment.
531552
*
532553
* @param integer $commentId
533-
* @param array $comment
554+
* @param array $comment
555+
*
534556
* @return boolean
535557
*
536558
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Comments#wp.editComment
@@ -545,6 +567,7 @@ function editComment($commentId, array $comment)
545567
* Remove an existing comment.
546568
*
547569
* @param integer $commentId
570+
*
548571
* @return boolean
549572
*
550573
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Comments#wp.deleteComment
@@ -557,6 +580,7 @@ function deleteComment($commentId)
557580

558581
/**
559582
* Retrieve list of comment statuses.
583+
*
560584
* @return array
561585
*
562586
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Comments#wp.getCommentStatusList
@@ -571,6 +595,7 @@ function getCommentStatusList()
571595
* Retrieve blog options.
572596
*
573597
* @param array $options
598+
*
574599
* @return array
575600
*
576601
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Options#wp.getOptions
@@ -592,6 +617,7 @@ function getOptions(array $options = array())
592617
* Edit blog options.
593618
*
594619
* @param array $options
620+
*
595621
* @return array
596622
*
597623
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Options#wp.setOptions
@@ -657,6 +683,7 @@ function getUsers(array $filters = array(), array $fields = array())
657683
* Retrieve profile of the requesting user.
658684
*
659685
* @param array $fields
686+
*
660687
* @return array
661688
*
662689
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Users#wp.getProfile
@@ -675,6 +702,7 @@ function getProfile(array $fields = array())
675702
* Edit profile of the requesting user.
676703
*
677704
* @param array $content
705+
*
678706
* @return boolean
679707
*
680708
* http://codex.wordpress.org/XML-RPC_WordPress_API/Users#wp.editProfile

0 commit comments

Comments
 (0)