Merge commit 'refs/pull/179/merge' of github.com:marcelog/PAMI into PR5

PR: marcelog#179 PR Description: Add some new actions and corresponding events about ConfBridge Provided by: @brenard Fixed minor merge conflict
chan-sccp · Apr 24, 2019 · 30e41ac · 30e41ac
2 parents 1119fd9 + 8438a43
commit 30e41ac
Show file tree

Hide file tree

Showing 11 changed files with 364 additions and 21 deletions.
diff --git a/src/PAMI/Message/Action/ConfbridgeKickAction.php b/src/PAMI/Message/Action/ConfbridgeKickAction.php
@@ -1,13 +1,13 @@
 <?php
 /**
- * Show sip peers.
+ * ConfbridgeKick action message.
  *
  * PHP Version 5
  *
  * @category   Pami
  * @package    Message
  * @subpackage Action
- * @author     Marcelo Gornstein <marcelog@gmail.com>
+ * @author     Matt Styles <mstyleshk@gmail.com>
  * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
  * @version    SVN: $Id$
  * @link       http://marcelog.github.com/PAMI/
@@ -30,22 +30,25 @@
 namespace PAMI\Message\Action;
 
 /**
- * Show sip peers.
+ * ConfbridgeKick action message.
  *
  * PHP Version 5
  *
  * @category   Pami
  * @package    Message
  * @subpackage Action
- * @author     Marcelo Gornstein <marcelog@gmail.com>
+ * @author     Matt Styles <mstyleshk@gmail.com>
  * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
  * @link       http://marcelog.github.com/PAMI/
  */
-class ConfBridgeKickAction extends ActionMessage
+class ConfbridgeKickAction extends ActionMessage
 {
     /**
      * Constructor.
      *
+     * @param string $channel Channel to be muted.
+     * @param string $conference Conference on which to act.
+     *
      * @return void
      */
     public function __construct( $conference, $channel )

diff --git a/src/PAMI/Message/Action/ConfbridgeListRoomsAction.php b/src/PAMI/Message/Action/ConfbridgeListRoomsAction.php
@@ -1,13 +1,13 @@
 <?php
 /**
- * Show sip peers.
+ * ConfbridgeListRooms action message.
  *
  * PHP Version 5
  *
  * @category   Pami
  * @package    Message
  * @subpackage Action
- * @author     Marcelo Gornstein <marcelog@gmail.com>
+ * @author     Matt Styles <mstyleshk@gmail.com>
  * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
  * @version    SVN: $Id$
  * @link       http://marcelog.github.com/PAMI/
@@ -30,18 +30,18 @@
 namespace PAMI\Message\Action;
 
 /**
- * Show sip peers.
+ * ConfbridgeListRooms action message.
  *
  * PHP Version 5
  *
  * @category   Pami
  * @package    Message
  * @subpackage Action
- * @author     Marcelo Gornstein <marcelog@gmail.com>
+ * @author     Matt Styles <mstyleshk@gmail.com>
  * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
  * @link       http://marcelog.github.com/PAMI/
  */
-class ConfBridgeListRoomsAction extends ActionMessage
+class ConfbridgeListRoomsAction extends ActionMessage
 {
     /**
      * Constructor.

diff --git a/src/PAMI/Message/Action/ConfbridgeLockAction.php b/src/PAMI/Message/Action/ConfbridgeLockAction.php
@@ -1,10 +1,54 @@
 <?php
+/**
+ * ConfbridgeLock action message.
+ *
+ * PHP Version 5
+ *
+ * @category   Pami
+ * @package    Message
+ * @subpackage Action
+ * @author     Matt Styles <[email protected]>
+ * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
+ * @version    SVN: $Id$
+ * @link       http://marcelog.github.com/PAMI/
+ *
+ * Copyright 2011 Marcelo Gornstein <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 namespace PAMI\Message\Action;
 
+/**
+ * ConfbridgeLock action message.
+ *
+ * PHP Version 5
+ *
+ * @category   Pami
+ * @package    Message
+ * @subpackage Action
+ * @author     Matt Styles <[email protected]>
+ * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
+ * @link       http://marcelog.github.com/PAMI/
+ */
 class ConfbridgeLockAction extends ActionMessage
 {
     /**
-     * @param string $conference
+     * Constructor.
+     *
+     * @param string $conference Conference on which to act.
+     *
+     * @return void
      */
     public function __construct($conference)
     {

diff --git a/src/PAMI/Message/Action/ConfbridgeStartRecordAction.php b/src/PAMI/Message/Action/ConfbridgeStartRecordAction.php
@@ -0,0 +1,58 @@
+<?php
+/**
+ * ConfbridgeStartRecord action message.
+ *
+ * PHP Version 5
+ *
+ * @category   Pami
+ * @package    Message
+ * @subpackage Action
+ * @author     Matt Styles <[email protected]>
+ * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
+ * @version    SVN: $Id$
+ * @link       http://marcelog.github.com/PAMI/
+ *
+ * Copyright 2011 Marcelo Gornstein <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+namespace PAMI\Message\Action;
+
+/**
+ * ConfbridgeStartRecord action message.
+ *
+ * PHP Version 5
+ *
+ * @category   Pami
+ * @package    Message
+ * @subpackage Action
+ * @author     Matt Styles <[email protected]>
+ * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
+ * @link       http://marcelog.github.com/PAMI/
+ */
+class ConfbridgeStartRecordAction extends ActionMessage
+{
+    /**
+     * Constructor.
+     *
+     * @param string $conference Conference on which to act.
+     *
+     * @return void
+     */
+    public function __construct($conference)
+    {
+        parent::__construct('ConfbridgeStartRecord');
+        $this->setKey('Conference', $conference);
+    }
+}
diff --git a/src/PAMI/Message/Action/ConfbridgeStopRecordAction.php b/src/PAMI/Message/Action/ConfbridgeStopRecordAction.php
@@ -0,0 +1,58 @@
+<?php
+/**
+ * ConfbridgeStopRecord action message.
+ *
+ * PHP Version 5
+ *
+ * @category   Pami
+ * @package    Message
+ * @subpackage Action
+ * @author     Matt Styles <[email protected]>
+ * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
+ * @version    SVN: $Id$
+ * @link       http://marcelog.github.com/PAMI/
+ *
+ * Copyright 2011 Marcelo Gornstein <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+namespace PAMI\Message\Action;
+
+/**
+ * ConfbridgeStopRecord action message.
+ *
+ * PHP Version 5
+ *
+ * @category   Pami
+ * @package    Message
+ * @subpackage Action
+ * @author     Matt Styles <[email protected]>
+ * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
+ * @link       http://marcelog.github.com/PAMI/
+ */
+class ConfbridgeStopRecordAction extends ActionMessage
+{
+    /**
+     * Constructor.
+     *
+     * @param string $conference Conference on which to act.
+     *
+     * @return void
+     */
+    public function __construct($conference)
+    {
+        parent::__construct('ConfbridgeStopRecord');
+        $this->setKey('Conference', $conference);
+    }
+}
diff --git a/src/PAMI/Message/Action/ConfbridgeUnlockAction.php b/src/PAMI/Message/Action/ConfbridgeUnlockAction.php
@@ -1,10 +1,54 @@
 <?php
+/**
+ * ConfbridgeUnlock action message.
+ *
+ * PHP Version 5
+ *
+ * @category   Pami
+ * @package    Message
+ * @subpackage Action
+ * @author     Matt Styles <[email protected]>
+ * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
+ * @version    SVN: $Id$
+ * @link       http://marcelog.github.com/PAMI/
+ *
+ * Copyright 2011 Marcelo Gornstein <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 namespace PAMI\Message\Action;
 
+/**
+ * ConfbridgeUnlock action message.
+ *
+ * PHP Version 5
+ *
+ * @category   Pami
+ * @package    Message
+ * @subpackage Action
+ * @author     Matt Styles <[email protected]>
+ * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
+ * @link       http://marcelog.github.com/PAMI/
+ */
 class ConfbridgeUnlockAction extends ActionMessage
 {
     /**
-     * @param string $conference
+     * Constructor.
+     *
+     * @param string $conference Conference on which to act.
+     *
+     * @return void
      */
     public function __construct($conference)
     {

diff --git a/src/PAMI/Message/Event/ConfbridgeListRoomsCompleteEvent.php b/src/PAMI/Message/Event/ConfbridgeListRoomsCompleteEvent.php
@@ -1,13 +1,13 @@
 <?php
 /**
- * Event triggered when .. ?
+ * Event triggered for the end of the list when an action ConfbridgeListRooms is issued.
  *
  * PHP Version 5
  *
  * @category   Pami
  * @package    Message
  * @subpackage Event
- * @author     Marcelo Gornstein <marcelog@gmail.com>
+ * @author     Matt Styles <mstyleshk@gmail.com>
  * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
  * @version    SVN: $Id$
  * @link       http://marcelog.github.com/PAMI/
@@ -32,17 +32,26 @@
 use PAMI\Message\Event\EventMessage;
 
 /**
- * Event triggered when .. ?
+ * Event triggered for the end of the list when an action ConfbridgeListRooms is issued.
  *
  * PHP Version 5
  *
  * @category   Pami
  * @package    Message
  * @subpackage Event
- * @author     Marcelo Gornstein <marcelog@gmail.com>
+ * @author     Matt Styles <mstyleshk@gmail.com>
  * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
  * @link       http://marcelog.github.com/PAMI/
  */
 class ConfbridgeListRoomsCompleteEvent extends EventMessage
 {
+    /**
+     * Returns key: 'ListItems'.
+     *
+     * @return string
+     */
+    public function getListItems()
+    {
+        return $this->getKey('ListItems');
+    }
 }
diff --git a/src/PAMI/Message/Event/ConfbridgeListRoomsEvent.php b/src/PAMI/Message/Event/ConfbridgeListRoomsEvent.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Event triggered when .. ?
+ * Event triggered for each conference when an action ConfbridgeListRooms is issued.
  *
  * PHP Version 5
  *
@@ -32,7 +32,7 @@
 use PAMI\Message\Event\EventMessage;
 
 /**
- * Event triggered when .. ?
+ * Event triggered for each conference when an action ConfbridgeListRooms is issued.
  *
  * PHP Version 5
  *
@@ -84,5 +84,4 @@ public function getLocked()
     {
         return $this->getKey('Locked');
     }
-
 }