mirror of
https://github.com/wp-graphql/wp-graphql-woocommerce.git
synced 2026-08-14 12:53:44 +02:00
Geoffrey K TaylorandGitHub
f4b153f147
* feat: docs started. Unsupported product type implemented. * chore: WPCS compliance met * chore: file renamed. * feat: More docs written * feat: 2 more docs written * fix: settings docs images added. * fix: settings docs images added. * devops: UnsupportProductTypeTest added. * devops: More docs changes. * chore: WPCS compliance met * devops: UnsupportedProductTypeTest updated. * chore: WPCS compliance met
288 lines
8.6 KiB
PHP
288 lines
8.6 KiB
PHP
<?php
|
|
/**
|
|
* This file contains access functions for various class methods
|
|
*
|
|
* @package WPGraphQL\WooCommerce
|
|
* @since 0.0.1
|
|
*/
|
|
|
|
if ( ! function_exists( 'wc_graphql_starts_with' ) ) {
|
|
/**
|
|
* Checks if source string starts with the target string
|
|
*
|
|
* @param string $haystack - Source string.
|
|
* @param string $needle - Target string.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function wc_graphql_starts_with( $haystack, $needle ) {
|
|
$length = strlen( $needle );
|
|
return ( substr( $haystack, 0, $length ) === $needle );
|
|
}
|
|
}
|
|
|
|
if ( ! function_exists( 'wc_graphql_ends_with' ) ) {
|
|
/**
|
|
* Checks if source string ends with the target string
|
|
*
|
|
* @param string $haystack - Source string.
|
|
* @param string $needle - Target string.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function wc_graphql_ends_with( $haystack, $needle ) {
|
|
$length = strlen( $needle );
|
|
if ( 0 === $length ) {
|
|
return true;
|
|
}
|
|
|
|
return ( substr( $haystack, -$length ) === $needle );
|
|
}
|
|
}
|
|
|
|
if ( ! function_exists( 'wc_graphql_map_tax_statements' ) ) {
|
|
/**
|
|
* Returns formatted array of tax statement objects.
|
|
*
|
|
* @param array $raw_taxes - array of raw taxes object from WC_Order_Item crud objects.
|
|
*
|
|
* @return array
|
|
*/
|
|
function wc_graphql_map_tax_statements( $raw_taxes ) {
|
|
$taxes = [];
|
|
foreach ( $raw_taxes as $field => $values ) {
|
|
foreach ( $values as $id => $amount ) {
|
|
if ( empty( $taxes[ $id ] ) ) {
|
|
$taxes[ $id ] = [];
|
|
}
|
|
$taxes[ $id ]['ID'] = $id;
|
|
$taxes[ $id ][ $field ] = $amount;
|
|
}
|
|
}
|
|
|
|
return array_values( $taxes );
|
|
}
|
|
}//end if
|
|
|
|
if ( ! function_exists( 'wc_graphql_get_order_statuses' ) ) {
|
|
/**
|
|
* Get order statuses without prefixes.
|
|
*
|
|
* @return array
|
|
*/
|
|
function wc_graphql_get_order_statuses() {
|
|
$order_statuses = [];
|
|
foreach ( array_keys( wc_get_order_statuses() ) as $status ) {
|
|
$order_statuses[] = str_replace( 'wc-', '', $status );
|
|
}
|
|
return $order_statuses;
|
|
}
|
|
}
|
|
|
|
if ( ! function_exists( 'wc_graphql_price' ) ) {
|
|
/**
|
|
* Format the price with a currency symbol.
|
|
*
|
|
* @param float $price Raw price.
|
|
* @param array $args Arguments to format a price {
|
|
* Array of arguments.
|
|
* Defaults to empty array.
|
|
*
|
|
* @type string $currency Currency code.
|
|
* Defaults to empty string (Use the result from get_woocommerce_currency()).
|
|
* @type string $decimal_separator Decimal separator.
|
|
* Defaults the result of wc_get_price_decimal_separator().
|
|
* @type string $thousand_separator Thousand separator.
|
|
* Defaults the result of wc_get_price_thousand_separator().
|
|
* @type string $decimals Number of decimals.
|
|
* Defaults the result of wc_get_price_decimals().
|
|
* @type string $price_format Price format depending on the currency position.
|
|
* Defaults the result of get_woocommerce_price_format().
|
|
* }
|
|
* @return string
|
|
*/
|
|
function wc_graphql_price( $price, $args = [] ) {
|
|
$price = floatval( $price );
|
|
$args = apply_filters(
|
|
'wc_price_args', // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound
|
|
wp_parse_args(
|
|
$args,
|
|
[
|
|
'currency' => '',
|
|
'decimal_separator' => wc_get_price_decimal_separator(),
|
|
'thousand_separator' => wc_get_price_thousand_separator(),
|
|
'decimals' => wc_get_price_decimals(),
|
|
'price_format' => get_woocommerce_price_format(),
|
|
]
|
|
)
|
|
);
|
|
|
|
$unformatted_price = $price;
|
|
$negative = $price < 0;
|
|
|
|
// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound
|
|
$price = apply_filters( 'raw_woocommerce_price', floatval( $negative ? $price * -1 : $price ) );
|
|
|
|
$price = apply_filters(
|
|
// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound
|
|
'formatted_woocommerce_price',
|
|
number_format(
|
|
$price,
|
|
$args['decimals'],
|
|
$args['decimal_separator'],
|
|
$args['thousand_separator']
|
|
),
|
|
$price,
|
|
$args['decimals'],
|
|
$args['decimal_separator'],
|
|
$args['thousand_separator']
|
|
);
|
|
|
|
// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound
|
|
if ( apply_filters( 'woocommerce_price_trim_zeros', false ) && $args['decimals'] > 0 ) {
|
|
$price = wc_trim_zeros( $price );
|
|
}
|
|
|
|
// phpcs:ignore PHPCompatibility.ParameterValues.NewHTMLEntitiesEncodingDefault.NotSet
|
|
$symbol = html_entity_decode( get_woocommerce_currency_symbol( $args['currency'] ) );
|
|
$return = ( $negative ? '-' : '' ) . sprintf( $args['price_format'], $symbol, $price );
|
|
|
|
/**
|
|
* Filters the string of price markup.
|
|
*
|
|
* @param string $return Price HTML markup.
|
|
* @param string $price Formatted price.
|
|
* @param array $args Pass on the args.
|
|
* @param float $unformatted_price Price as float to allow plugins custom formatting. Since 3.2.0.
|
|
*/
|
|
return apply_filters( 'graphql_woocommerce_price', $return, $price, $args, $unformatted_price, $symbol );
|
|
}
|
|
}//end if
|
|
|
|
if ( ! function_exists( 'wc_graphql_price_range' ) ) {
|
|
/**
|
|
* Format a price range for display.
|
|
*
|
|
* @param string $from Price from.
|
|
* @param string $to Price to.
|
|
* @return string
|
|
*/
|
|
function wc_graphql_price_range( $from, $to ) {
|
|
if ( $from === $to ) {
|
|
return wc_graphql_price( $from );
|
|
}
|
|
|
|
$price = sprintf(
|
|
/* translators: 1: price from 2: price to */
|
|
_x( '%1$s %2$s %3$s', 'Price range: from-to', 'wp-graphql-woocommerce' ),
|
|
is_numeric( $from ) ? wc_graphql_price( $from ) : $from,
|
|
apply_filters( 'graphql_woocommerce_format_price_range_separator', '-', $from, $to ),
|
|
is_numeric( $to ) ? wc_graphql_price( $to ) : $to
|
|
);
|
|
|
|
return apply_filters( 'graphql_woocommerce_format_price_range', $price, $from, $to );
|
|
}
|
|
}//end if
|
|
|
|
if ( ! function_exists( 'wc_graphql_underscore_to_camel_case' ) ) {
|
|
/**
|
|
* Converts a camel case formatted string to a underscore formatted string.
|
|
*
|
|
* @param string $string String to be formatted.
|
|
* @param boolean $capitalize Capitalize first letter of string.
|
|
*
|
|
* @return string
|
|
*/
|
|
function wc_graphql_underscore_to_camel_case( $string, $capitalize = false ) {
|
|
$str = str_replace( ' ', '', ucwords( str_replace( '-', ' ', $string ) ) );
|
|
|
|
if ( ! $capitalize ) {
|
|
$str[0] = strtolower( $str[0] );
|
|
}
|
|
|
|
return $str;
|
|
}
|
|
}
|
|
|
|
if ( ! function_exists( 'wc_graphql_camel_case_to_underscore' ) ) {
|
|
/**
|
|
* Converts a camel case formatted string to a underscore formatted string.
|
|
*
|
|
* @param string $string String to be formatted.
|
|
*
|
|
* @return string
|
|
*/
|
|
function wc_graphql_camel_case_to_underscore( $string ) {
|
|
preg_match_all(
|
|
'!([A-Z][A-Z0-9]*(?=$|[A-Z][a-z0-9])|[A-Za-z][a-z0-9]+)!',
|
|
$string,
|
|
$matches
|
|
);
|
|
|
|
$ret = $matches[0];
|
|
|
|
foreach ( $ret as &$match ) {
|
|
$match = strtoupper( $match ) === $match ? strtolower( $match ) : lcfirst( $match );
|
|
}
|
|
|
|
return implode( '_', $ret );
|
|
}
|
|
}//end if
|
|
|
|
/**
|
|
* Plugin global functions.
|
|
*
|
|
* @package Axis\Plugin_Distributor
|
|
*/
|
|
|
|
if ( ! function_exists( 'woographql_setting' ) ) :
|
|
/**
|
|
* Get an option value from WooGraphQL settings
|
|
*
|
|
* @param string $option_name The key of the option to return.
|
|
* @param mixed $default The default value the setting should return if no value is set.
|
|
* @param string $section_name The settings section name.
|
|
*
|
|
* @return mixed|string|int|boolean
|
|
*/
|
|
function woographql_setting( string $option_name, $default = '', $section_name = 'woographql_settings' ) {
|
|
$section_fields = get_option( $section_name );
|
|
|
|
/**
|
|
* Filter the section fields
|
|
*
|
|
* @param array $section_fields The values of the fields stored for the section
|
|
* @param string $section_name The name of the section
|
|
* @param mixed $default The default value for the option being retrieved
|
|
*/
|
|
$section_fields = apply_filters( 'woographql_settings_section_fields', $section_fields, $section_name, $default );
|
|
|
|
/**
|
|
* Get the value from the stored data, or return the default
|
|
*/
|
|
$value = isset( $section_fields[ $option_name ] ) ? $section_fields[ $option_name ] : $default;
|
|
|
|
/**
|
|
* Filter the value before returning it
|
|
*
|
|
* @param mixed $value The value of the field
|
|
* @param mixed $default The default value if there is no value set
|
|
* @param string $option_name The name of the option
|
|
* @param array $section_fields The setting values within the section
|
|
* @param string $section_name The name of the section the setting belongs to
|
|
*/
|
|
return apply_filters( 'woographql_settings_section_field_value', $value, $default, $option_name, $section_fields, $section_name );
|
|
}
|
|
endif;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|