Chris@13: <?php declare(strict_types=1);
Chris@0: 
Chris@0: namespace PhpParser;
Chris@0: 
Chris@13: use PhpParser\Node\Arg;
Chris@13: use PhpParser\Node\Expr;
Chris@13: use PhpParser\Node\Expr\BinaryOp\Concat;
Chris@13: use PhpParser\Node\Identifier;
Chris@13: use PhpParser\Node\Name;
Chris@13: use PhpParser\Node\Scalar\String_;
Chris@0: use PhpParser\Node\Stmt\Use_;
Chris@0: 
Chris@0: class BuilderFactory
Chris@0: {
Chris@0:     /**
Chris@0:      * Creates a namespace builder.
Chris@0:      *
Chris@0:      * @param null|string|Node\Name $name Name of the namespace
Chris@0:      *
Chris@0:      * @return Builder\Namespace_ The created namespace builder
Chris@0:      */
Chris@13:     public function namespace($name) : Builder\Namespace_ {
Chris@0:         return new Builder\Namespace_($name);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a class builder.
Chris@0:      *
Chris@0:      * @param string $name Name of the class
Chris@0:      *
Chris@0:      * @return Builder\Class_ The created class builder
Chris@0:      */
Chris@13:     public function class(string $name) : Builder\Class_ {
Chris@0:         return new Builder\Class_($name);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates an interface builder.
Chris@0:      *
Chris@0:      * @param string $name Name of the interface
Chris@0:      *
Chris@0:      * @return Builder\Interface_ The created interface builder
Chris@0:      */
Chris@13:     public function interface(string $name) : Builder\Interface_ {
Chris@0:         return new Builder\Interface_($name);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a trait builder.
Chris@0:      *
Chris@0:      * @param string $name Name of the trait
Chris@0:      *
Chris@0:      * @return Builder\Trait_ The created trait builder
Chris@0:      */
Chris@13:     public function trait(string $name) : Builder\Trait_ {
Chris@0:         return new Builder\Trait_($name);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@17:      * Creates a trait use builder.
Chris@17:      *
Chris@17:      * @param Node\Name|string ...$traits Trait names
Chris@17:      *
Chris@17:      * @return Builder\TraitUse The create trait use builder
Chris@17:      */
Chris@17:     public function useTrait(...$traits) : Builder\TraitUse {
Chris@17:         return new Builder\TraitUse(...$traits);
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@17:      * Creates a trait use adaptation builder.
Chris@17:      *
Chris@17:      * @param Node\Name|string|null  $trait  Trait name
Chris@17:      * @param Node\Identifier|string $method Method name
Chris@17:      *
Chris@17:      * @return Builder\TraitUseAdaptation The create trait use adaptation builder
Chris@17:      */
Chris@17:     public function traitUseAdaptation($trait, $method = null) : Builder\TraitUseAdaptation {
Chris@17:         if ($method === null) {
Chris@17:             $method = $trait;
Chris@17:             $trait = null;
Chris@17:         }
Chris@17: 
Chris@17:         return new Builder\TraitUseAdaptation($trait, $method);
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@0:      * Creates a method builder.
Chris@0:      *
Chris@0:      * @param string $name Name of the method
Chris@0:      *
Chris@0:      * @return Builder\Method The created method builder
Chris@0:      */
Chris@13:     public function method(string $name) : Builder\Method {
Chris@0:         return new Builder\Method($name);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a parameter builder.
Chris@0:      *
Chris@0:      * @param string $name Name of the parameter
Chris@0:      *
Chris@0:      * @return Builder\Param The created parameter builder
Chris@0:      */
Chris@13:     public function param(string $name) : Builder\Param {
Chris@0:         return new Builder\Param($name);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a property builder.
Chris@0:      *
Chris@0:      * @param string $name Name of the property
Chris@0:      *
Chris@0:      * @return Builder\Property The created property builder
Chris@0:      */
Chris@13:     public function property(string $name) : Builder\Property {
Chris@0:         return new Builder\Property($name);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a function builder.
Chris@0:      *
Chris@0:      * @param string $name Name of the function
Chris@0:      *
Chris@0:      * @return Builder\Function_ The created function builder
Chris@0:      */
Chris@13:     public function function(string $name) : Builder\Function_ {
Chris@0:         return new Builder\Function_($name);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a namespace/class use builder.
Chris@0:      *
Chris@17:      * @param Node\Name|string $name Name of the entity (namespace or class) to alias
Chris@0:      *
Chris@17:      * @return Builder\Use_ The created use builder
Chris@0:      */
Chris@13:     public function use($name) : Builder\Use_ {
Chris@0:         return new Builder\Use_($name, Use_::TYPE_NORMAL);
Chris@0:     }
Chris@0: 
Chris@13:     /**
Chris@17:      * Creates a function use builder.
Chris@17:      *
Chris@17:      * @param Node\Name|string $name Name of the function to alias
Chris@17:      *
Chris@17:      * @return Builder\Use_ The created use function builder
Chris@17:      */
Chris@17:     public function useFunction($name) : Builder\Use_ {
Chris@17:         return new Builder\Use_($name, Use_::TYPE_FUNCTION);
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@17:      * Creates a constant use builder.
Chris@17:      *
Chris@17:      * @param Node\Name|string $name Name of the const to alias
Chris@17:      *
Chris@17:      * @return Builder\Use_ The created use const builder
Chris@17:      */
Chris@17:     public function useConst($name) : Builder\Use_ {
Chris@17:         return new Builder\Use_($name, Use_::TYPE_CONSTANT);
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@13:      * Creates node a for a literal value.
Chris@13:      *
Chris@13:      * @param Expr|bool|null|int|float|string|array $value $value
Chris@13:      *
Chris@13:      * @return Expr
Chris@13:      */
Chris@13:     public function val($value) : Expr {
Chris@13:         return BuilderHelpers::normalizeValue($value);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@17:      * Creates variable node.
Chris@17:      *
Chris@17:      * @param string|Expr $name Name
Chris@17:      *
Chris@17:      * @return Expr\Variable
Chris@17:      */
Chris@17:     public function var($name) : Expr\Variable {
Chris@17:         if (!\is_string($name) && !$name instanceof Expr) {
Chris@17:             throw new \LogicException('Variable name must be string or Expr');
Chris@17:         }
Chris@17: 
Chris@17:         return new Expr\Variable($name);
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@13:      * Normalizes an argument list.
Chris@13:      *
Chris@13:      * Creates Arg nodes for all arguments and converts literal values to expressions.
Chris@13:      *
Chris@13:      * @param array $args List of arguments to normalize
Chris@13:      *
Chris@13:      * @return Arg[]
Chris@13:      */
Chris@13:     public function args(array $args) : array {
Chris@13:         $normalizedArgs = [];
Chris@13:         foreach ($args as $arg) {
Chris@13:             if ($arg instanceof Arg) {
Chris@13:                 $normalizedArgs[] = $arg;
Chris@13:             } else {
Chris@13:                 $normalizedArgs[] = new Arg(BuilderHelpers::normalizeValue($arg));
Chris@13:             }
Chris@13:         }
Chris@13:         return $normalizedArgs;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Creates a function call node.
Chris@13:      *
Chris@13:      * @param string|Name|Expr $name Function name
Chris@13:      * @param array            $args Function arguments
Chris@13:      *
Chris@13:      * @return Expr\FuncCall
Chris@13:      */
Chris@13:     public function funcCall($name, array $args = []) : Expr\FuncCall {
Chris@13:         return new Expr\FuncCall(
Chris@13:             BuilderHelpers::normalizeNameOrExpr($name),
Chris@13:             $this->args($args)
Chris@13:         );
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Creates a method call node.
Chris@13:      *
Chris@13:      * @param Expr                   $var  Variable the method is called on
Chris@13:      * @param string|Identifier|Expr $name Method name
Chris@13:      * @param array                  $args Method arguments
Chris@13:      *
Chris@13:      * @return Expr\MethodCall
Chris@13:      */
Chris@13:     public function methodCall(Expr $var, $name, array $args = []) : Expr\MethodCall {
Chris@13:         return new Expr\MethodCall(
Chris@13:             $var,
Chris@13:             BuilderHelpers::normalizeIdentifierOrExpr($name),
Chris@13:             $this->args($args)
Chris@13:         );
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Creates a static method call node.
Chris@13:      *
Chris@13:      * @param string|Name|Expr       $class Class name
Chris@13:      * @param string|Identifier|Expr $name  Method name
Chris@13:      * @param array                  $args  Method arguments
Chris@13:      *
Chris@13:      * @return Expr\StaticCall
Chris@13:      */
Chris@13:     public function staticCall($class, $name, array $args = []) : Expr\StaticCall {
Chris@13:         return new Expr\StaticCall(
Chris@13:             BuilderHelpers::normalizeNameOrExpr($class),
Chris@13:             BuilderHelpers::normalizeIdentifierOrExpr($name),
Chris@13:             $this->args($args)
Chris@13:         );
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Creates an object creation node.
Chris@13:      *
Chris@13:      * @param string|Name|Expr $class Class name
Chris@13:      * @param array            $args  Constructor arguments
Chris@13:      *
Chris@13:      * @return Expr\New_
Chris@13:      */
Chris@13:     public function new($class, array $args = []) : Expr\New_ {
Chris@13:         return new Expr\New_(
Chris@13:             BuilderHelpers::normalizeNameOrExpr($class),
Chris@13:             $this->args($args)
Chris@13:         );
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Creates a constant fetch node.
Chris@13:      *
Chris@13:      * @param string|Name $name Constant name
Chris@13:      *
Chris@13:      * @return Expr\ConstFetch
Chris@13:      */
Chris@13:     public function constFetch($name) : Expr\ConstFetch {
Chris@13:         return new Expr\ConstFetch(BuilderHelpers::normalizeName($name));
Chris@13:     }
Chris@17:     
Chris@17:     /**
Chris@17:      * Creates a property fetch node.
Chris@17:      *
Chris@17:      * @param Expr                   $var  Variable holding object
Chris@17:      * @param string|Identifier|Expr $name Property name
Chris@17:      *
Chris@17:      * @return Expr\PropertyFetch
Chris@17:      */
Chris@17:     public function propertyFetch(Expr $var, $name) : Expr\PropertyFetch {
Chris@17:         return new Expr\PropertyFetch($var, BuilderHelpers::normalizeIdentifierOrExpr($name));
Chris@17:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Creates a class constant fetch node.
Chris@13:      *
Chris@13:      * @param string|Name|Expr  $class Class name
Chris@13:      * @param string|Identifier $name  Constant name
Chris@13:      *
Chris@13:      * @return Expr\ClassConstFetch
Chris@13:      */
Chris@13:     public function classConstFetch($class, $name): Expr\ClassConstFetch {
Chris@13:         return new Expr\ClassConstFetch(
Chris@13:             BuilderHelpers::normalizeNameOrExpr($class),
Chris@13:             BuilderHelpers::normalizeIdentifier($name)
Chris@13:         );
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Creates nested Concat nodes from a list of expressions.
Chris@13:      *
Chris@13:      * @param Expr|string ...$exprs Expressions or literal strings
Chris@13:      *
Chris@13:      * @return Concat
Chris@13:      */
Chris@13:     public function concat(...$exprs) : Concat {
Chris@13:         $numExprs = count($exprs);
Chris@13:         if ($numExprs < 2) {
Chris@13:             throw new \LogicException('Expected at least two expressions');
Chris@0:         }
Chris@0: 
Chris@13:         $lastConcat = $this->normalizeStringExpr($exprs[0]);
Chris@13:         for ($i = 1; $i < $numExprs; $i++) {
Chris@13:             $lastConcat = new Concat($lastConcat, $this->normalizeStringExpr($exprs[$i]));
Chris@13:         }
Chris@13:         return $lastConcat;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * @param string|Expr $expr
Chris@13:      * @return Expr
Chris@13:      */
Chris@13:     private function normalizeStringExpr($expr) : Expr {
Chris@13:         if ($expr instanceof Expr) {
Chris@13:             return $expr;
Chris@13:         }
Chris@13: 
Chris@13:         if (\is_string($expr)) {
Chris@13:             return new String_($expr);
Chris@13:         }
Chris@13: 
Chris@13:         throw new \LogicException('Expected string or Expr');
Chris@0:     }
Chris@0: }