Skip to content

Commit

Permalink
Apply fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
@anton-vlasenko
anton-vlasenko authored and Anton Vlasenko committed Feb 2, 2024
1 parent 51f59e6 commit d16d226
Show file tree
Hide file tree
Showing 5 changed files with 297 additions and 340 deletions.
198 changes: 94 additions & 104 deletions lib/compat/wordpress-6.5/fonts/class-wp-font-collection.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* Font Collection class.
*
* This file contains the Font Collection class definition.
* This class is used to manage a collection of fonts.
*
* @package WordPress
* @subpackage Font Library
Expand All @@ -12,62 +12,86 @@
if ( ! class_exists( 'WP_Font_Collection' ) ) {

/**
* Font Collection class.
* Manages a collection of fonts.
*
* This class provides functionality to manage a group of font families, including loading font data from JSON files.
*
* @since 6.5.0
*/
final class WP_Font_Collection {
class WP_Font_Collection {
/**
* The unique slug for the font collection.
*
* @since 6.5.0
*
* @var string
*/
public $slug;

/**
* Font collection data.
* The name of the font collection.
*
* @since 6.5.0
* @var string
*/
public $name;

/**
* Description of the font collection.
*
* @since 6.5.0
* @var string
*/
public $description;

/**
* Array of font families in the collection.
*
* @since 6.5.0
* @var array
*/
private $data;
public $font_families;

/**
* Font collection JSON file path or url.
* Categories associated with the font collection.
*
* @since 6.5.0
* @var array
*/
public $categories;

/**
* Font collection JSON cache.
*
* @var string
* Caches the font collection data loaded from JSON to optimize performance.
*
* @since 6.5.0
* @var array
*/
private $src;
private static $collection_json_cache = array();

/**
* WP_Font_Collection constructor.
* Constructor for the WP_Font_Collection class.
*
* Initializes a new instance of the WP_Font_Collection class with the specified slug and configuration options.
*
* @since 6.5.0
*
* @param string $slug Font collection slug.
* @param array|string $data_or_file {
* Font collection data array or a file path or url to a JSON file containing the font collection.
* @param string $slug Font collection slug.
* @param array $args {
* Optional. Array of configuration options for the font collection.
*
* @type string $name Name of the font collection.
* @type string $description Description of the font collection.
* @type array $font_families Array of font family definitions that are in the collection.
* @type array $categories Array of categories for the fonts that are in the collection.
* @type string $name Name of the font collection.
* @type string $description Description of the font collection.
* @type array $font_families Array of font family definitions included in the collection.
* @type array $categories Array of categories associated with the fonts in the collection.
* }
*/
public function __construct( $slug, $data_or_file ) {
$this->slug = sanitize_title( $slug );

// Data or json are lazy loaded and validated in get_data().
if ( is_array( $data_or_file ) ) {
$this->data = $data_or_file;
} else {
$this->src = $data_or_file;
}
public function __construct( $slug, $args = array() ) {
$this->slug = sanitize_title( $slug );
$this->name = isset( $args['name'] ) ? $args['name'] : __( 'Unnamed Font Collection', 'gutenberg' );
$this->description = isset( $args['description'] ) ? $args['description'] : '';
$this->font_families = isset( $args['font_families'] ) ? $args['font_families'] : array();
$this->categories = isset( $args['categories'] ) ? $args['categories'] : array();

if ( $this->slug !== $slug ) {
_doing_it_wrong(
Expand All @@ -77,95 +101,83 @@ public function __construct( $slug, $data_or_file ) {
'6.5.0'
);
}
}

/**
* Retrieves the font collection data.
*
* @since 6.5.0
*
* @return array|WP_Error An array containing the font collection data, or a WP_Error on failure.
*/
public function get_data() {
// If we have a JSON config, load it and cache the data if it's valid.
if ( $this->src && empty( $this->data ) ) {
$data = $this->load_from_json( $this->src );
if ( is_wp_error( $data ) ) {
return $data;
}

$this->data = $data;
}

// Validate required properties are not empty.
$data = $this->validate_data( $this->data );
if ( is_wp_error( $data ) ) {
return $data;
if ( empty( $args['font_families'] ) ) {
_doing_it_wrong(
__METHOD__,
/* translators: %s: Font collection slug. */
sprintf( __( 'Font collection "%s" does not contain any font families.', 'gutenberg' ), $slug ),
'6.5.0'
);
}

// Set defaults for optional properties.
$data = wp_parse_args(
$data,
array(
'description' => '',
'categories' => array(),
)
);

return $data;
}

/**
* Loads the font collection data from a JSON file path or url.
* Loads the font collection data from a json file path or url.
*
* @since 6.5.0
*
* @param string $file_or_url File path or url to a JSON file containing the font collection data.
* @param string $file_or_url File path or url to a json file containing the font collection data.
* @return array|WP_Error An array containing the font collection data on success,
* else an instance of WP_Error on failure.
* or WP_Error object on failure.
*/
private function load_from_json( $file_or_url ) {
public static function load_from_json( $file_or_url ) {
$url = wp_http_validate_url( $file_or_url );
$file = file_exists( $file_or_url ) ? wp_normalize_path( realpath( $file_or_url ) ) : false;

if ( ! $url && ! $file ) {
// translators: %s: File path or url to font collection JSON file.
$message = __( 'Font collection JSON file is invalid or does not exist.', 'gutenberg' );
// translators: %s: File path or url to font collection json file.
$message = sprintf( __( 'Font collection JSON file "%s" is invalid or does not exist.', 'gutenberg' ), $file_or_url );
_doing_it_wrong( __METHOD__, $message, '6.5.0' );
return new WP_Error( 'font_collection_json_missing', $message );
}

return $url ? $this->load_from_url( $url ) : $this->load_from_file( $file );
return $url ? self::load_from_url( $url ) : self::load_from_file( $file );
}

/**
* Loads the font collection data from a JSON file path.
* Loads font collection data from a JSON file path.
*
* @since 6.5.0
*
* @param string $file File path to a JSON file containing the font collection data.
* @return array|WP_Error An array containing the font collection data on success,
* else an instance of WP_Error on failure.
* @return array|WP_Error Array containing the font collection data on success, or WP_Error object on failure.
*/
private function load_from_file( $file ) {
private static function load_from_file( $file ) {
if ( array_key_exists( $file, static::$collection_json_cache ) ) {
return static::$collection_json_cache[ $file ];
}

$data = wp_json_file_decode( $file, array( 'associative' => true ) );
if ( empty( $data ) ) {
return new WP_Error( 'font_collection_decode_error', __( 'Error decoding the font collection JSON file contents.', 'gutenberg' ) );
}

if ( empty( $data['slug'] ) ) {
// translators: %s: Font collection JSON URL.
$message = sprintf( __( 'Font collection JSON file "%s" requires a slug.', 'gutenberg' ), $file );
_doing_it_wrong( __METHOD__, $message, '6.5.0' );
return new WP_Error( 'font_collection_invalid_json', $message );
}

static::$collection_json_cache[ $file ] = $data;

return $data;
}

/**
* Loads the font collection data from a JSON file url.
* Loads font collection data from a JSON file URL.
*
* @since 6.5.0
*
* @param string $url Url to a JSON file containing the font collection data.
* @return array|WP_Error An array containing the font collection data on success,
* else an instance of WP_Error on failure.
* @param string $url URL to a JSON file containing the font collection data.
* @return array|WP_Error Array containing the font collection data on success, or WP_Error object on failure.
*/
private function load_from_url( $url ) {
private static function load_from_url( $url ) {
if ( array_key_exists( $url, static::$collection_json_cache ) ) {
return static::$collection_json_cache[ $url ];
}

// Limit key to 167 characters to avoid failure in the case of a long url.
$transient_key = substr( 'wp_font_collection_url_' . $url, 0, 167 );
$data = get_site_transient( $transient_key );
Expand All @@ -182,40 +194,18 @@ private function load_from_url( $url ) {
return new WP_Error( 'font_collection_decode_error', __( 'Error decoding the font collection data from the REST response JSON.', 'gutenberg' ) );
}

// Make sure the data is valid before caching it.
$data = $this->validate_data( $data );
if ( is_wp_error( $data ) ) {
return $data;
if ( empty( $data['slug'] ) ) {
// translators: %s: Font collection JSON URL.
$message = sprintf( __( 'Font collection JSON file "%s" requires a slug.', 'gutenberg' ), $url );
_doing_it_wrong( __METHOD__, $message, '6.5.0' );
return new WP_Error( 'font_collection_invalid_json', $message );
}

set_site_transient( $transient_key, $data, DAY_IN_SECONDS );
}

return $data;
}
static::$collection_json_cache[ $url ] = $data;

/**
* Validates the font collection configuration.
*
* @since 6.5.0
*
* @param array $data Font collection configuration.
* @return array|WP_Error Array of data if valid, otherwise a WP_Error instance.
*/
private function validate_data( $data ) {
$required_properties = array( 'name', 'font_families' );
foreach ( $required_properties as $property ) {
if ( empty( $data[ $property ] ) ) {
$message = sprintf(
// translators: 1: Font collection slug, 2: Missing property name.
__( 'Font collection "%1$s" has missing or empty property: "%2$s."', 'gutenberg' ),
$this->slug,
$property
);
_doing_it_wrong( __METHOD__, $message, '6.5.0' );
return new WP_Error( 'font_collection_missing_property', $message );
}
}
return $data;
}
}
Expand Down
Loading

0 comments on commit d16d226

Please sign in to comment.