class SassMixinDefinitionNode in Sassy 7.3

SassMixinDefinitionNode class. Represents a Mixin definition. @package PHamlP @subpackage Sass.tree

Hierarchy

• class \SassNode
  • class \SassMixinDefinitionNode

File

phpsass/tree/SassMixinDefinitionNode.php, line 18

class SassMixinDefinitionNode extends SassNode {
  const NODE_IDENTIFIER = '=';
  const MATCH = '/^(=|@mixin\\s+)([-\\w]+)\\s*(?:\\((.*?)\\))?\\s*$/im';
  const IDENTIFIER = 1;
  const NAME = 2;
  const ARGUMENTS = 3;

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

  /**
   * @var array arguments for the mixin as name=>value pairs were value is the
   * default value or null for required arguments
   */
  private $args = array();

  /**
   * SassMixinDefinitionNode constructor.
   * @param object source token
   * @return SassMixinDefinitionNode
   */
  public function __construct($token) {
    if ($token->level !== 0) {
      throw new SassMixinDefinitionNodeException('Mixins can only be defined at root level', $this);
    }
    parent::__construct($token);
    preg_match(self::MATCH, $token->source, $matches);
    if (empty($matches)) {
      throw new SassMixinDefinitionNodeException('Invalid Mixin', $this);
    }
    $this->name = $matches[self::NAME];
    if (isset($matches[self::ARGUMENTS])) {
      foreach (SassScriptFunction::extractArgs($matches[self::ARGUMENTS]) as $arg) {
        $arg = explode($matches[self::IDENTIFIER] === self::NODE_IDENTIFIER ? '=' : ':', trim($arg));
        $this->args[substr(trim($arg[0]), 1)] = count($arg) == 2 ? trim($arg[1]) : null;
      }

      // foreach
    }
  }

  /**
   * Parse this node.
   * Add this mixin to  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) {
    $context
      ->addMixin($this->name, $this);
    return array();
  }

  /**
   * Returns the arguments with default values for this mixin
   * @return array the arguments with default values for this mixin
   */
  public function getArgs() {
    return $this->args;
  }

  /**
   * 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::NODE_IDENTIFIER;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SassMixinDefinitionNode::$args	private	property	default value or null for required arguments
SassMixinDefinitionNode::$name	private	property
SassMixinDefinitionNode::ARGUMENTS		constant
SassMixinDefinitionNode::getArgs	public	function	Returns the arguments with default values for this mixin
SassMixinDefinitionNode::IDENTIFIER		constant
SassMixinDefinitionNode::isa	public static	function	Returns a value indicating if the token represents this type of node. Overrides SassNode::isa
SassMixinDefinitionNode::MATCH		constant
SassMixinDefinitionNode::NAME		constant
SassMixinDefinitionNode::NODE_IDENTIFIER		constant
SassMixinDefinitionNode::parse	public	function	Parse this node. Add this mixin to the current context.
SassMixinDefinitionNode::__construct	public	function	SassMixinDefinitionNode constructor. Overrides SassNode::__construct
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.