/src/Plivo/XML/MultiPartyCall.php

https://github.com/plivo/plivohelper-php · PHP · 223 lines · 208 code · 5 blank · 10 comment · 36 complexity · d57256d3c8e8d006bcad9e723214a380 MD5 · raw file 

    

  1. <?php
    2. 

  2. 

  3. namespace Plivo\XML;
    4. 

  4. 

  5. 

  6. use Plivo\Exceptions\PlivoXMLException;
    7. 

  7. use Plivo\Util\MPCUtils;
    8. 

  8. /**
    9. 

  9.  * Class Conference
    10. 

  10.  * @package Plivo\XML
    11. 

  11.  */
    12. 

  12. class MultiPartyCall extends Element {
    13. 

  13.     protected $nestables = [];
    14. 

  14. 

  15.     protected $valid_attributes = [
    16. 

  16.         'role', 'maxDuration', 'maxParticipants', 'waitMusicUrl',
    17. 

  17.         'waitMusicMethod', 'agentHoldMusicUrl', 'agentHoldMusicMethod',
    18. 

  18.         'customerHoldMusicUrl', 'customerHoldMusicMethod', 'record',
    19. 

  19.         'recordFileFormat', 'recordingCallbackUrl', 'recordingCallbackMethod',
    20. 

  20.         'statusCallbackEvents', 'statusCallbackUrl', 'statusCallbackMethod',
    21. 

  21.         'stayAlone', 'coachMode', 'mute', 'hold', 'startMpcOnEnter', 'endMpcOnExit',
    22. 

  22.         'enterSound', 'enterSoundMethod', 'exitSound', 'exitSoundMethod',
    23. 

  23.         'onExitActionUrl', 'onExitActionMethod', 'relayDTMFInputs',
    24. 

  24.         'startRecordingAudio', 'startRecordingAudioMethod', 'stopRecordingAudio', 'stopRecordingAudioMethod',
    25. 

  25.         'recordMinMemberCount'
    26. 

  26.     ];
    27. 

  27. 

  28.     /**
    29. 

  29.      * Conference constructor.
    30. 

  30.      * @param string $body
    31. 

  31.      * @param array $attributes
    32. 

  32.      * @throws PlivoXMLException
    33. 

  33.      */
    34. 

  34.     function __construct($body, $attributes = []) {
    35. 

  35.         parent::__construct($body, $attributes);
    36. 

  36.         $VALID_ROLE_VALUES = ['agent', 'supervisor', 'customer'];
    37. 

  37.         $VALID_METHOD_VALUES = ['GET', 'POST'];
    38. 

  38.         $VALID_RECORD_FILE_FORMAT_VALUES = ['mp3', 'wav'];
    39. 

  39.         if (!$body) {
    40. 

  40.             throw new PlivoXMLException("No MultiPartyCall name set for ".$this->getName());
    41. 

  41.         }
    42. 

  42.         if(isset($attributes['role']) and !in_array(strtolower($attributes['role']), $VALID_ROLE_VALUES, true)){
    43. 

  43.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['role']. ' for role');
    44. 

  44.         }
    45. 

  45.         elseif (!isset($attributes['role'])){
    46. 

  46.             throw new PlivoXMLException('role not mentioned : possible values - Agent / Supervisor / Customer');
    47. 

  47.         }
    48. 

  48.         if(isset($attributes['maxDuration']) and ($attributes['maxDuration'] < 300 or $attributes['maxDuration'] > 28800)){
    49. 

  49.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['maxDuration']. ' for maxDuration');
    50. 

  50.         }
    51. 

  51.         elseif (!isset($attributes['maxDuration'])){
    52. 

  52.             $attributes['maxDuration'] = 14400;
    53. 

  53.         }
    54. 

  54.         if(isset($attributes['maxParticipants']) and ($attributes['maxParticipants'] < 2 or $attributes['maxParticipants'] > 10)){
    55. 

  55.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['maxParticipants']. ' for maxParticipants');
    56. 

  56.         }
    57. 

  57.         elseif (!isset($attributes['maxParticipants'])){
    58. 

  58.             $attributes['maxParticipants'] = 10;
    59. 

  59.         }
    60. 

  60.         if(isset($attributes['recordMinMemberCount']) and ($attributes['recordMinMemberCount'] < 1 or $attributes['recordMinMemberCount'] > 2)){
    61. 

  61.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['recordMinMemberCount']. ' for recordMinMemberCount');
    62. 

  62.         }
    63. 

  63.         elseif (!isset($attributes['recordMinMemberCount'])){
    64. 

  64.             $attributes['recordMinMemberCount'] = 1;
    65. 

  65.         }
    66. 

  66.         if(isset($attributes['waitMusicMethod']) and !in_array(strtoupper($attributes['waitMusicMethod']), $VALID_METHOD_VALUES, true)){
    67. 

  67.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['waitMusicMethod']. ' for waitMusicMethod');
    68. 

  68.         }
    69. 

  69.         elseif (!isset($attributes['waitMusicMethod'])){
    70. 

  70.             $attributes['waitMusicMethod'] = 'GET';
    71. 

  71.         }
    72. 

  72.         if(isset($attributes['agentHoldMusicMethod']) and !in_array(strtoupper($attributes['agentHoldMusicMethod']), $VALID_METHOD_VALUES, true)){
    73. 

  73.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['agentHoldMusicMethod']. ' for agentHoldMusicMethod');
    74. 

  74.         }
    75. 

  75.         elseif (!isset($attributes['agentHoldMusicMethod'])){
    76. 

  76.             $attributes['agentHoldMusicMethod'] = 'GET';
    77. 

  77.         }
    78. 

  78.         if(isset($attributes['customerHoldMusicMethod']) and !in_array(strtoupper($attributes['customerHoldMusicMethod']), $VALID_METHOD_VALUES, true)){
    79. 

  79.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['customerHoldMusicMethod']. ' for customerHoldMusicMethod');
    80. 

  80.         }
    81. 

  81.         elseif (!isset($attributes['customerHoldMusicMethod'])){
    82. 

  82.             $attributes['customerHoldMusicMethod'] = 'GET';
    83. 

  83.         }
    84. 

  84.         if(isset($attributes['record']) and is_bool($attributes['record'])){
    85. 

  85.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['record']. ' for record');
    86. 

  86.         }
    87. 

  87.         elseif (!isset($attributes['record'])){
    88. 

  88.             $attributes['record'] = false;
    89. 

  89.         }
    90. 

  90.         if(isset($attributes['recordFileFormat']) and !in_array(strtolower($attributes['recordFileFormat']), $VALID_RECORD_FILE_FORMAT_VALUES, true)){
    91. 

  91.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['recordFileFormat']. ' for recordFileFormat');
    92. 

  92.         }
    93. 

  93.         elseif (!isset($attributes['recordFileFormat'])){
    94. 

  94.             $attributes['recordFileFormat'] = 'mp3';
    95. 

  95.         }
    96. 

  96.         if(isset($attributes['recordingCallbackMethod']) and !in_array(strtoupper($attributes['recordingCallbackMethod']), $VALID_METHOD_VALUES, true)){
    97. 

  97.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['recordingCallbackMethod']. ' for recordingCallbackMethod');
    98. 

  98.         }
    99. 

  99.         elseif (!isset($attributes['recordingCallbackMethod'])){
    100. 

  100.             $attributes['recordingCallbackMethod'] = 'GET';
    101. 

  101.         }
    102. 

  102.         if(isset($attributes['statusCallbackEvents']) and !MPCUtils::multiValidParam('statusCallbackEvents', $attributes['statusCallbackEvents'], ['string'], false, ['mpc-state-changes', 'participant-state-changes', 'participant-speak-events', 'participant-digit-input-events', 'add-participant-api-events'], true,',')){
    103. 

  103.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['statusCallbackEvents']. ' for statusCallbackEvents');
    104. 

  104.         }
    105. 

  105.         elseif (!isset($attributes['statusCallbackEvents'])){
    106. 

  106.             $attributes['statusCallbackEvents'] = 'mpc-state-changes,participant-state-changes';
    107. 

  107.         }
    108. 

  108.         if(isset($attributes['statusCallbackMethod']) and !in_array(strtoupper($attributes['statusCallbackMethod']), $VALID_METHOD_VALUES, true)){
    109. 

  109.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['statusCallbackMethod']. ' for statusCallbackMethod');
    110. 

  110.         }
    111. 

  111.         elseif (!isset($attributes['statusCallbackMethod'])){
    112. 

  112.             $attributes['statusCallbackMethod'] = 'POST';
    113. 

  113.         }
    114. 

  114.         if(isset($attributes['stayAlone']) and is_bool($attributes['stayAlone'])){
    115. 

  115.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['stayAlone']. ' for stayAlone');
    116. 

  116.         }
    117. 

  117.         elseif (!isset($attributes['stayAlone'])){
    118. 

  118.             $attributes['stayAlone'] = false;
    119. 

  119.         }
    120. 

  120.         if(isset($attributes['coachMode']) and is_bool($attributes['coachMode'])){
    121. 

  121.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['coachMode']. ' for coachMode');
    122. 

  122.         }
    123. 

  123.         elseif (!isset($attributes['coachMode'])){
    124. 

  124.             $attributes['coachMode'] = true;
    125. 

  125.         }
    126. 

  126.         if(isset($attributes['mute']) and is_bool($attributes['mute'])){
    127. 

  127.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['mute']. ' for mute');
    128. 

  128.         }
    129. 

  129.         elseif (!isset($attributes['mute'])){
    130. 

  130.             $attributes['mute'] = false;
    131. 

  131.         }
    132. 

  132.         if(isset($attributes['hold']) and is_bool($attributes['hold'])){
    133. 

  133.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['hold']. ' for hold');
    134. 

  134.         }
    135. 

  135.         elseif (!isset($attributes['hold'])){
    136. 

  136.             $attributes['hold'] = false;
    137. 

  137.         }
    138. 

  138.         if(isset($attributes['startMpcOnEnter']) and is_bool($attributes['startMpcOnEnter'])){
    139. 

  139.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['startMpcOnEnter']. ' for startMpcOnEnter');
    140. 

  140.         }
    141. 

  141.         elseif (!isset($attributes['startMpcOnEnter'])){
    142. 

  142.             $attributes['startMpcOnEnter'] = true;
    143. 

  143.         }
    144. 

  144.         if(isset($attributes['endMpcOnExit']) and is_bool($attributes['endMpcOnExit'])){
    145. 

  145.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['endMpcOnExit']. ' for endMpcOnExit');
    146. 

  146.         }
    147. 

  147.         elseif (!isset($attributes['endMpcOnExit'])){
    148. 

  148.             $attributes['endMpcOnExit'] = false;
    149. 

  149.         }
    150. 

  150.         if(isset($attributes['enterSound']) and !MPCUtils::isOneAmongStringUrl('enterSound', $attributes['enterSound'], false, ['beep:1', 'beep:2', 'none'])){
    151. 

  151.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['enterSound']. ' for enterSound');
    152. 

  152.         }
    153. 

  153.         elseif (!isset($attributes['enterSound'])){
    154. 

  154.             $attributes['enterSound'] = 'beep:1';
    155. 

  155.         }
    156. 

  156.         if(isset($attributes['enterSoundMethod']) and !in_array(strtoupper($attributes['enterSoundMethod']), $VALID_METHOD_VALUES, true)){
    157. 

  157.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['enterSoundMethod']. ' for enterSoundMethod');
    158. 

  158.         }
    159. 

  159.         elseif (!isset($attributes['enterSoundMethod'])){
    160. 

  160.             $attributes['enterSoundMethod'] = 'GET';
    161. 

  161.         }
    162. 

  162.         if(isset($attributes['exitSound']) and !MPCUtils::isOneAmongStringUrl('exitSound', $attributes['exitSound'], false, ['beep:1', 'beep:2', 'none'])){
    163. 

  163.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['exitSound']. ' for exitSound');
    164. 

  164.         }
    165. 

  165.         elseif (!isset($attributes['exitSound'])){
    166. 

  166.             $attributes['exitSound'] = 'beep:2';
    167. 

  167.         }
    168. 

  168.         if(isset($attributes['exitSoundMethod']) and !in_array(strtoupper($attributes['exitSoundMethod']), $VALID_METHOD_VALUES, true)){
    169. 

  169.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['exitSoundMethod']. ' for exitSoundMethod');
    170. 

  170.         }
    171. 

  171.         elseif (!isset($attributes['exitSoundMethod'])){
    172. 

  172.             $attributes['exitSoundMethod'] = 'GET';
    173. 

  173.         }
    174. 

  174.         if(isset($attributes['onExitActionMethod']) and !in_array(strtoupper($attributes['onExitActionMethod']), $VALID_METHOD_VALUES, true)){
    175. 

  175.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['onExitActionMethod']. ' for onExitActionMethod');
    176. 

  176.         }
    177. 

  177.         elseif (!isset($attributes['onExitActionMethod'])){
    178. 

  178.             $attributes['onExitActionMethod'] = 'POST';
    179. 

  179.         }
    180. 

  180.         if(isset($attributes['relayDTMFInputs']) and is_bool($attributes['relayDTMFInputs'])){
    181. 

  181.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['relayDTMFInputs']. ' for relayDTMFInputs');
    182. 

  182.         }
    183. 

  183.         elseif (!isset($attributes['relayDTMFInputs'])){
    184. 

  184.             $attributes['relayDTMFInputs'] = false;
    185. 

  185.         }
    186. 

  186.         if(isset($attributes['waitMusicUrl']) and !MPCUtils::validUrl('waitMusicUrl', $attributes['waitMusicUrl'], false)){
    187. 

  187.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['waitMusicUrl']. ' for waitMusicUrl');
    188. 

  188.         }
    189. 

  189.         if(isset($attributes['agentHoldMusicUrl']) and !MPCUtils::validUrl('agentHoldMusicUrl', $attributes['agentHoldMusicUrl'], false)){
    190. 

  190.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['agentHoldMusicUrl']. ' for agentHoldMusicUrl');
    191. 

  191.         }
    192. 

  192.         if(isset($attributes['customerHoldMusicUrl']) and !MPCUtils::validUrl('customerHoldMusicUrl', $attributes['customerHoldMusicUrl'], false)){
    193. 

  193.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['customerHoldMusicUrl']. ' for customerHoldMusicUrl');
    194. 

  194.         }
    195. 

  195.         if(isset($attributes['recordingCallbackUrl']) and !MPCUtils::validUrl('recordingCallbackUrl', $attributes['recordingCallbackUrl'], false)){
    196. 

  196.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['recordingCallbackUrl']. ' for recordingCallbackUrl');
    197. 

  197.         }
    198. 

  198.         if(isset($attributes['statusCallbackUrl']) and !MPCUtils::validUrl('statusCallbackUrl', $attributes['statusCallbackUrl'], false)){
    199. 

  199.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['statusCallbackUrl']. ' for statusCallbackUrl');
    200. 

  200.         }
    201. 

  201.         if(isset($attributes['onExitActionUrl']) and !MPCUtils::validUrl('onExitActionUrl', $attributes['onExitActionUrl'], false)){
    202. 

  202.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['onExitActionUrl']. ' for onExitActionUrl');
    203. 

  203.         }
    204. 

  204.         if(isset($attributes['startRecordingAudio']) and !MPCUtils::validUrl('startRecordingAudio', $attributes['startRecordingAudio'], false)){
    205. 

  205.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['startRecordingAudio']. ' for startRecordingAudio');
    206. 

  206.         }
    207. 

  207.         if(isset($attributes['stopRecordingAudio']) and !MPCUtils::validUrl('stopRecordingAudio', $attributes['stopRecordingAudio'], false)){
    208. 

  208.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['stopRecordingAudio']. ' for stopRecordingAudio');
    209. 

  209.         }
    210. 

  210.         if(isset($attributes['startRecordingAudioMethod']) and !in_array(strtoupper($attributes['startRecordingAudioMethod']), $VALID_METHOD_VALUES, true)){
    211. 

  211.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['startRecordingAudioMethod']. ' for startRecordingAudioMethod');
    212. 

  212.         }
    213. 

  213.         elseif (!isset($attributes['startRecordingAudioMethod'])){
    214. 

  214.             $attributes['startRecordingAudioMethod'] = 'GET';
    215. 

  215.         }
    216. 

  216.         if(isset($attributes['stopRecordingAudioMethod']) and !in_array(strtoupper($attributes['stopRecordingAudioMethod']), $VALID_METHOD_VALUES, true)){
    217. 

  217.             throw new PlivoXMLException('Invalid attribute value ' . $attributes['stopRecordingAudioMethod']. ' for stopRecordingAudioMethod');
    218. 

  218.         }
    219. 

  219.         elseif (!isset($attributes['stopRecordingAudioMethod'])){
    220. 

  220.             $attributes['stopRecordingAudioMethod'] = 'GET';
    221. 

  221.         }
    222. 

  222.     }
    223. 

  223. }
    224.