Automattic\WooCommerce\Admin\API\Reports\Coupons

DataStore::include_extended_info() protected WC 1.0

Enriches the coupon data with extra attributes.

{} It's a method of the class: DataStore{}

No Hooks.

Return

null. Nothing.

Usage

// protected - for code of main (parent) or child class
$result = $this->include_extended_info( $coupon_data, $query_args );

$coupon_data(array) (required) (passed by reference — &)

Coupon data.

$query_args(array) (required)

Query parameters.

Code of DataStore::include_extended_info() DataStore::include extended info ^{WC 6.1.0}

protected function include_extended_info( &$coupon_data, $query_args ) {
	foreach ( $coupon_data as $idx => $coupon_datum ) {
		$extended_info = new \ArrayObject();
		if ( $query_args['extended_info'] ) {
			$coupon_id = $coupon_datum['coupon_id'];
			$coupon    = new \WC_Coupon( $coupon_id );

			if ( 0 === $coupon->get_id() ) {
				// Deleted or otherwise invalid coupon.
				$extended_info = array(
					'code'             => __( '(Deleted)', 'woocommerce' ),
					'date_created'     => '',
					'date_created_gmt' => '',
					'date_expires'     => '',
					'date_expires_gmt' => '',
					'discount_type'    => __( 'N/A', 'woocommerce' ),
				);
			} else {
				$gmt_timzone = new \DateTimeZone( 'UTC' );

				$date_expires = $coupon->get_date_expires();
				if ( is_a( $date_expires, 'DateTime' ) ) {
					$date_expires     = $date_expires->format( TimeInterval::$iso_datetime_format );
					$date_expires_gmt = new \DateTime( $date_expires );
					$date_expires_gmt->setTimezone( $gmt_timzone );
					$date_expires_gmt = $date_expires_gmt->format( TimeInterval::$iso_datetime_format );
				} else {
					$date_expires     = '';
					$date_expires_gmt = '';
				}

				$date_created = $coupon->get_date_created();
				if ( is_a( $date_created, 'DateTime' ) ) {
					$date_created     = $date_created->format( TimeInterval::$iso_datetime_format );
					$date_created_gmt = new \DateTime( $date_created );
					$date_created_gmt->setTimezone( $gmt_timzone );
					$date_created_gmt = $date_created_gmt->format( TimeInterval::$iso_datetime_format );
				} else {
					$date_created     = '';
					$date_created_gmt = '';
				}

				$extended_info = array(
					'code'             => $coupon->get_code(),
					'date_created'     => $date_created,
					'date_created_gmt' => $date_created_gmt,
					'date_expires'     => $date_expires,
					'date_expires_gmt' => $date_expires_gmt,
					'discount_type'    => $coupon->get_discount_type(),
				);
			}
		}
		$coupon_data[ $idx ]['extended_info'] = $extended_info;
	}
}