ConfigBuilder.php

<?php

/*
 * Copyright 2011 Johannes M. Schmitt <schmittjoh@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace JMS\TranslationBundle\Translation;

final class ConfigBuilder
{
    /**
     * @var string Path to translation directory
     */
    private $translationsDir;

    /**
     * @var string
     */
    private $locale;

    /**
     * @var array
     */
    private $ignoredDomains = array();

    /**
     * @var array
     */
    private $domains = array();

    /**
     * @var string
     */
    private $outputFormat;

    /**
     * @var string
     */
    private $defaultOutputFormat = 'xlf';

    /**
     * @var array
     */
    private $scanDirs = array();

    /**
     * @var array
     */
    private $excludedDirs = array('Tests');

    /**
     * @var array
     */
    private $excludedNames = array('*Test.php', '*TestCase.php');

    /**
     * @var array
     */
    private $enabledExtractors = array();

    /**
     * @var bool
     */
    private $keepOldTranslations = false;

    /**
     * @var bool
     */
    private $keepOldTranslationsMessages  = false;

    /**
     * @var array
     */
    private $loadResources = array();

    /**
     * @static
     * @param Config $config
     * @return ConfigBuilder
     */
    public static function fromConfig(Config $config)
    {
        $builder = new self();
        $builder->setTranslationsDir($config->getTranslationsDir());
        $builder->setLocale($config->getLocale());
        $builder->setIgnoredDomains($config->getIgnoredDomains());
        $builder->setDomains($config->getDomains());
        $builder->setOutputFormat($config->getOutputFormat());
        $builder->setDefaultOutputFormat($config->getDefaultOutputFormat());
        $builder->setScanDirs($config->getScanDirs());
        $builder->setExcludedDirs($config->getExcludedDirs());
        $builder->setExcludedNames($config->getExcludedNames());
        $builder->setEnabledExtractors($config->getEnabledExtractors());
        $builder->setLoadResources($config->getLoadResources());

        return $builder;
    }

    /**
     * Sets the default output format.
     *
     * The default output format is used when the following conditions are met:
     *   - there is no existing file for the given domain
     *   - you haven't forced a format
     *
     * @param string $format
     * @return $this
     */
    public function setDefaultOutputFormat($format)
    {
        $this->defaultOutputFormat = $format;

        return $this;
    }

    /**
     * Sets the output format.
     *
     * This will force all updated domains to be in this format even if input
     * files have a different format. This will also cause input files of
     * another format to be deleted.
     *
     * @param string $format
     * @return $this
     */
    public function setOutputFormat($format)
    {
        $this->outputFormat = $format;

        return $this;
    }

    /**
     * Sets ignored domains.
     *
     * These domains are not altered by the update() command, and also do not
     * appear in the change set calculated by getChangeSet().
     *
     * @param array $domains an array of the form array('domain' => true, 'another_domain' => true)
     * @return $this
     */
    public function setIgnoredDomains(array $domains)
    {
        $this->ignoredDomains = $domains;

        return $this;
    }

    /**
     * @param string $domain
     * @return $this
     */
    public function addIgnoredDomain($domain)
    {
        $this->ignoredDomains[$domain] = true;

        return $this;
    }

    /**
     * @param array $domains
     * @return $this
     */
    public function setDomains(array $domains)
    {
        $this->domains = $domains;

        return $this;
    }

    /**
     * @param string $domain
     * @return $this
     */
    public function addDomain($domain)
    {
        $this->domains[$domain] = true;

        return $this;
    }

    /**
     * @param string $locale
     * @return $this
     */
    public function setLocale($locale)
    {
        $this->locale = $locale;

        return $this;
    }

    /**
     * @param string $dir
     * @return $this
     */
    public function setTranslationsDir($dir)
    {
        $this->translationsDir = $dir;

        return $this;
    }

    /**
     * @param array $dirs
     * @return $this
     */
    public function setScanDirs(array $dirs)
    {
        $this->scanDirs = $dirs;

        return $this;
    }

    /**
     * @param array $dirs
     * @return $this
     */
    public function setExcludedDirs(array $dirs)
    {
        $this->excludedDirs = $dirs;

        return $this;
    }

    /**
     * @param array $names
     * @return $this
     */
    public function setExcludedNames(array $names)
    {
        $this->excludedNames = $names;

        return $this;
    }

    /**
     * @param array $aliases
     * @return $this
     */
    public function setEnabledExtractors(array $aliases)
    {
        $this->enabledExtractors = $aliases;

        return $this;
    }

    /**
     * @param string $alias
     * @return $this
     */
    public function enableExtractor($alias)
    {
        $this->enabledExtractors[$alias] = true;

        return $this;
    }

    /**
     * @param string $alias
     * @return $this
     */
    public function disableExtractor($alias)
    {
        unset($this->enabledExtractors[$alias]);

        return $this;
    }

    /**
     * @param bool $value
     * @return $this
     */
    public function setKeepOldTranslations($value)
    {
        $this->keepOldTranslations = $value;

        return $this;
    }

    /**
     * @param bool $value
     * @return $this
     */
    public function setKeepOldTranslationsMessages($value)
    {
        $this->keepOldTranslationsMessages = $value;

        return $this;
    }

    /**
     * @return Config
     */
    public function getConfig()
    {
        return new Config(
            $this->translationsDir,
            $this->locale,
            $this->ignoredDomains,
            $this->domains,
            $this->outputFormat,
            $this->defaultOutputFormat,
            $this->scanDirs,
            $this->excludedDirs,
            $this->excludedNames,
            $this->enabledExtractors,
            $this->keepOldTranslations,
            $this->keepOldTranslationsMessages,
            $this->loadResources
        );
    }

    /**
     * @param array $loadResources
     * @return $this
     */
    public function setLoadResources(array $loadResources)
    {
        $this->loadResources = $loadResources;

        return $this;
    }
}