/package/app/app/clients/php5/KalturaPlugins/KalturaAuditClientPlugin.php

https://github.com/richhl/kalturaCE · PHP · 705 lines · 218 code · 89 blank · 398 comment · 6 complexity · 757c9dbd732bf44c7f184c3faf0e7249 MD5 · raw file

  1. <?php
  2. /**
  3. * @package External
  4. * @subpackage Kaltura
  5. */
  6. require_once(dirname(__FILE__) . "/../KalturaClientBase.php");
  7. require_once(dirname(__FILE__) . "/../KalturaEnums.php");
  8. require_once(dirname(__FILE__) . "/../KalturaTypes.php");
  9. /**
  10. * @package External
  11. * @subpackage Kaltura
  12. */
  13. class KalturaAuditTrailAction
  14. {
  15. const CREATED = "CREATED";
  16. const COPIED = "COPIED";
  17. const CHANGED = "CHANGED";
  18. const DELETED = "DELETED";
  19. const VIEWED = "VIEWED";
  20. const CONTENT_VIEWED = "CONTENT_VIEWED";
  21. const FILE_SYNC_CREATED = "FILE_SYNC_CREATED";
  22. const RELATION_ADDED = "RELATION_ADDED";
  23. const RELATION_REMOVED = "RELATION_REMOVED";
  24. }
  25. /**
  26. * @package External
  27. * @subpackage Kaltura
  28. */
  29. class KalturaAuditTrailContext
  30. {
  31. const CLIENT = -1;
  32. const SCRIPT = 0;
  33. const PS2 = 1;
  34. const API_V3 = 2;
  35. }
  36. /**
  37. * @package External
  38. * @subpackage Kaltura
  39. */
  40. class KalturaAuditTrailObjectType
  41. {
  42. const ACCESS_CONTROL = "accessControl";
  43. const ADMIN_KUSER = "adminKuser";
  44. const BATCH_JOB = "BatchJob";
  45. const CATEGORY = "category";
  46. const CONVERSION_PROFILE_2 = "conversionProfile2";
  47. const EMAIL_INGESTION_PROFILE = "EmailIngestionProfile";
  48. const ENTRY = "entry";
  49. const FILE_SYNC = "FileSync";
  50. const FLAVOR_ASSET = "flavorAsset";
  51. const FLAVOR_PARAMS = "flavorParams";
  52. const FLAVOR_PARAMS_CONVERSION_PROFILE = "flavorParamsConversionProfile";
  53. const FLAVOR_PARAMS_OUTPUT = "flavorParamsOutput";
  54. const KSHOW = "kshow";
  55. const KSHOW_KUSER = "KshowKuser";
  56. const KUSER = "kuser";
  57. const MEDIA_INFO = "mediaInfo";
  58. const MODERATION = "moderation";
  59. const PARTNER = "Partner";
  60. const ROUGHCUT = "roughcutEntry";
  61. const SYNDICATION = "syndicationFeed";
  62. const UI_CONF = "uiConf";
  63. const UPLOAD_TOKEN = "UploadToken";
  64. const WIDGET = "widget";
  65. const METADATA = "Metadata";
  66. const METADATA_PROFILE = "MetadataProfile";
  67. const USER_LOGIN_DATA = "UserLoginData";
  68. const USER_ROLE = "UserRole";
  69. const PERMISSION = "Permission";
  70. }
  71. /**
  72. * @package External
  73. * @subpackage Kaltura
  74. */
  75. class KalturaAuditTrailOrderBy
  76. {
  77. const CREATED_AT_ASC = "+createdAt";
  78. const CREATED_AT_DESC = "-createdAt";
  79. const PARSED_AT_ASC = "+parsedAt";
  80. const PARSED_AT_DESC = "-parsedAt";
  81. }
  82. /**
  83. * @package External
  84. * @subpackage Kaltura
  85. */
  86. class KalturaAuditTrailStatus
  87. {
  88. const PENDING = 1;
  89. const READY = 2;
  90. const FAILED = 3;
  91. }
  92. /**
  93. * @package External
  94. * @subpackage Kaltura
  95. */
  96. abstract class KalturaAuditTrailBaseFilter extends KalturaFilter
  97. {
  98. /**
  99. *
  100. *
  101. * @var int
  102. */
  103. public $idEqual = null;
  104. /**
  105. *
  106. *
  107. * @var int
  108. */
  109. public $createdAtGreaterThanOrEqual = null;
  110. /**
  111. *
  112. *
  113. * @var int
  114. */
  115. public $createdAtLessThanOrEqual = null;
  116. /**
  117. *
  118. *
  119. * @var int
  120. */
  121. public $parsedAtGreaterThanOrEqual = null;
  122. /**
  123. *
  124. *
  125. * @var int
  126. */
  127. public $parsedAtLessThanOrEqual = null;
  128. /**
  129. *
  130. *
  131. * @var KalturaAuditTrailStatus
  132. */
  133. public $statusEqual = null;
  134. /**
  135. *
  136. *
  137. * @var string
  138. */
  139. public $statusIn = null;
  140. /**
  141. *
  142. *
  143. * @var KalturaAuditTrailObjectType
  144. */
  145. public $auditObjectTypeEqual = null;
  146. /**
  147. *
  148. *
  149. * @var string
  150. */
  151. public $auditObjectTypeIn = null;
  152. /**
  153. *
  154. *
  155. * @var string
  156. */
  157. public $objectIdEqual = null;
  158. /**
  159. *
  160. *
  161. * @var string
  162. */
  163. public $objectIdIn = null;
  164. /**
  165. *
  166. *
  167. * @var string
  168. */
  169. public $relatedObjectIdEqual = null;
  170. /**
  171. *
  172. *
  173. * @var string
  174. */
  175. public $relatedObjectIdIn = null;
  176. /**
  177. *
  178. *
  179. * @var KalturaAuditTrailObjectType
  180. */
  181. public $relatedObjectTypeEqual = null;
  182. /**
  183. *
  184. *
  185. * @var string
  186. */
  187. public $relatedObjectTypeIn = null;
  188. /**
  189. *
  190. *
  191. * @var string
  192. */
  193. public $entryIdEqual = null;
  194. /**
  195. *
  196. *
  197. * @var string
  198. */
  199. public $entryIdIn = null;
  200. /**
  201. *
  202. *
  203. * @var int
  204. */
  205. public $masterPartnerIdEqual = null;
  206. /**
  207. *
  208. *
  209. * @var string
  210. */
  211. public $masterPartnerIdIn = null;
  212. /**
  213. *
  214. *
  215. * @var int
  216. */
  217. public $partnerIdEqual = null;
  218. /**
  219. *
  220. *
  221. * @var string
  222. */
  223. public $partnerIdIn = null;
  224. /**
  225. *
  226. *
  227. * @var string
  228. */
  229. public $requestIdEqual = null;
  230. /**
  231. *
  232. *
  233. * @var string
  234. */
  235. public $requestIdIn = null;
  236. /**
  237. *
  238. *
  239. * @var string
  240. */
  241. public $userIdEqual = null;
  242. /**
  243. *
  244. *
  245. * @var string
  246. */
  247. public $userIdIn = null;
  248. /**
  249. *
  250. *
  251. * @var KalturaAuditTrailAction
  252. */
  253. public $actionEqual = null;
  254. /**
  255. *
  256. *
  257. * @var string
  258. */
  259. public $actionIn = null;
  260. /**
  261. *
  262. *
  263. * @var string
  264. */
  265. public $ksEqual = null;
  266. /**
  267. *
  268. *
  269. * @var KalturaAuditTrailContext
  270. */
  271. public $contextEqual = null;
  272. /**
  273. *
  274. *
  275. * @var string
  276. */
  277. public $contextIn = null;
  278. /**
  279. *
  280. *
  281. * @var string
  282. */
  283. public $entryPointEqual = null;
  284. /**
  285. *
  286. *
  287. * @var string
  288. */
  289. public $entryPointIn = null;
  290. /**
  291. *
  292. *
  293. * @var string
  294. */
  295. public $serverNameEqual = null;
  296. /**
  297. *
  298. *
  299. * @var string
  300. */
  301. public $serverNameIn = null;
  302. /**
  303. *
  304. *
  305. * @var string
  306. */
  307. public $ipAddressEqual = null;
  308. /**
  309. *
  310. *
  311. * @var string
  312. */
  313. public $ipAddressIn = null;
  314. /**
  315. *
  316. *
  317. * @var string
  318. */
  319. public $clientTagEqual = null;
  320. }
  321. /**
  322. * @package External
  323. * @subpackage Kaltura
  324. */
  325. class KalturaAuditTrailFilter extends KalturaAuditTrailBaseFilter
  326. {
  327. }
  328. /**
  329. * @package External
  330. * @subpackage Kaltura
  331. */
  332. abstract class KalturaAuditTrailInfo extends KalturaObjectBase
  333. {
  334. }
  335. /**
  336. * @package External
  337. * @subpackage Kaltura
  338. */
  339. class KalturaAuditTrail extends KalturaObjectBase
  340. {
  341. /**
  342. *
  343. *
  344. * @var int
  345. * @readonly
  346. */
  347. public $id = null;
  348. /**
  349. *
  350. *
  351. * @var int
  352. * @readonly
  353. */
  354. public $createdAt = null;
  355. /**
  356. * Indicates when the data was parsed
  357. *
  358. * @var int
  359. * @readonly
  360. */
  361. public $parsedAt = null;
  362. /**
  363. *
  364. *
  365. * @var KalturaAuditTrailStatus
  366. * @readonly
  367. */
  368. public $status = null;
  369. /**
  370. *
  371. *
  372. * @var KalturaAuditTrailObjectType
  373. */
  374. public $auditObjectType = null;
  375. /**
  376. *
  377. *
  378. * @var string
  379. */
  380. public $objectId = null;
  381. /**
  382. *
  383. *
  384. * @var string
  385. */
  386. public $relatedObjectId = null;
  387. /**
  388. *
  389. *
  390. * @var KalturaAuditTrailObjectType
  391. */
  392. public $relatedObjectType = null;
  393. /**
  394. *
  395. *
  396. * @var string
  397. */
  398. public $entryId = null;
  399. /**
  400. *
  401. *
  402. * @var int
  403. * @readonly
  404. */
  405. public $masterPartnerId = null;
  406. /**
  407. *
  408. *
  409. * @var int
  410. * @readonly
  411. */
  412. public $partnerId = null;
  413. /**
  414. *
  415. *
  416. * @var string
  417. * @readonly
  418. */
  419. public $requestId = null;
  420. /**
  421. *
  422. *
  423. * @var string
  424. */
  425. public $userId = null;
  426. /**
  427. *
  428. *
  429. * @var KalturaAuditTrailAction
  430. */
  431. public $action = null;
  432. /**
  433. *
  434. *
  435. * @var KalturaAuditTrailInfo
  436. */
  437. public $data;
  438. /**
  439. *
  440. *
  441. * @var string
  442. * @readonly
  443. */
  444. public $ks = null;
  445. /**
  446. *
  447. *
  448. * @var KalturaAuditTrailContext
  449. * @readonly
  450. */
  451. public $context = null;
  452. /**
  453. * The API service and action that called and caused this audit
  454. *
  455. * @var string
  456. * @readonly
  457. */
  458. public $entryPoint = null;
  459. /**
  460. *
  461. *
  462. * @var string
  463. * @readonly
  464. */
  465. public $serverName = null;
  466. /**
  467. *
  468. *
  469. * @var string
  470. * @readonly
  471. */
  472. public $ipAddress = null;
  473. /**
  474. *
  475. *
  476. * @var string
  477. * @readonly
  478. */
  479. public $userAgent = null;
  480. /**
  481. *
  482. *
  483. * @var string
  484. */
  485. public $clientTag = null;
  486. /**
  487. *
  488. *
  489. * @var string
  490. */
  491. public $description = null;
  492. /**
  493. *
  494. *
  495. * @var string
  496. * @readonly
  497. */
  498. public $errorDescription = null;
  499. }
  500. /**
  501. * @package External
  502. * @subpackage Kaltura
  503. */
  504. class KalturaAuditTrailListResponse extends KalturaObjectBase
  505. {
  506. /**
  507. *
  508. *
  509. * @var array of KalturaAuditTrail
  510. * @readonly
  511. */
  512. public $objects;
  513. /**
  514. *
  515. *
  516. * @var int
  517. * @readonly
  518. */
  519. public $totalCount = null;
  520. }
  521. /**
  522. * @package External
  523. * @subpackage Kaltura
  524. */
  525. class KalturaAuditTrailService extends KalturaServiceBase
  526. {
  527. function __construct(KalturaClient $client = null)
  528. {
  529. parent::__construct($client);
  530. }
  531. function listAction(KalturaAuditTrailFilter $filter = null, KalturaFilterPager $pager = null)
  532. {
  533. $kparams = array();
  534. if ($filter !== null)
  535. $this->client->addParam($kparams, "filter", $filter->toParams());
  536. if ($pager !== null)
  537. $this->client->addParam($kparams, "pager", $pager->toParams());
  538. $this->client->queueServiceActionCall("audit_audittrail", "list", $kparams);
  539. if ($this->client->isMultiRequest())
  540. return null;
  541. $resultObject = $this->client->doQueue();
  542. $this->client->throwExceptionIfError($resultObject);
  543. $this->client->validateObjectType($resultObject, "KalturaAuditTrailListResponse");
  544. return $resultObject;
  545. }
  546. function add(KalturaAuditTrail $auditTrail)
  547. {
  548. $kparams = array();
  549. $this->client->addParam($kparams, "auditTrail", $auditTrail->toParams());
  550. $this->client->queueServiceActionCall("audit_audittrail", "add", $kparams);
  551. if ($this->client->isMultiRequest())
  552. return null;
  553. $resultObject = $this->client->doQueue();
  554. $this->client->throwExceptionIfError($resultObject);
  555. $this->client->validateObjectType($resultObject, "KalturaAuditTrail");
  556. return $resultObject;
  557. }
  558. function get($id)
  559. {
  560. $kparams = array();
  561. $this->client->addParam($kparams, "id", $id);
  562. $this->client->queueServiceActionCall("audit_audittrail", "get", $kparams);
  563. if ($this->client->isMultiRequest())
  564. return null;
  565. $resultObject = $this->client->doQueue();
  566. $this->client->throwExceptionIfError($resultObject);
  567. $this->client->validateObjectType($resultObject, "KalturaAuditTrail");
  568. return $resultObject;
  569. }
  570. }
  571. /**
  572. * @package External
  573. * @subpackage Kaltura
  574. */
  575. class KalturaAuditClientPlugin extends KalturaClientPlugin
  576. {
  577. /**
  578. * @var KalturaClientPlugin
  579. */
  580. protected static $instance;
  581. /**
  582. * @var KalturaAuditTrailService
  583. */
  584. public $auditTrail = null;
  585. protected function __construct(KalturaClient $client)
  586. {
  587. parent::__construct($client);
  588. $this->auditTrail = new KalturaAuditTrailService($client);
  589. }
  590. /**
  591. * @return KalturaClientPlugin
  592. */
  593. public static function get(KalturaClient $client)
  594. {
  595. if(!self::$instance)
  596. self::$instance = new KalturaAuditClientPlugin($client);
  597. return self::$instance;
  598. }
  599. /**
  600. * @return array<KalturaServiceBase>
  601. */
  602. public function getServices()
  603. {
  604. $services = array(
  605. 'auditTrail' => $this->auditTrail,
  606. );
  607. return $services;
  608. }
  609. /**
  610. * @return string
  611. */
  612. public function getName()
  613. {
  614. return 'audit';
  615. }
  616. }