class SassVariableNode in Sassy 7.3

SassVariableNode class. Represents a variable. @package PHamlP @subpackage Sass.tree

Hierarchy

• class \SassNode
  • class \SassVariableNode

File

phpsass/tree/SassVariableNode.php, line 18

class SassVariableNode extends SassNode {
  const MATCH = '/^([!$])([\\w-]+)\\s*:?\\s*((\\|\\|)?=)?\\s*(.+?)\\s*(!default)?;?$/i';
  const IDENTIFIER = 1;
  const NAME = 2;
  const SASS_ASSIGNMENT = 3;
  const SASS_DEFAULT = 4;
  const VALUE = 5;
  const SCSS_DEFAULT = 6;
  const SASS_IDENTIFIER = '!';
  const SCSS_IDENTIFIER = '$';

  /**
   * @var string name of the variable
   */
  private $name;

  /**
   * @var string value of the variable or expression to evaluate
   */
  private $value;

  /**
   * @var boolean whether the variable is optionally assigned
   */
  private $isDefault;

  /**
   * SassVariableNode constructor.
   * @param object source token
   * @return SassVariableNode
   */
  public function __construct($token) {
    parent::__construct($token);
    preg_match(self::MATCH, $token->source, $matches);
    if (empty($matches[self::NAME]) || $matches[self::VALUE] === '') {
      throw new SassVariableNodeException('Invalid variable definition; name and expression required', $this);
    }
    $this->name = $matches[self::NAME];
    $this->value = $matches[self::VALUE];
    $this->isDefault = !empty($matches[self::SASS_DEFAULT]) || !empty($matches[self::SCSS_DEFAULT]);

    // Warn about deprecated features
    if ($matches[self::IDENTIFIER] === self::SASS_IDENTIFIER) {
      $this
        ->addWarning('Variables prefixed with "!" is deprecated; use "' . $this->name . '"');
    }
    if (!empty($matches[SassVariableNode::SASS_ASSIGNMENT])) {
      $this
        ->addWarning('Setting variables with "' . (!empty($matches[SassVariableNode::SASS_DEFAULT]) ? '||' : '') . '=" is deprecated; use "$' . $this->name . ': ' . $this->value . (!empty($matches[SassVariableNode::SASS_DEFAULT]) ? ' !default' : ''));
    }
  }

  /**
   * Parse this node.
   * Sets the variable in the current context.
   * @param SassContext the context in which this node is parsed
   * @return array the parsed node - an empty array
   */
  public function parse($context) {
    if (!$this->isDefault || !$context
      ->hasVariable($this->name)) {
      $context
        ->setVariable($this->name, $this
        ->evaluate($this->value, $context));
    }
    $this
      ->parseChildren($context);

    // Parse any warnings
    return array();
  }

  /**
   * Returns a value indicating if the token represents this type of node.
   * @param object token
   * @return boolean true if the token represents this type of node, false if not
   */
  public static function isa($token) {
    return $token->source[0] === self::SASS_IDENTIFIER || $token->source[0] === self::SCSS_IDENTIFIER;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SassNode::$children	public	property
SassNode::$parent	public	property		1
SassNode::$root	public	property
SassNode::$token	public	property
SassNode::addChild	public	function	Adds a child to this node.
SassNode::addWarning	public	function	Adds a warning to the node.
SassNode::evaluate	public	function	Evaluates a SassScript expression.
SassNode::getChildren	public	function	Returns the node's children
SassNode::getDebug_info	public	function	Returns the debug_info option setting for this node
SassNode::getFilename	public	function	Returns the filename for this node
SassNode::getLastChild	public	function	Returns the last child node of this node.
SassNode::getLevel	public	function	Returns the level of this node.
SassNode::getLine	public	function	Returns the line number for this node
SassNode::getLine_numbers	public	function	Returns the line_numbers option setting for this node
SassNode::getParent	public	function	Returns the node's parent
SassNode::getParser	public	function	Returns the Sass parser.
SassNode::getPropertySyntax	public	function	Returns the property syntax being used.
SassNode::getRenderer	public	function	Returns the renderer.
SassNode::getScript	public	function	Returns the SassScript parser.
SassNode::getSource	public	function	Returns the source for this node
SassNode::getStyle	public	function	Returns the render style of the document tree.
SassNode::getVendor_properties	public	function	Returns vendor specific properties
SassNode::hasChildren	public	function	Returns a value indicating if this node has children
SassNode::hasParent	public	function	Return a value indicating if this node has a parent
SassNode::inDirective	public	function	Returns a value indicating whether this node is in a directive
SassNode::inSassScriptDirective	public	function	Returns a value indicating whether this node is in a SassScript directive
SassNode::interpolate	public	function	Replace interpolated SassScript contained in '#{}' with the parsed value.
SassNode::isChildOf	public	function	Returns a value indicating if this node is a child of the passed node. This just checks the levels of the nodes. If this node is at a greater level than the passed node if is a child of it.
SassNode::parseChildren	public	function	Parse the children of the node.
SassNode::__clone	public	function	Resets children when cloned
SassNode::__get	public	function	Getter.
SassNode::__set	public	function	Setter.
SassVariableNode::$isDefault	private	property
SassVariableNode::$name	private	property
SassVariableNode::$value	private	property
SassVariableNode::IDENTIFIER		constant
SassVariableNode::isa	public static	function	Returns a value indicating if the token represents this type of node. Overrides SassNode::isa
SassVariableNode::MATCH		constant
SassVariableNode::NAME		constant
SassVariableNode::parse	public	function	Parse this node. Sets the variable in the current context.
SassVariableNode::SASS_ASSIGNMENT		constant
SassVariableNode::SASS_DEFAULT		constant
SassVariableNode::SASS_IDENTIFIER		constant
SassVariableNode::SCSS_DEFAULT		constant
SassVariableNode::SCSS_IDENTIFIER		constant
SassVariableNode::VALUE		constant
SassVariableNode::__construct	public	function	SassVariableNode constructor. Overrides SassNode::__construct