/Classes/Kaltura/KalturaPlugins/KalturaDocumentClientPlugin.php
https://bitbucket.org/pixelant/kaltura · PHP · 467 lines · 315 code · 82 blank · 70 comment · 16 complexity · 6544d20ad5f0172f4de843a105ad893e MD5 · raw file
- <?php
- require_once(dirname(__FILE__) . "/../KalturaClientBase.php");
- require_once(dirname(__FILE__) . "/../KalturaEnums.php");
- require_once(dirname(__FILE__) . "/../KalturaTypes.php");
- class KalturaDocumentEntryOrderBy
- {
- const NAME_ASC = "+name";
- const NAME_DESC = "-name";
- const MODERATION_COUNT_ASC = "+moderationCount";
- const MODERATION_COUNT_DESC = "-moderationCount";
- const CREATED_AT_ASC = "+createdAt";
- const CREATED_AT_DESC = "-createdAt";
- const UPDATED_AT_ASC = "+updatedAt";
- const UPDATED_AT_DESC = "-updatedAt";
- const RANK_ASC = "+rank";
- const RANK_DESC = "-rank";
- const START_DATE_ASC = "+startDate";
- const START_DATE_DESC = "-startDate";
- const END_DATE_ASC = "+endDate";
- const END_DATE_DESC = "-endDate";
- const PARTNER_SORT_VALUE_ASC = "+partnerSortValue";
- const PARTNER_SORT_VALUE_DESC = "-partnerSortValue";
- }
- class KalturaDocumentFlavorParamsOrderBy
- {
- }
- class KalturaDocumentFlavorParamsOutputOrderBy
- {
- }
- class KalturaDocumentType
- {
- const DOCUMENT = 11;
- const SWF = 12;
- const PDF = 13;
- }
- class KalturaPdfFlavorParamsOrderBy
- {
- }
- class KalturaPdfFlavorParamsOutputOrderBy
- {
- }
- class KalturaSwfFlavorParamsOrderBy
- {
- }
- class KalturaSwfFlavorParamsOutputOrderBy
- {
- }
- class KalturaDocumentEntry extends KalturaBaseEntry
- {
- /**
- * The type of the document
- *
- * @var KalturaDocumentType
- * @insertonly
- */
- public $documentType = null;
- /**
- * Comma separated asset params ids that exists for this media entry
- *
- *
- * @var string
- * @readonly
- */
- public $assetParamsIds = null;
- }
- abstract class KalturaDocumentEntryBaseFilter extends KalturaBaseEntryFilter
- {
- /**
- *
- *
- * @var KalturaDocumentType
- */
- public $documentTypeEqual = null;
- /**
- *
- *
- * @var string
- */
- public $documentTypeIn = null;
- /**
- *
- *
- * @var string
- */
- public $assetParamsIdsMatchOr = null;
- /**
- *
- *
- * @var string
- */
- public $assetParamsIdsMatchAnd = null;
- }
- class KalturaDocumentEntryFilter extends KalturaDocumentEntryBaseFilter
- {
- }
- class KalturaDocumentListResponse extends KalturaObjectBase
- {
- /**
- *
- *
- * @var array of KalturaDocumentEntry
- * @readonly
- */
- public $objects;
- /**
- *
- *
- * @var int
- * @readonly
- */
- public $totalCount = null;
- }
- abstract class KalturaDocumentFlavorParamsBaseFilter extends KalturaFlavorParamsFilter
- {
- }
- abstract class KalturaDocumentFlavorParamsOutputBaseFilter extends KalturaFlavorParamsOutputFilter
- {
- }
- abstract class KalturaPdfFlavorParamsBaseFilter extends KalturaFlavorParamsFilter
- {
- }
- abstract class KalturaPdfFlavorParamsOutputBaseFilter extends KalturaFlavorParamsOutputFilter
- {
- }
- abstract class KalturaSwfFlavorParamsBaseFilter extends KalturaFlavorParamsFilter
- {
- }
- abstract class KalturaSwfFlavorParamsOutputBaseFilter extends KalturaFlavorParamsOutputFilter
- {
- }
- class KalturaDocumentFlavorParamsFilter extends KalturaDocumentFlavorParamsBaseFilter
- {
- }
- class KalturaDocumentFlavorParamsOutputFilter extends KalturaDocumentFlavorParamsOutputBaseFilter
- {
- }
- class KalturaPdfFlavorParamsFilter extends KalturaPdfFlavorParamsBaseFilter
- {
- }
- class KalturaPdfFlavorParamsOutputFilter extends KalturaPdfFlavorParamsOutputBaseFilter
- {
- }
- class KalturaSwfFlavorParamsFilter extends KalturaSwfFlavorParamsBaseFilter
- {
- }
- class KalturaSwfFlavorParamsOutputFilter extends KalturaSwfFlavorParamsOutputBaseFilter
- {
- }
- class KalturaDocumentFlavorParamsOutput extends KalturaFlavorParamsOutput
- {
- }
- class KalturaDocumentFlavorParams extends KalturaFlavorParams
- {
- }
- class KalturaPdfFlavorParamsOutput extends KalturaFlavorParamsOutput
- {
- /**
- *
- *
- * @var bool
- */
- public $readonly = null;
- }
- class KalturaPdfFlavorParams extends KalturaFlavorParams
- {
- /**
- *
- *
- * @var bool
- */
- public $readonly = null;
- }
- class KalturaSwfFlavorParamsOutput extends KalturaFlavorParamsOutput
- {
- }
- class KalturaSwfFlavorParams extends KalturaFlavorParams
- {
- }
- class KalturaDocumentsService extends KalturaServiceBase
- {
- function __construct(KalturaClient $client = null)
- {
- parent::__construct($client);
- }
- function addFromUploadedFile(KalturaDocumentEntry $documentEntry, $uploadTokenId)
- {
- $kparams = array();
- $this->client->addParam($kparams, "documentEntry", $documentEntry->toParams());
- $this->client->addParam($kparams, "uploadTokenId", $uploadTokenId);
- $this->client->queueServiceActionCall("document_documents", "addFromUploadedFile", $kparams);
- if ($this->client->isMultiRequest())
- return $this->client->getMultiRequestResult();
- $resultObject = $this->client->doQueue();
- $this->client->throwExceptionIfError($resultObject);
- $this->client->validateObjectType($resultObject, "KalturaDocumentEntry");
- return $resultObject;
- }
- function addFromEntry($sourceEntryId, KalturaDocumentEntry $documentEntry = null, $sourceFlavorParamsId = null)
- {
- $kparams = array();
- $this->client->addParam($kparams, "sourceEntryId", $sourceEntryId);
- if ($documentEntry !== null)
- $this->client->addParam($kparams, "documentEntry", $documentEntry->toParams());
- $this->client->addParam($kparams, "sourceFlavorParamsId", $sourceFlavorParamsId);
- $this->client->queueServiceActionCall("document_documents", "addFromEntry", $kparams);
- if ($this->client->isMultiRequest())
- return $this->client->getMultiRequestResult();
- $resultObject = $this->client->doQueue();
- $this->client->throwExceptionIfError($resultObject);
- $this->client->validateObjectType($resultObject, "KalturaDocumentEntry");
- return $resultObject;
- }
- function addFromFlavorAsset($sourceFlavorAssetId, KalturaDocumentEntry $documentEntry = null)
- {
- $kparams = array();
- $this->client->addParam($kparams, "sourceFlavorAssetId", $sourceFlavorAssetId);
- if ($documentEntry !== null)
- $this->client->addParam($kparams, "documentEntry", $documentEntry->toParams());
- $this->client->queueServiceActionCall("document_documents", "addFromFlavorAsset", $kparams);
- if ($this->client->isMultiRequest())
- return $this->client->getMultiRequestResult();
- $resultObject = $this->client->doQueue();
- $this->client->throwExceptionIfError($resultObject);
- $this->client->validateObjectType($resultObject, "KalturaDocumentEntry");
- return $resultObject;
- }
- function convert($entryId, $conversionProfileId = null, array $dynamicConversionAttributes = null)
- {
- $kparams = array();
- $this->client->addParam($kparams, "entryId", $entryId);
- $this->client->addParam($kparams, "conversionProfileId", $conversionProfileId);
- if ($dynamicConversionAttributes !== null)
- foreach($dynamicConversionAttributes as $index => $obj)
- {
- $this->client->addParam($kparams, "dynamicConversionAttributes:$index", $obj->toParams());
- }
- $this->client->queueServiceActionCall("document_documents", "convert", $kparams);
- if ($this->client->isMultiRequest())
- return $this->client->getMultiRequestResult();
- $resultObject = $this->client->doQueue();
- $this->client->throwExceptionIfError($resultObject);
- $this->client->validateObjectType($resultObject, "integer");
- return $resultObject;
- }
- function get($entryId, $version = -1)
- {
- $kparams = array();
- $this->client->addParam($kparams, "entryId", $entryId);
- $this->client->addParam($kparams, "version", $version);
- $this->client->queueServiceActionCall("document_documents", "get", $kparams);
- if ($this->client->isMultiRequest())
- return $this->client->getMultiRequestResult();
- $resultObject = $this->client->doQueue();
- $this->client->throwExceptionIfError($resultObject);
- $this->client->validateObjectType($resultObject, "KalturaDocumentEntry");
- return $resultObject;
- }
- function update($entryId, KalturaDocumentEntry $documentEntry)
- {
- $kparams = array();
- $this->client->addParam($kparams, "entryId", $entryId);
- $this->client->addParam($kparams, "documentEntry", $documentEntry->toParams());
- $this->client->queueServiceActionCall("document_documents", "update", $kparams);
- if ($this->client->isMultiRequest())
- return $this->client->getMultiRequestResult();
- $resultObject = $this->client->doQueue();
- $this->client->throwExceptionIfError($resultObject);
- $this->client->validateObjectType($resultObject, "KalturaDocumentEntry");
- return $resultObject;
- }
- function delete($entryId)
- {
- $kparams = array();
- $this->client->addParam($kparams, "entryId", $entryId);
- $this->client->queueServiceActionCall("document_documents", "delete", $kparams);
- if ($this->client->isMultiRequest())
- return $this->client->getMultiRequestResult();
- $resultObject = $this->client->doQueue();
- $this->client->throwExceptionIfError($resultObject);
- $this->client->validateObjectType($resultObject, "null");
- return $resultObject;
- }
- function listAction(KalturaDocumentEntryFilter $filter = null, KalturaFilterPager $pager = null)
- {
- $kparams = array();
- if ($filter !== null)
- $this->client->addParam($kparams, "filter", $filter->toParams());
- if ($pager !== null)
- $this->client->addParam($kparams, "pager", $pager->toParams());
- $this->client->queueServiceActionCall("document_documents", "list", $kparams);
- if ($this->client->isMultiRequest())
- return $this->client->getMultiRequestResult();
- $resultObject = $this->client->doQueue();
- $this->client->throwExceptionIfError($resultObject);
- $this->client->validateObjectType($resultObject, "KalturaDocumentListResponse");
- return $resultObject;
- }
- function upload($fileData)
- {
- $kparams = array();
- $kfiles = array();
- $this->client->addParam($kfiles, "fileData", $fileData);
- $this->client->queueServiceActionCall("document_documents", "upload", $kparams, $kfiles);
- if ($this->client->isMultiRequest())
- return $this->client->getMultiRequestResult();
- $resultObject = $this->client->doQueue();
- $this->client->throwExceptionIfError($resultObject);
- $this->client->validateObjectType($resultObject, "string");
- return $resultObject;
- }
- function convertPptToSwf($entryId)
- {
- $kparams = array();
- $this->client->addParam($kparams, "entryId", $entryId);
- $this->client->queueServiceActionCall("document_documents", "convertPptToSwf", $kparams);
- if ($this->client->isMultiRequest())
- return $this->client->getMultiRequestResult();
- $resultObject = $this->client->doQueue();
- $this->client->throwExceptionIfError($resultObject);
- $this->client->validateObjectType($resultObject, "string");
- return $resultObject;
- }
- function serve($entryId, $flavorAssetId = null, $forceProxy = false)
- {
- $kparams = array();
- $this->client->addParam($kparams, "entryId", $entryId);
- $this->client->addParam($kparams, "flavorAssetId", $flavorAssetId);
- $this->client->addParam($kparams, "forceProxy", $forceProxy);
- $this->client->queueServiceActionCall('document_documents', 'serve', $kparams);
- $resultObject = $this->client->getServeUrl();
- return $resultObject;
- }
- function serveByFlavorParamsId($entryId, $flavorParamsId = null, $forceProxy = false)
- {
- $kparams = array();
- $this->client->addParam($kparams, "entryId", $entryId);
- $this->client->addParam($kparams, "flavorParamsId", $flavorParamsId);
- $this->client->addParam($kparams, "forceProxy", $forceProxy);
- $this->client->queueServiceActionCall('document_documents', 'serveByFlavorParamsId', $kparams);
- $resultObject = $this->client->getServeUrl();
- return $resultObject;
- }
- }
- class KalturaDocumentClientPlugin extends KalturaClientPlugin
- {
- /**
- * @var KalturaDocumentClientPlugin
- */
- protected static $instance;
- /**
- * @var KalturaDocumentsService
- */
- public $documents = null;
- protected function __construct(KalturaClient $client)
- {
- parent::__construct($client);
- $this->documents = new KalturaDocumentsService($client);
- }
- /**
- * @return KalturaDocumentClientPlugin
- */
- public static function get(KalturaClient $client)
- {
- if(!self::$instance)
- self::$instance = new KalturaDocumentClientPlugin($client);
- return self::$instance;
- }
- /**
- * @return array<KalturaServiceBase>
- */
- public function getServices()
- {
- $services = array(
- 'documents' => $this->documents,
- );
- return $services;
- }
- /**
- * @return string
- */
- public function getName()
- {
- return 'document';
- }
- }