Files
wp-graphql-woocommerce/includes/model/class-wc-post.php
f583628199 chore: implement WPGraphQL Coding Standards (#769)
* chore: avoid magic constants [PHPCS]

* chore: change ruleset to wp-graphql-cs and lint

* devops: HPOS added back to CI with the release of WC 3.9

---------

Co-authored-by: Geoff Taylor <geoff@axistaylor.com>
2023-07-19 17:11:25 -04:00

223 lines
5.7 KiB
PHP

<?php
/**
* Abstract Model - WC_Post
*
* Defines shared functionality for WooCommerce CPT models.
*
* @package WPGraphQL\WooCommerce\Model
* @since 0.0.1
*/
namespace WPGraphQL\WooCommerce\Model;
use GraphQL\Error\UserError;
use WPGraphQL\Model\Post;
/**
* Class WC_Post
*
* @property \WC_Data $wc_data
* @property \WP_Post $data
*
* @package WPGraphQL\WooCommerce\Model
*/
abstract class WC_Post extends Post {
/**
* Stores the WC_Data object connected to the model.
*
* @var \WC_Data
*/
protected $wc_data;
/**
* WC_Post constructor
*
* @param \WC_Data $data Data object to be used by the model.
*
* @throws \Exception Failed to retrieve data source post object.
*/
public function __construct( $data ) {
// Store CRUD object.
$this->wc_data = $data;
// Get WP_Post object.
$post = get_post( $data->get_id() );
// Check if product is valid.
if ( ! is_object( $post ) ) {
throw new \Exception( __( 'Failed to retrieve data source post object', 'wp-graphql-woocommerce' ) );
}
// Add $allowed_restricted_fields.
if ( ! has_filter( 'graphql_allowed_fields_on_restricted_type', [ static::class, 'add_allowed_restricted_fields' ] ) ) {
add_filter( 'graphql_allowed_fields_on_restricted_type', [ static::class, 'add_allowed_restricted_fields' ], 10, 2 );
}
// Execute Post Model constructor.
parent::__construct( $post );
}
/**
* Injects CRUD object fields into $allowed_restricted_fields
*
* @param array $allowed_restricted_fields The fields to allow when the data is designated as restricted to the current user.
* @param string $model_name Name of the model the filter is currently being executed in.
*
* @return string[]
*/
public static function add_allowed_restricted_fields( $allowed_restricted_fields, $model_name ) {
$class_name = static::class;
if ( "{$class_name}Object" === $model_name ) {
return static::get_allowed_restricted_fields( $allowed_restricted_fields );
}
return $allowed_restricted_fields;
}
/**
* Return the fields allowed to be displayed even if this entry is restricted.
*
* @param array $allowed_restricted_fields The fields to allow when the data is designated as restricted to the current user.
*
* @return array
*/
protected static function get_allowed_restricted_fields( $allowed_restricted_fields = [] ) {
return [
'isRestricted',
'isPrivate',
'isPublic',
'id',
'databaseId',
];
}
/**
* Forwards function calls to WC_Data sub-class instance.
*
* @param string $method - function name.
* @param array $args - function call arguments.
*
* @return mixed
*
* @throws \BadMethodCallException Method not found on WC data object.
*/
public function __call( $method, $args ) {
if ( \is_callable( [ $this->wc_data, $method ] ) ) {
return $this->wc_data->$method( ...$args );
}
$class = self::class;
throw new \BadMethodCallException( "Call to undefined method {$method} on the {$class}" );
}
/**
* Wrapper function for deleting
*
* @throws \GraphQL\Error\UserError Not authorized.
*
* @param boolean $force_delete Should the data be deleted permanently.
* @return boolean
*/
public function delete( $force_delete = false ) {
$post_type_object = $this->post_type_object;
if ( empty( $post_type_object ) ) {
throw new UserError(
__(
'Post type object not found.',
'wp-graphql-woocommerce'
)
);
}
if ( ! current_user_can( $post_type_object->cap->edit_posts ) ) {
throw new UserError(
__(
'User does not have the capabilities necessary to delete this object.',
'wp-graphql-woocommerce'
)
);
}
return $this->wc_data->delete( $force_delete );
}
/**
* Method for determining if the data should be considered private or not
*
* @param \WP_Post $post_object The object of the post we need to verify permissions for.
*
* @return bool
*/
protected function is_post_private( $post_object = null ) {
/**
* Stores the incoming post type object for the post being modeled
*
* @var null|\WP_Post_Type $post_type_object
*/
$post_type_object = $this->post_type_object;
if ( empty( $post_object ) ) {
$post_object = $this->data;
return true;
}
/**
* If the status is NOT publish and the user does NOT have capabilities to edit posts,
* consider the post private.
*/
if ( ! isset( $post_type_object->cap->edit_posts ) || ! current_user_can( $post_type_object->cap->edit_posts ) ) {
return true;
}
/**
* If the owner of the content is the current user
*/
if ( ( true === $this->owner_matches_current_user() ) && 'revision' !== $post_object->post_type ) {
return false;
}
if ( 'private' === $this->data->post_status && ( ! isset( $post_type_object->cap->read_private_posts ) || ! current_user_can( $post_type_object->cap->read_private_posts ) ) ) {
return true;
}
if ( 'auto-draft' === $this->data->post_status ) {
$parent = get_post( (int) $this->data->post_parent );
if ( empty( $parent ) ) {
return true;
}
$parent_post_type_obj = $post_type_object;
if ( 'private' === $parent->post_status ) {
$cap = isset( $parent_post_type_obj->cap->read_private_posts ) ? $parent_post_type_obj->cap->read_private_posts : 'read_private_posts';
} else {
$cap = isset( $parent_post_type_obj->cap->edit_post ) ? $parent_post_type_obj->cap->edit_post : 'edit_post';
}
if ( ! current_user_can( $cap, $parent->ID ) ) {
return true;
}
}//end if
return false;
}
/**
* Returns the source WP_Post instance.
*
* @return \WP_Post
*/
public function as_WP_Post() {
return $this->data;
}
/**
* Returns the source WC_Data instance
*
* @return \WC_Data
*/
public function as_WC_Data() {
return $this->wc_data;
}
}