README

Description

Generates and persists seed data. Derived from Soyuka's seed bundle: https://github.com/soyuka/SeedBundle

Configuration

ds_restauration_seed:
  prefix: 'seed' # Command prefix "seed:yourseedname"
  directory: 'Seeds' # Default seed path: Bundle/Seeds
  separator: ':'
  seed_order: # Order to load seeds in, lowest loads first.  Any seed not in the list defaults to an order of 0
    seed1: -1
    seed2: 1
  seed_bundle: # Order to load bundles in, lowest loads first.  Any bundles not in the list defaults to an order of 0
    bundle1: -1
    bundle2: 1

Building a Seed

The Seed class is a Command and :

Must extend DsRestauration\SeedBundle\Command\Seed
Must have a class name that ends by Seed
Must call setSeedName in the configure method

<?php

namespace AcmeBundle\ISOBundle\Seeds;

use DsRestauration\SeedBundle\Command\Seed;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

use Symfony\Component\Yaml\Parser;
use AcmeBundle\ISOBundle\Entity\Country;

class CountrySeed extends Seed
{

    protected function configure()
    {
        //The seed won't load if this is not set
        //The resulting command will be {prefix}:country
        $this->setSeedName('country');
        //Needed if you want to load seeds by bundle
        $this->setBundleName('geo');

        parent::configure();
    }

    public function load(InputInterface $input, OutputInterface $output){

        //Doctrine logging eats a lot of memory, this is a wrapper to disable logging
        $this->disableDoctrineLogging();

        //Access doctrine through $this->doctrine
        $countryRepository = $this->doctrine->getRepository('AcmeISOBundle:Country');

        $yaml = new Parser();

        //for example, using umpirsky/country-list (lazy yaml)
        $countries = $yaml->parse(file_get_contents('vendor/umpirsky/country-list/country/cldr/fr/country.yaml'));

        foreach ($countries as $id => $country) {

            if($countryRepository->findOneById($id)) {
                continue;
            }

            $e = new Country();

            $e->setId($id);
            $e->setName($country);

            //Doctrine manager is also available
            $this->manager->persist($e);

            $this->manager->flush();
        }

        $this->manager->clear();
    }
}

Loading a seed

The SeedBundle gives you two default commands and one for each seed you made. With the previous example, I'd have:

app/console seed:load #calls the load method of every seed
app/console seed:unload #calls the unload method of every seed
app/console seed:country

The global seed:load and seed:unload allow you to run multiple seeds in one command. You can of course skip seeds app/console seed:load --skip Town but also name the one you want app/console seed:load Country. For more informations, please use app/console seed:load --help.

Seed order

Seed order is defined in the configuration file. Seeds with the lowest order are loaded first. Any seeds for whom the order is not defined will default to order 0 (will load first).

Bundle order

Similar to seed order, bundle order is defined in the configuration file. Bundles with the lowest order are loaded first. Any bundles for whom the order is not defined will default to order 0 (will load first).

Loading seeds by bundle/s

Can be done with the --bundle or -bn option of seed:load (seed:load --bundle geo --bundle params) In this example, only those seeds who have had their bundle defined as 'geo' or 'params' will be loaded.

Loading particular seeds only

Can be done with the --seed or -s option of seed:load (seed:load --seed countries --seed regions) In this example, only those seeds who have had their seed defined as 'countries' or 'regions' will be loaded.

Skipping seeds

One or more seeds can be skipped with the '--skip' parameter

Skipping bundles

One or more bundles can be skipped with the '--skip-bundle' parameter

Licence

The MIT License (MIT)

Copyright (c) 2019 Ds Restauration
Copyright for the original project (Soyuka\SeedBundle) is held by Antoine Bluchet, 2015

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

ds-restauration / seed-bundle

Maintainers

Details