metromix/flow-bundle

Multiple action setups for Symfony2, build your checkouts/installers or whatever needs more than one step to complete.

SyliusFlowBundle

Multiple action processes with reusable steps for Symfony2 applications. Suitable for building checkouts or installations., _(*1)

Note: This bundle is a prototype, it works only with latest Symfony., _(*2)

Sylius

Sylius - Modern ecommerce for Symfony2. Visit Sylius.org., _(*3)

Usage examples

<?php

namespace Acme\Bundle\CheckoutBundle\Process\Scenario;

use Acme\Bundle\CheckoutBundle\Process\Step;
use Sylius\Bundle\FlowBundle\Process\Builder\ProcessBuilderInterface;
use Sylius\Bundle\FlowBundle\Process\Scenario\ProcessScenarioInterface;

/**
 * My super checkout.
 *
 * @author Potato Potato <potato@potato.foo>
 */
class CheckoutScenario implements ProcessScenarioInterface
{
    /**
     * {@inheritdoc}
     */
    public function build(ProcessBuilderInterface $builder)
    {
        $builder
            ->add('security', new Step\SecurityStep())
            ->add('delivery', new Step\DeliveryStep())
            ->add('billing', 'acme_checkout_step_billing')
            ->add('finalize', new Step\FinalizeStep())
        ;
    }
}

<?php

namespace Acme\Bundle\CheckoutBundle\Process\Step;

use Acme\Bundle\CheckoutBundle\Entity\Address;
use Sylius\Bundle\FlowBundle\Process\Context\ProcessContextInterface;
use Sylius\Bundle\FlowBundle\Process\Step\AbstractContainerAwareStep;

/**
 * Delivery step.
 * Allows user to select delivery method for order.
 *
 * @author Potato Potato <potato@potato.foo>
 */
class DeliveryStep extends AbstractContainerAwareStep
{
    /**
     * {@inheritdoc}
     */
    public function displayAction(ProcessContextInterface $context)
    {
        // All data is stored in a separate session bag with parameter namespace support.
        $address = $context->getStorage()->get('delivery.address');
        $form = $this->createAddressForm($address);

        return $this->container->get('templating')->renderResponse('AcmeCheckoutBundle:Step:delivery.html.twig', array(
            'form'    => $form->createView(),
            'context' => $context
        ));
    }

    /**
     * {@inheritdoc}
     */
    public function forwardAction(ProcessContextInterface $context)
    {
        $request = $context->getRequest();
        $form = $this->createAddressForm();

        if ($form->handleRequest($request)->isValid()) {
            $context->getStorage()->set('delivery.address', $form->getData());

            return $this->complete();
        }

        // Form was not valid so we display the form again.
        return $this->container->get('templating')->renderResponse('AcmeCheckoutBundle:Step:delivery.html.twig', array(
            'form'    => $form->createView(),
            'context' => $context
        ));
    }

    /**
     * Create address form.
     *
     * @param Address $address
     *
     * @return FormInterface
     */
    private function createAddressForm(Address $address = null)
    {
        return $this->container->get('form.factory')->create('acme_checkout_address', $address);
    }
}

phpunit tests

bash $ composer install $ phpunit, _(*4)

Documentation

Documentation is available on docs.sylius.org., _(*5)

Code examples

If you want to see working implementation, try out the Sylius sandbox application., _(*6)

Contributing

All informations about contributing to Sylius can be found on this page., _(*7)

Mailing lists

Users

Questions? Feel free to ask on users mailing list., _(*8)

Developers

To contribute and develop this bundle, use the developers mailing list., _(*9)

Sylius twitter account

If you want to keep up with updates, follow the official Sylius account on twitter., _(*10)

Bug tracking

This bundle uses GitHub issues. If you have found bug, please create an issue., _(*11)

Versioning

Releases will be numbered with the format major.minor.patch., _(*12)

And constructed with the following guidelines., _(*13)

• Breaking backwards compatibility bumps the major.
• New additions without breaking backwards compatibility bumps the minor.
• Bug fixes and misc changes bump the patch.

For more information on SemVer, please visit semver.org website. This versioning method is same for all Sylius bundles and applications., _(*14)

MIT License

License can be found here., _(*15)

Authors

The bundle was originally created by Paweł Jędrzejewski. See the list of contributors., _(*16)