Your IP : 216.73.216.43
<?php
/**
* This file is part of PDepend.
*
* PHP Version 5
*
* Copyright (c) 2008-2017 Manuel Pichler <mapi@pdepend.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Manuel Pichler nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @copyright 2008-2017 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
*/
namespace PDepend\Source\ASTVisitor;
use PDepend\Source\AST\ASTArtifact;
use PDepend\Source\AST\ASTClass;
use PDepend\Source\AST\ASTCompilationUnit;
use PDepend\Source\AST\ASTEnum;
use PDepend\Source\AST\ASTFunction;
use PDepend\Source\AST\ASTInterface;
use PDepend\Source\AST\ASTMethod;
use PDepend\Source\AST\ASTNamespace;
use PDepend\Source\AST\ASTNode;
use PDepend\Source\AST\ASTParameter;
use PDepend\Source\AST\ASTProperty;
use PDepend\Source\AST\ASTTrait;
/**
* Base interface for visitors that work on the generated node tree.
*
* @copyright 2008-2017 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
*/
interface ASTVisitor
{
/**
* Adds a new listener to this node visitor.
*
* @return void
*/
public function addVisitListener(ASTVisitListener $listener);
/**
* Visits a class node.
*
* @return void
*/
public function visitClass(ASTClass $class);
/**
* Visits an enum node.
*
* @return void
*/
public function visitEnum(ASTEnum $enum);
/**
* Visits a trait node.
*
* @return void
*
* @since 1.0.0
*/
public function visitTrait(ASTTrait $trait);
/**
* Visits a file node.
*
* @return void
*/
public function visitCompilationUnit(ASTCompilationUnit $compilationUnit);
/**
* Visits a function node.
*
* @return void
*/
public function visitFunction(ASTFunction $function);
/**
* Visits a code interface object.
*
* @return void
*/
public function visitInterface(ASTInterface $interface);
/**
* Visits a method node.
*
* @return void
*/
public function visitMethod(ASTMethod $method);
/**
* Visits a namespace node.
*
* @return void
*/
public function visitNamespace(ASTNamespace $namespace);
/**
* Visits a parameter node.
*
* @return void
*/
public function visitParameter(ASTParameter $parameter);
/**
* Visits a property node.
*
* @return void
*/
public function visitProperty(ASTProperty $property);
/**
* Magic call method used to provide simplified visitor implementations.
* With this method we can call <b>visit${NodeClassName}</b> on each node.
*
* <code>
* $visitor->visitAllocationExpression($alloc);
*
* $visitor->visitStatement($stmt);
* </code>
*
* All visit methods takes two argument. The first argument is the current
* context ast node and the second argument is a data array or object that
* is used to collect data.
*
* The return value of this method is the second input argument, modified
* by the concrete visit method.
*
* @param string $method Name of the called method.
* @param array<int, mixed> $args Array with method argument.
*
* @return array<string, mixed>|numeric-string
*
* @since 0.9.12
*/
public function __call($method, $args);
/**
* @template T of array<string, mixed>|numeric-string
*
* @param ASTNode $node
* @param T $value
*
* @return T
*/
public function visit($node, $value);
}