Plat 9889 : Add support in eSearch aggregations

plugins/search/providers/elastic_search/lib/api/enum/KalturaESearchCategoryAggregateByFieldName.php

@@ -0,0 +1,10 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.enum
+ */
+
+class KalturaESearchCategoryAggregateByFieldName extends KalturaStringEnum
+{
+	const CATEGORY_NAME = 'category_name';
+}

plugins/search/providers/elastic_search/lib/api/enum/KalturaESearchCuePointAggregateByFieldName.php

@@ -0,0 +1,11 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.enum
+ */
+
+class KalturaESearchCuePointAggregateByFieldName extends KalturaStringEnum
+{
+	const TAGS = 'tags';
+	const TYPE = 'type';
+}

plugins/search/providers/elastic_search/lib/api/enum/KalturaESearchEntryAggregateByFieldName.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.enum
+ */
+
+class KalturaESearchEntryAggregateByFieldName extends KalturaStringEnum
+{
+	const ENTRY_TYPE = 'entry_type';
+	const MEDIA_TYPE = 'media_type';
+	const TAGS = 'tags';
+	const ACCESS_CONTROL_PROFILE = 'access_control_profile_id';
+}

plugins/search/providers/elastic_search/lib/api/enum/KalturaESearchMetadataAggregateByFieldName.php

@@ -0,0 +1,10 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.enum
+ */
+
+class KalturaESearchMetadataAggregateByFieldName extends KalturaStringEnum
+{
+
+}

plugins/search/providers/elastic_search/lib/api/types/KalturaESearchEntryParams.php

@@ -10,9 +10,15 @@ class KalturaESearchEntryParams extends KalturaESearchParams
 	 */
 	public $searchOperator;
 
+	/**
+	 * @var KalturaESearchAggregation
+	 */
+	public $aggregations;
+
+
 	private static $mapBetweenObjects = array
 	(
-		"searchOperator",
+		"searchOperator","aggregations"
 	);
 
 	protected function initStatuses()

plugins/search/providers/elastic_search/lib/api/types/KalturaESearchParams.php

@@ -20,11 +20,12 @@ abstract class KalturaESearchParams extends KalturaObject
 	 */
 	public $orderBy;
 
+
 	private static $mapBetweenObjects = array
 	(
 		"objectStatuses",
 		"objectId",
-		"orderBy",
+		"orderBy"
 	);
 
 	public function getMapBetweenObjects()

plugins/search/providers/elastic_search/lib/api/types/aggregations/KalturaESearchAggregation.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.objects
+ */
+
+class KalturaESearchAggregation extends KalturaObject
+{
+	/**
+	 *  @var KalturaESearchAggregationsArray
+	 */
+	public $aggregations;
+
+	private static $map_between_objects = array(
+		'aggregations',
+	);
+
+	public function getMapBetweenObjects()
+	{
+		return array_merge(parent::getMapBetweenObjects(), self::$map_between_objects);
+	}
+
+	public function toObject($object_to_fill = null, $props_to_skip = array())
+	{
+		if (!$object_to_fill)
+			$object_to_fill = new ESearchAggregations();
+		return parent::toObject($object_to_fill, $props_to_skip);
+	}
+}

plugins/search/providers/elastic_search/lib/api/types/aggregations/errors/KalturaESearchAggregationErrors.php

@@ -0,0 +1,10 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.errors
+ */
+
+class KalturaESearchAggregationErrors extends KalturaESearchErrors
+{
+	const AGGREGATION_FIELD_NAME_MUST_BE_SUPPLIED = 'AGGREGATION_FIELD_NAME_MUST_BE_SUPPLIED;;Aggregation field name must be supplied';
+}

plugins/search/providers/elastic_search/lib/api/types/aggregations/items/KalturaESearchAggregationItem.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.objects
+ */
+
+abstract class KalturaESearchAggregationItem extends KalturaObject
+{
+	/**
+	 *  @var int
+	 */
+	public $size;
+
+	public $fieldName;
+
+	private static $map_between_objects = array(
+		'size',
+		'fieldName'
+	);
+
+	abstract public function getFieldEnumMap();
+
+	public function getMapBetweenObjects()
+	{
+		return array_merge(parent::getMapBetweenObjects(), self::$map_between_objects);
+	}
+
+	public function toObject($object_to_fill = null, $props_to_skip = array())
+	{
+		if($object_to_fill)
+		{
+			$fieldEnumMap = $this->getFieldEnumMap();
+			if (isset($fieldEnumMap[$this->fieldName]))
+			{
+				$coreFieldName = $fieldEnumMap[$this->fieldName];
+				$object_to_fill->setFieldName($coreFieldName);
+				$props_to_skip[] = 'fieldName';
+			}
+		}
+
+		return parent::toObject($object_to_fill, $props_to_skip);
+	}
+
+	abstract public function coreToApiResponse($coreResponse, $fieldName = null);
+
+	public function validateForUsage($sourceObject, $propertiesToSkip = array())
+	{
+		if(is_null($this->fieldName))
+		{
+			throw new KalturaAPIException(KalturaESearchAggregationErrors::AGGREGATION_FIELD_NAME_MUST_BE_SUPPLIED);
+		}
+		parent::validateForUsage($sourceObject, $propertiesToSkip);
+	}
+}

plugins/search/providers/elastic_search/lib/api/types/aggregations/items/KalturaESearchAggregationsArray.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.objects
+ */
+
+class KalturaESearchAggregationsArray extends KalturaTypedArray
+{
+	public function __construct()
+	{
+		return parent::__construct("KalturaESearchAggregationItem");
+	}
+}

plugins/search/providers/elastic_search/lib/api/types/aggregations/items/KalturaESearchCategoryAggregationItem.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.objects
+ */
+
+
+class KalturaESearchCategoryAggregationItem extends KalturaESearchAggregationItem
+{
+	/**
+	 *  @var KalturaESearchCategoryAggregateByFieldName
+	 */
+	public $fieldName;
+
+	public function toObject($object_to_fill = null, $props_to_skip = array())
+	{
+		if (!$object_to_fill)
+		{
+			$object_to_fill = new ESearchCategoryAggregationItem();
+		}
+		return parent::toObject($object_to_fill, $props_to_skip);
+	}
+
+	public function getFieldEnumMap()
+	{
+		return array (KalturaESearchCategoryAggregateByFieldName::CATEGORY_NAME => ESearchCategoryAggregationFieldName::CATEGORY_NAME);
+	}
+
+	public function coreToApiResponse($coreResponse, $fieldName = null)
+	{
+		$agg = new KalturaESearchAggregationResponseItem();
+		$agg->fieldName = $fieldName;
+		$agg->name = ESearchCategoryAggregationItem::KEY;
+		$bucketsArray = new KalturaESearchAggregationBucketsArray();
+		$buckets = $coreResponse[ESearchAggregations::BUCKETS];
+		if ($buckets)
+		{
+			foreach ($buckets as $bucket)
+			{
+				$responseBucket = new KalturaESearchAggregationBucket();
+				$responseBucket->fromArray($bucket);
+				list(,$categoryName) = elasticSearchUtils::reverseFormatCategoryNameStatus($responseBucket->value);
+				$responseBucket->value = $categoryName;
+				$bucketsArray[] = $responseBucket;
+			}
+
+		}
+		$agg->buckets = $bucketsArray;
+		return array($agg);
+	}
+
+}

plugins/search/providers/elastic_search/lib/api/types/aggregations/items/KalturaESearchCuepointsAggregationItem.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.objects
+ */
+
+class KalturaESearchCuepointsAggregationItem extends KalturaESearchAggregationItem
+{
+	/**
+	 *  @var KalturaESearchCuePointAggregateByFieldName
+	 */
+	public $fieldName;
+
+	public function toObject($object_to_fill = null, $props_to_skip = array())
+	{
+		if (!$object_to_fill)
+		{
+			$object_to_fill = new ESearchCuepointsAggregationItem();
+		}
+		return parent::toObject($object_to_fill, $props_to_skip);
+	}
+
+	public function getFieldEnumMap()
+	{
+		return array(
+			KalturaESearchCuePointAggregateByFieldName::TAGS => ESearchCuePointsAggregationFieldName::TAGS,
+			KalturaESearchCuePointAggregateByFieldName::TYPE => ESearchCuePointsAggregationFieldName::TYPE);
+	}
+
+	public function coreToApiResponse($coreResponse, $fieldName = null)
+	{
+		$agg = new KalturaESearchAggregationResponseItem();
+		$agg->fieldName = $fieldName;
+		$agg->name = ESearchCuepointsAggregationItem::KEY;
+
+		$bucketsArray = new KalturaESearchAggregationBucketsArray();
+		$buckets = $coreResponse[ESearchAggregationItem::NESTED_BUCKET][ESearchAggregations::BUCKETS];
+		if ($buckets)
+		{
+			foreach ($buckets as $bucket)
+			{
+				$responseBucket = new KalturaESearchAggregationBucket();
+				$responseBucket->fromArray($bucket);
+				if($fieldName === ESearchCuePointsAggregationFieldName::TYPE)
+				{
+					$responseBucket->value =  kPluginableEnumsManager::coreToApi('CuePointType' ,$responseBucket->value);
+				}
+				$bucketsArray[] = $responseBucket;
+			}
+		}
+		$agg->buckets = $bucketsArray;
+		return array($agg);
+	}
+}

plugins/search/providers/elastic_search/lib/api/types/aggregations/items/KalturaESearchEntryAggregationItem.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * @package plugins.elasticSearch
+ * @subpackage api.objects
+ */
+
+
+class KalturaESearchEntryAggregationItem extends KalturaESearchAggregationItem
+{
+
+	/**
+	 *  @var KalturaESearchEntryAggregateByFieldName
+	 */
+	public $fieldName;
+
+
+	public function toObject($object_to_fill = null, $props_to_skip = array())
+	{
+		if (!$object_to_fill)
+		{
+			$object_to_fill = new ESearchEntryAggregationItem();
+		}
+		return parent::toObject($object_to_fill, $props_to_skip);
+	}
+
+	public function getFieldEnumMap()
+	{
+		return array (
+			KalturaESearchEntryAggregateByFieldName::ENTRY_TYPE => ESearchEntryAggregationFieldName::ENTRY_TYPE,
+			KalturaESearchEntryAggregateByFieldName::MEDIA_TYPE => ESearchEntryAggregationFieldName::MEDIA_TYPE,
+			KalturaESearchEntryAggregateByFieldName::TAGS => ESearchEntryAggregationFieldName::TAGS,
+			KalturaESearchEntryAggregateByFieldName::ACCESS_CONTROL_PROFILE => ESearchEntryAggregationFieldName::ACCESS_CONTROL_PROFILE);
+	}
+
+	public function coreToApiResponse($coreResponse, $fieldName = null)
+	{
+		$agg = new KalturaESearchAggregationResponseItem();
+		$agg->fieldName = $fieldName;
+		$agg->name = ESearchEntryAggregationItem::KEY;
+		$bucketsArray = new KalturaESearchAggregationBucketsArray();
+		$buckets = $coreResponse[ESearchAggregations::BUCKETS];
+		if ($buckets)
+		{
+			foreach ($buckets as $bucket)
+			{
+				$responseBucket = new KalturaESearchAggregationBucket();
+				$responseBucket->fromArray($bucket);
+				$bucketsArray[] = $responseBucket;
+			}
+		}
+		$agg->buckets = $bucketsArray;
+		return array($agg);
+	}
+
+
+}