Automattic\WooCommerce\Admin\API\Reports\Products\Stats

Segmenter::get_segments │ protected │ WC 1.0

Return array of segments formatted for REST response.

Method of the class: Segmenter{}

No Hooks.

Returns

Array.

Usage

// protected - for code of main (parent) or child class
$result = $this->get_segments( $type, $query_params, $table_name );

$type(string) (required)

Type of segments to return--'totals' or 'intervals'.

$query_params(array) (required)

SQL query parameter array.

$table_name(string) (required)

Name of main SQL table for the data store (used as basis for JOINS).

Segmenter::get_segments() Segmenter::get segments code ^{WC 10.3.6}

protected function get_segments( $type, $query_params, $table_name ) {
	global $wpdb;
	if ( ! isset( $this->query_args['segmentby'] ) || '' === $this->query_args['segmentby'] ) {
		return array();
	}

	$product_segmenting_table = $wpdb->prefix . 'wc_order_product_lookup';
	$unique_orders_table      = 'uniq_orders';
	$segmenting_where         = '';

	// Product, variation, and category are bound to product, so here product segmenting table is required,
	// while coupon and customer are bound to order, so we don't need the extra JOIN for those.
	// This also means that segment selections need to be calculated differently.
	if ( 'product' === $this->query_args['segmentby'] ) {
		$product_level_columns     = $this->get_segment_selections_product_level( $product_segmenting_table );
		$segmenting_selections     = array(
			'product_level' => $this->prepare_selections( $product_level_columns ),
		);
		$this->report_columns      = $product_level_columns;
		$segmenting_from           = '';
		$segmenting_groupby        = $product_segmenting_table . '.product_id';
		$segmenting_dimension_name = 'product_id';

		$segments = $this->get_product_related_segments( $type, $segmenting_selections, $segmenting_from, $segmenting_where, $segmenting_groupby, $segmenting_dimension_name, $table_name, $query_params, $unique_orders_table );
	} elseif ( 'variation' === $this->query_args['segmentby'] ) {
		if ( ! isset( $this->query_args['product_includes'] ) || ! is_array( $this->query_args['product_includes'] ) || count( $this->query_args['product_includes'] ) !== 1 ) {
			throw new ParameterException( 'wc_admin_reports_invalid_segmenting_variation', __( 'product_includes parameter need to specify exactly one product when segmenting by variation.', 'woocommerce' ) );
		}

		$product_level_columns     = $this->get_segment_selections_product_level( $product_segmenting_table );
		$segmenting_selections     = array(
			'product_level' => $this->prepare_selections( $product_level_columns ),
		);
		$this->report_columns      = $product_level_columns;
		$segmenting_from           = '';
		$segmenting_where          = "AND $product_segmenting_table.product_id = {$this->query_args['product_includes'][0]}";
		$segmenting_groupby        = $product_segmenting_table . '.variation_id';
		$segmenting_dimension_name = 'variation_id';

		$segments = $this->get_product_related_segments( $type, $segmenting_selections, $segmenting_from, $segmenting_where, $segmenting_groupby, $segmenting_dimension_name, $table_name, $query_params, $unique_orders_table );
	} elseif ( 'category' === $this->query_args['segmentby'] ) {
		$product_level_columns     = $this->get_segment_selections_product_level( $product_segmenting_table );
		$segmenting_selections     = array(
			'product_level' => $this->prepare_selections( $product_level_columns ),
		);
		$this->report_columns      = $product_level_columns;
		$segmenting_from           = "
		LEFT JOIN {$wpdb->term_relationships} ON {$product_segmenting_table}.product_id = {$wpdb->term_relationships}.object_id
		JOIN {$wpdb->term_taxonomy} ON {$wpdb->term_taxonomy}.term_taxonomy_id = {$wpdb->term_relationships}.term_taxonomy_id
		LEFT JOIN {$wpdb->wc_category_lookup} ON {$wpdb->term_taxonomy}.term_id = {$wpdb->wc_category_lookup}.category_id
		";
		$segmenting_where          = " AND {$wpdb->wc_category_lookup}.category_tree_id IS NOT NULL";
		$segmenting_groupby        = "{$wpdb->wc_category_lookup}.category_tree_id";
		$segmenting_dimension_name = 'category_id';

		// Restrict our search space for category comparisons.
		if ( isset( $this->query_args['category_includes'] ) ) {
			$category_ids      = implode( ',', $this->get_all_segments() );
			$segmenting_where .= " AND {$wpdb->wc_category_lookup}.category_id IN ( $category_ids )";
		}

		$segments = $this->get_product_related_segments( $type, $segmenting_selections, $segmenting_from, $segmenting_where, $segmenting_groupby, $segmenting_dimension_name, $table_name, $query_params, $unique_orders_table );
	}

	return $segments;
}