class SassFunctionDefinitionNode in Sassy 7.3

SassFunctionDefinitionNode class. Represents a Function definition. @package PHamlP @subpackage Sass.tree

Hierarchy

• class \SassNode
  • class \SassFunctionDefinitionNode

File

phpsass/tree/SassFunctionDefinitionNode.php, line 18

class SassFunctionDefinitionNode extends SassNode {
  const NODE_IDENTIFIER = '=';
  const MATCH = '/^@function\\s+([_-\\w]+)\\s*(?:\\((.*?)\\))?\\s*$/i';
  const IDENTIFIER = 1;
  const NAME = 1;
  const ARGUMENTS = 2;

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

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

  /**
   * SassFunctionDefinitionNode constructor.
   * @param object source token
   * @return SassFunctionDefinitionNode
   */
  public function __construct($token) {
    if ($token->level !== 0) {
      throw new SassMixinDefinitionNodeException('Functions 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 Function', $this);
    }
    $this->name = $matches[self::NAME];
    $this->name = preg_replace('/[^a-z0-9_]/', '_', strtolower($this->name));
    if (isset($matches[self::ARGUMENTS])) {
      if (strlen(trim($matches[self::ARGUMENTS]))) {
        foreach (explode(',', $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 function 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
      ->addFunction($this->name, $this);
    return array();
  }

  /**
   * Returns the arguments with default values for this function
   * @return array the arguments with default values for this function
   */
  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;
  }
  public function execute($pcontext, $arguments) {

    // print "execute " . $this->name . "\n";
    $context = new SassContext($pcontext);
    $argc = count($arguments);
    $count = 0;
    foreach ($this->args as $name => $value) {
      if ($count < $argc) {
        $arg = $this
          ->evaluate($arguments[$count++], $context);
        $arguments[$name] = $arg;
        $context
          ->setVariable($name, $arg);
      }
      elseif (!is_null($value)) {
        $arguments[$name] = $value;
        $context
          ->setVariable($name, $this
          ->evaluate($value, $context));
      }
      else {
        throw new SassMixinNodeException("Function::{$name}: Required variable ({$name}) not given.\nFunction defined: ' . {$this->token}->filename . '::' . {$this->token}->line . '\nFunction used", $this);
      }
    }
    $parser = $this->parent->parser;
    $lexer = $this->parent->script->lexer;
    $children = array();
    try {
      foreach ($this->children as $child) {
        $child->parent = $this;
        $children = array_merge($children, $child
          ->parse($context));
      }
    } catch (SassReturn $e) {
      return $e->value;
    }
    return new SassBoolean('false');
  }

}

Members

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