2022-09-14 08:48:16 -04:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* WP_Style_Engine_Processor
|
|
|
|
*
|
|
|
|
* Compiles styles from stores or collection of CSS rules.
|
|
|
|
*
|
|
|
|
* @package WordPress
|
|
|
|
* @subpackage StyleEngine
|
|
|
|
* @since 6.1.0
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Class WP_Style_Engine_Processor.
|
|
|
|
*
|
|
|
|
* Compiles styles from stores or collection of CSS rules.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*/
|
Code Modernization: Add `AllowDynamicProperties` attribute to recently introduced classes.
This commit is a follow-up to [54133] for new classes introduced in WordPress 6.1 since the previous commit.
Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
There are a number of ways to mitigate this:
* If it is an accidental typo for a declared property: fix the typo.
* For known properties: declare them on the class.
* For unknown properties: add the magic `__get()`, `__set()`, et al. methods to the class or let the class extend `stdClass` which has highly optimized versions of these magic methods built in.
* For unknown ''use'' of dynamic properties, the `#[AllowDynamicProperties]` attribute can be added to the class. The attribute will automatically be inherited by child classes.
Trac ticket #56034 is open to investigate and handle the third and fourth type of situations, however it has become clear this will need more time and will not be ready in time for WP 6.1.
To reduce “noise” in the meantime, both in the error logs of WP users moving onto PHP 8.2, in the test run logs of WP itself, in test runs of plugins and themes, as well as to prevent duplicate tickets from being opened for the same issue, the `#[AllowDynamicProperties]` attribute has been added to all “parent” classes in WP.
Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties].
Follow-up to [53922], [54133].
Props jrf.
See #56513, #56034.
Built from https://develop.svn.wordpress.org/trunk@54481
git-svn-id: http://core.svn.wordpress.org/trunk@54040 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-10-11 11:00:12 -04:00
|
|
|
#[AllowDynamicProperties]
|
2022-09-14 08:48:16 -04:00
|
|
|
class WP_Style_Engine_Processor {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* A collection of Style Engine Store objects.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
* @var WP_Style_Engine_CSS_Rules_Store[]
|
|
|
|
*/
|
|
|
|
protected $stores = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The set of CSS rules that this processor will work on.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
* @var WP_Style_Engine_CSS_Rule[]
|
|
|
|
*/
|
|
|
|
protected $css_rules = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds a store to the processor.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param WP_Style_Engine_CSS_Rules_Store $store The store to add.
|
|
|
|
* @return WP_Style_Engine_Processor Returns the object to allow chaining methods.
|
|
|
|
*/
|
|
|
|
public function add_store( $store ) {
|
|
|
|
if ( ! $store instanceof WP_Style_Engine_CSS_Rules_Store ) {
|
|
|
|
_doing_it_wrong(
|
|
|
|
__METHOD__,
|
|
|
|
__( '$store must be an instance of WP_Style_Engine_CSS_Rules_Store' ),
|
|
|
|
'6.1.0'
|
|
|
|
);
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->stores[ $store->get_name() ] = $store;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds rules to be processed.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param WP_Style_Engine_CSS_Rule|WP_Style_Engine_CSS_Rule[] $css_rules A single, or an array of, WP_Style_Engine_CSS_Rule objects from a store or otherwise.
|
|
|
|
* @return WP_Style_Engine_Processor Returns the object to allow chaining methods.
|
|
|
|
*/
|
|
|
|
public function add_rules( $css_rules ) {
|
|
|
|
if ( ! is_array( $css_rules ) ) {
|
|
|
|
$css_rules = array( $css_rules );
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach ( $css_rules as $rule ) {
|
|
|
|
$selector = $rule->get_selector();
|
|
|
|
if ( isset( $this->css_rules[ $selector ] ) ) {
|
|
|
|
$this->css_rules[ $selector ]->add_declarations( $rule->get_declarations() );
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
$this->css_rules[ $rule->get_selector() ] = $rule;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the CSS rules as a string.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param array $options {
|
|
|
|
* Optional. An array of options. Default empty array.
|
|
|
|
*
|
|
|
|
* @type bool $optimize Whether to optimize the CSS output, e.g., combine rules. Default is `false`.
|
|
|
|
* @type bool $prettify Whether to add new lines and indents to output. Default is the test of whether the global constant `SCRIPT_DEBUG` is defined.
|
|
|
|
* }
|
|
|
|
* @return string The computed CSS.
|
|
|
|
*/
|
|
|
|
public function get_css( $options = array() ) {
|
|
|
|
$defaults = array(
|
|
|
|
'optimize' => true,
|
|
|
|
'prettify' => defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG,
|
|
|
|
);
|
|
|
|
$options = wp_parse_args( $options, $defaults );
|
|
|
|
|
|
|
|
// If we have stores, get the rules from them.
|
|
|
|
foreach ( $this->stores as $store ) {
|
|
|
|
$this->add_rules( $store->get_all_rules() );
|
|
|
|
}
|
|
|
|
|
|
|
|
// Combine CSS selectors that have identical declarations.
|
|
|
|
if ( true === $options['optimize'] ) {
|
|
|
|
$this->combine_rules_selectors();
|
|
|
|
}
|
|
|
|
|
|
|
|
// Build the CSS.
|
|
|
|
$css = '';
|
|
|
|
foreach ( $this->css_rules as $rule ) {
|
|
|
|
$css .= $rule->get_css( $options['prettify'] );
|
|
|
|
$css .= $options['prettify'] ? "\n" : '';
|
|
|
|
}
|
|
|
|
return $css;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Combines selectors from the rules store when they have the same styles.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*/
|
|
|
|
private function combine_rules_selectors() {
|
|
|
|
// Build an array of selectors along with the JSON-ified styles to make comparisons easier.
|
|
|
|
$selectors_json = array();
|
|
|
|
foreach ( $this->css_rules as $rule ) {
|
|
|
|
$declarations = $rule->get_declarations()->get_declarations();
|
|
|
|
ksort( $declarations );
|
|
|
|
$selectors_json[ $rule->get_selector() ] = wp_json_encode( $declarations );
|
|
|
|
}
|
|
|
|
|
|
|
|
// Combine selectors that have the same styles.
|
|
|
|
foreach ( $selectors_json as $selector => $json ) {
|
|
|
|
// Get selectors that use the same styles.
|
|
|
|
$duplicates = array_keys( $selectors_json, $json, true );
|
|
|
|
// Skip if there are no duplicates.
|
|
|
|
if ( 1 >= count( $duplicates ) ) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
$declarations = $this->css_rules[ $selector ]->get_declarations();
|
|
|
|
|
|
|
|
foreach ( $duplicates as $key ) {
|
|
|
|
// Unset the duplicates from the $selectors_json array to avoid looping through them as well.
|
|
|
|
unset( $selectors_json[ $key ] );
|
|
|
|
// Remove the rules from the rules collection.
|
|
|
|
unset( $this->css_rules[ $key ] );
|
|
|
|
}
|
|
|
|
// Create a new rule with the combined selectors.
|
|
|
|
$duplicate_selectors = implode( ',', $duplicates );
|
|
|
|
$this->css_rules[ $duplicate_selectors ] = new WP_Style_Engine_CSS_Rule( $duplicate_selectors, $declarations );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|