Feature request: add builders for namespace, use, and traits.

[hinikato]

I have similar to #61 feature request: It would be nice to add builders for namespace and use statements as well to add a capability to generate a whole PHP file: https://github.com/myak/framework/blob/master/lib/Myak/Code/CodeGenerator.php (see ns() and uses() methods). Probably builder for traits would be also useful.

[hinikato]

One note: probably uses() should be replaced with _use() and ns() with _namespace() for consistency.

[nikic]

Agree, though I think having separate builder classes for things like uses excessive (it just has the getNode method and nothing else). Maybe in these cases we can directly return the constructed node from the method in the factory? Or would that not be so good design-wise (not all values that are returned will have a getNode() method)?

@Trismegiste What do you think about this?

[Trismegiste]

I agree it seems excessive to create one builder and to call 2 methods ("ns" & "getNode") instead of chaining 2 "new". Furthermore, I think this kind of factories must be placed at the "file level".

That's why I'm planning to create a builder for PHP files (with some PSR-0/1/2 guidances) and I've put this factories for "namespace" and "use" in that builder. It's currently unfinished and unshaped and I don't believe I must be placed in PHPParser but you can see it in :
https://github.com/Trismegiste/Mondrian/blob/feature_phpfile_builder/Parser/PhpFileBuilder.php#L70

In the end you can make

$fac = new BuilderFactory();
$file = $fac->file('sample.php')
                ->ns('Kitty')
                ->declaring(
                        $fac->class('Soft')
                        ->implement('Warm')
                        ->addStmt(
                                $fac
                                ->method('purr')
                        )
                )->getNode();

[hinikato]

I agree with both points:

1. It is excessive, if Nodes can be used directly without intermediates Builders, builders can be not required.
2. File level Builder is more logically correct in this case, because BuilderFactory is factory of Builders, not Builder itself. So if Builders will not be used for namespace and use nodes, building of Nodes can be done with File level Builder.

[jimmyko]

I am looking for the same features. It seems more logical to separate them from other builders. Any schedule to port this feature?

[hinikato]

The changes above were implemented here: https://github.com/myak/framework/tree/master/lib/Myak/Code/CodeGen. I would be happy to move of them to the PhpParser, probably with some changes.

[akiessling]

Any news on this one? I'm looking for the same features, but the repo from hinikato seems to be gone

[nikic]

Trait builder has been added: 4387454

[nikic]

Namespace builder has also been added: 01643e0

[sh-dude]

Is it a possible to generate the following code using BuilderFactory and PrettyPrinter?

<?php
namespace {
    use Foo\BarTrait;
    use PHPUnit_Framework_TestCase as TestCase;

    class Test
    {
    }

    class MyTest extends TestCase
    {
    }
}

If I try to use namespace with empty name I get LogicException:

$builderFactory = new BuilderFactory();
$builder = $builderFactory->namespace(null);// ! Exception here
    // Add other statements here  
$prettyPrinter->prettyPrintFile([$builder->getNode()]);

If no please consider ability to add support of this case.

[nikic]

@sh-dude Done: f9fc2fc

[nikic]

"Use" builder added as well in 0c34706, so closing this FR.