Add @throws tags where needed

sanduhrs · Mar 22, 2018 · 070224c · 070224c
1 parent bb92ce3
commit 070224c
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 1 deletion.
diff --git a/src/BigBlueButton/Client.php b/src/BigBlueButton/Client.php
@@ -300,7 +300,7 @@ public function getRaw($call, $options = [])
      * @param array $options
      *   The API call options.
      *
-     * @throws \Exception
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      *
      * @return object
      *   The response data as object.

diff --git a/src/BigBlueButton/Member/Meeting.php b/src/BigBlueButton/Member/Meeting.php
@@ -969,6 +969,8 @@ public function setClient(Client $client)
      * @return \sanduhrs\BigBlueButton\Member\Meeting
      *   The meeting object.
      *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
+     *
      * @todo http://docs.bigbluebutton.org/dev/api.html#preupload-slides
      */
     public function create()
@@ -1054,6 +1056,8 @@ public function join($fullName, $moderator = false, $options = [])
      *
      * @return boolean
      *   The running status of the meeting TRUE for running.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function isRunning()
     {
@@ -1068,6 +1072,8 @@ public function isRunning()
      *
      * @return boolean
      *   The running status of the meeting TRUE for running.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function getRunning()
     {
@@ -1086,6 +1092,8 @@ public function getRunning()
      *
      * @return boolean
      *   The boolean TRUE if the end request has been sent.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function end()
     {
@@ -1105,6 +1113,8 @@ public function end()
      *
      * @return \sanduhrs\BigBlueButton\Member\Meeting
      *   The meeting object.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     private function getInfo()
     {
@@ -1148,6 +1158,8 @@ private function getInfo()
      *
      * @return \sanduhrs\BigBlueButton\Member\Recording|FALSE
      *   An recording object or FALSE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function getRecording($recordingID)
     {
@@ -1165,6 +1177,8 @@ public function getRecording($recordingID)
      *
      * @return array
      *   An array of \sanduhrs\BigBlueButton\Recording.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function getRecordings()
     {
@@ -1200,6 +1214,8 @@ public function getRecordings()
      *
      * @return boolean
      *   The success status as TRUE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function publishRecording($recordID)
     {
@@ -1216,6 +1232,8 @@ public function publishRecording($recordID)
      *
      * @return boolean
      *   The success status as TRUE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function publishRecordings($recordIDs)
     {
@@ -1237,6 +1255,8 @@ public function publishRecordings($recordIDs)
      *
      * @return boolean
      *   The success status as TRUE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function deleteRecording($recordID)
     {
@@ -1253,6 +1273,8 @@ public function deleteRecording($recordID)
      *
      * @return boolean
      *   The success status as TRUE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function deleteRecordings($recordIDs)
     {

diff --git a/src/BigBlueButton/Member/Recording.php b/src/BigBlueButton/Member/Recording.php
@@ -268,6 +268,8 @@ public function setClient(Client $client)
      * Publish recording.
      *
      * @return mixed
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function publish()
     {
@@ -282,6 +284,8 @@ public function publish()
      * Unpublish recording.
      *
      * @return mixed
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function unpublish()
     {
@@ -296,6 +300,8 @@ public function unpublish()
      * Delete recording.
      *
      * @return mixed
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function delete()
     {

diff --git a/src/BigBlueButton/Server.php b/src/BigBlueButton/Server.php
@@ -60,6 +60,8 @@ public function __construct(
      *
      * @return string
      *   The version of the BigBlueButton server instance.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function getVersion()
     {
@@ -140,6 +142,8 @@ public function getVersion()
      *
      * @return \sanduhrs\BigBlueButton\Member\Meeting
      *   A meeting object.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function addMeeting($options)
     {
@@ -174,6 +178,8 @@ public function getMeeting($meetingID)
      *
      * @return array
      *   An array of \sanduhrs\BigBlueButton\Meetings.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function getMeetings()
     {
@@ -216,6 +222,8 @@ public function getMeetings()
      *
      * @return \sanduhrs\BigBlueButton\Member\Recording|FALSE
      *   An recording object or FALSE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function getRecording($recordingID)
     {
@@ -233,6 +241,8 @@ public function getRecording($recordingID)
      *
      * @return array
      *   An array of \sanduhrs\BigBlueButton\Member\Recording.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function getRecordings()
     {
@@ -291,6 +301,8 @@ public function publishRecording($recordID)
      *
      * @return boolean
      *   The success status as TRUE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function publishRecordings($recordingIDs)
     {
@@ -312,6 +324,8 @@ public function publishRecordings($recordingIDs)
      *
      * @return boolean
      *   The success status as TRUE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function unpublishRecording($recordID)
     {
@@ -328,6 +342,8 @@ public function unpublishRecording($recordID)
      *
      * @return boolean
      *   The success status as TRUE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function unpublishRecordings($recordIDs)
     {
@@ -349,6 +365,8 @@ public function unpublishRecordings($recordIDs)
      *
      * @return boolean
      *   The success status as TRUE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function deleteRecording($recordID)
     {
@@ -365,6 +383,8 @@ public function deleteRecording($recordID)
      *
      * @return boolean
      *   The success status as TRUE.
+     *
+     * @throws \sanduhrs\BigBlueButton\Exception\BigBlueButtonException
      */
     public function deleteRecordings($recordIDs)
     {