mirror of
https://github.com/WordPress/WordPress.git
synced 2024-11-06 10:50:56 +01:00
1e791f041d
This PR migrates the Style Engine PHP functions, classes and tests into Core for 6.1. It backports the original [WordPress/gutenberg#40260 PR #40260] from Gutenberg repository. Props ramonopoly, bernhard-reiter, costdev, azaozz, andrewserong, mukesh27, aristath. See #56467. Built from https://develop.svn.wordpress.org/trunk@54156 git-svn-id: http://core.svn.wordpress.org/trunk@53715 1a063a9b-81f0-0310-95a4-ce76da25c4cd
140 lines
3.7 KiB
PHP
140 lines
3.7 KiB
PHP
<?php
|
|
/**
|
|
* WP_Style_Engine_CSS_Rule
|
|
*
|
|
* An object for CSS rules.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage StyleEngine
|
|
* @since 6.1.0
|
|
*/
|
|
|
|
/**
|
|
* Class WP_Style_Engine_CSS_Rule.
|
|
*
|
|
* Holds, sanitizes, processes and prints CSS declarations for the style engine.
|
|
*
|
|
* @since 6.1.0
|
|
*/
|
|
class WP_Style_Engine_CSS_Rule {
|
|
|
|
/**
|
|
* The selector.
|
|
*
|
|
* @since 6.1.0
|
|
* @var string
|
|
*/
|
|
protected $selector;
|
|
|
|
/**
|
|
* The selector declarations.
|
|
*
|
|
* Contains a WP_Style_Engine_CSS_Declarations object.
|
|
*
|
|
* @since 6.1.0
|
|
* @var WP_Style_Engine_CSS_Declarations
|
|
*/
|
|
protected $declarations;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @since 6.1.0
|
|
*
|
|
* @param string $selector The CSS selector.
|
|
* @param string[]|WP_Style_Engine_CSS_Declarations $declarations An associative array of CSS definitions, e.g., array( "$property" => "$value", "$property" => "$value" ),
|
|
* or a WP_Style_Engine_CSS_Declarations object.
|
|
*/
|
|
public function __construct( $selector = '', $declarations = array() ) {
|
|
$this->set_selector( $selector );
|
|
$this->add_declarations( $declarations );
|
|
}
|
|
|
|
/**
|
|
* Sets the selector.
|
|
*
|
|
* @since 6.1.0
|
|
*
|
|
* @param string $selector The CSS selector.
|
|
*
|
|
* @return WP_Style_Engine_CSS_Rule Returns the object to allow chaining of methods.
|
|
*/
|
|
public function set_selector( $selector ) {
|
|
$this->selector = $selector;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Sets the declarations.
|
|
*
|
|
* @since 6.1.0
|
|
*
|
|
* @param array|WP_Style_Engine_CSS_Declarations $declarations An array of declarations (property => value pairs),
|
|
* or a WP_Style_Engine_CSS_Declarations object.
|
|
*
|
|
* @return WP_Style_Engine_CSS_Rule Returns the object to allow chaining of methods.
|
|
*/
|
|
public function add_declarations( $declarations ) {
|
|
$is_declarations_object = ! is_array( $declarations );
|
|
$declarations_array = $is_declarations_object ? $declarations->get_declarations() : $declarations;
|
|
|
|
if ( null === $this->declarations ) {
|
|
if ( $is_declarations_object ) {
|
|
$this->declarations = $declarations;
|
|
return $this;
|
|
}
|
|
$this->declarations = new WP_Style_Engine_CSS_Declarations( $declarations_array );
|
|
}
|
|
$this->declarations->add_declarations( $declarations_array );
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the declarations object.
|
|
*
|
|
* @since 6.1.0
|
|
*
|
|
* @return WP_Style_Engine_CSS_Declarations The declarations object.
|
|
*/
|
|
public function get_declarations() {
|
|
return $this->declarations;
|
|
}
|
|
|
|
/**
|
|
* Gets the full selector.
|
|
*
|
|
* @since 6.1.0
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_selector() {
|
|
return $this->selector;
|
|
}
|
|
|
|
/**
|
|
* Gets the CSS.
|
|
*
|
|
* @since 6.1.0
|
|
*
|
|
* @param bool $should_prettify Whether to add spacing, new lines and indents.
|
|
* @param number $indent_count The number of tab indents to apply to the rule. Applies if `prettify` is `true`.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_css( $should_prettify = false, $indent_count = 0 ) {
|
|
$rule_indent = $should_prettify ? str_repeat( "\t", $indent_count ) : '';
|
|
$declarations_indent = $should_prettify ? $indent_count + 1 : 0;
|
|
$suffix = $should_prettify ? "\n" : '';
|
|
$spacer = $should_prettify ? ' ' : '';
|
|
$selector = $should_prettify ? str_replace( ',', ",\n", $this->get_selector() ) : $this->get_selector();
|
|
$css_declarations = $this->declarations->get_declarations_string( $should_prettify, $declarations_indent );
|
|
|
|
if ( empty( $css_declarations ) ) {
|
|
return '';
|
|
}
|
|
|
|
return "{$rule_indent}{$selector}{$spacer}{{$suffix}{$css_declarations}{$suffix}{$rule_indent}}";
|
|
}
|
|
}
|