Automattic\WooCommerce\Internal\RestApi\Routes\V4

AbstractSchema{} │ abstract │ WC 10.2.0

Abstract REST Schema for WooCommerce REST API V4.

Provides common functionality for all V4 schema controllers including property generation, context filtering, and validation.

No Hooks.

Usage

$AbstractSchema = new AbstractSchema();
// use class methods

Methods

1. public array()
2. public get_item_response( $item, WP_REST_Request $request, array $include_fields = array() )
3. public get_item_schema()
4. public get_item_schema_properties()
5. public get_writable_item_schema_properties()
6. protected filter_writable_props( array $schema )
7. ERROR: no method name found on line ``
8. ERROR: no method name found on line ``
9. ERROR: no method name found on line ``
10. ERROR: no method name found on line ``
11. ERROR: no method name found on line ``
12. ERROR: no method name found on line `'$schema' => 'http://json-schema.org/draft-04/schema#',`
13. ERROR: no method name found on line ``
14. ERROR: no method name found on line ``
15. ERROR: no method name found on line ``
16. ERROR: no method name found on line ``
17. ERROR: no method name found on line ``
18. ERROR: no method name found on line ``
19. ERROR: no method name found on line ``
20. ERROR: no method name found on line ``
21. ERROR: no method name found on line `* @since 10.2.0`

Changelog

AbstractSchema{} AbstractSchema{} code ^{WC 10.7.0}

abstract class AbstractSchema {
	/**
	 * The schema item identifier.
	 *
	 * @var string
	 * @since 10.2.0
	 */
	const IDENTIFIER = '';

	/**
	 * Context for the item schema - view, edit, and embed.
	 *
	 * @var array
	 * @since 10.2.0
	 */
	const VIEW_EDIT_EMBED_CONTEXT = array( 'view', 'edit', 'embed' );

	/**
	 * Context for the item schema - view and edit only.
	 *
	 * @var array
	 * @since 10.2.0
	 */
	const VIEW_EDIT_CONTEXT = array( 'view', 'edit' );

	/**
	 * Get the item schema.
	 *
	 * @return array The item schema.
	 * @since 10.2.0
	 */
	public function get_item_schema(): array {
		return array(
			'$schema'    => 'http://json-schema.org/draft-04/schema#',
			'title'      => static::IDENTIFIER,
			'type'       => 'object',
			'properties' => $this->get_item_schema_properties(),
		);
	}

	/**
	 * Get the item response.
	 *
	 * @param mixed           $item WordPress representation of the item.
	 * @param WP_REST_Request $request Request object.
	 * @param array           $include_fields Fields to include in the response.
	 * @return array The item response.
	 */
	abstract public function get_item_response( $item, WP_REST_Request $request, array $include_fields = array() ): array;

	/**
	 * Return all properties for the item schema.
	 *
	 * @return array The schema properties.
	 * @since 10.2.0
	 */
	public function get_item_schema_properties(): array {
		return array();
	}

	/**
	 * Return all writable properties for the item schema.
	 *
	 * @return array The schema properties.
	 * @since 10.2.0
	 */
	public function get_writable_item_schema_properties(): array {
		return array_filter( $this->get_item_schema_properties(), array( $this, 'filter_writable_props' ) );
	}

	/**
	 * Filter schema properties to only return writable ones.
	 *
	 * @param array $schema The schema property to check.
	 * @return bool True if the property is writable, false otherwise.
	 * @since 10.2.0
	 */
	protected function filter_writable_props( array $schema ): bool {
		return empty( $schema['readonly'] );
	}
}