thinktomorrow / squanto

src/Domain/Translatable.php

<?php

namespace Thinktomorrow\Squanto\Domain;

use InvalidArgumentException;

/**
 * Trait Translatable
 * @author Ben Cavens
 *
 * Allows the entity to contain multiple translations
 * requires the parent entity to include the Dimsav/Translatable/Translatable trait
 *
 */
trait Translatable
{
    public function getDefaultTranslation($attribute)
    {
        if (!($translation = $this->getTranslation(config('app.fallback_locale')))) {
            return null;
        }

        return $translation->$attribute;
    }

    /**
     * Save multiple attributes at once
     *
     * @param $locale
     * @param array $values
     */
    public function updateTranslation($locale, array $values)
    {
        foreach ($values as $attribute => $value) {
            $this->setTranslation($locale, $attribute, $value);
        }

        $this->save();
    }

    /**
     * Save a single attribute
     *
     * @param $locale
     * @param $attribute
     * @param $value
     */
    public function saveTranslation($locale, $attribute, $value)
    {
        $this->setTranslation($locale, $attribute, $value);

        $this->save();
    }

    /**
     * @param $attribute
     * @param null $locale
     * @param bool $fallback | if locale not present, use fallback locale instead
     * @return string null
     */
    public function getTranslationFor($attribute, $locale = null, $fallback = true)
    {
        return (!$trans = $this->getTranslation($locale, $fallback)) ? null : $trans->$attribute;
    }

    /**
     * Create or update a translation attribute.
     * Note: only sets to entity, does not save it.
     *
     * @param $locale
     * @param $attribute
     * @param $value
     */
    private function setTranslation($locale, $attribute, $value)
    {
        $this->validateLocale($locale);

        $this->translateOrNew($locale)->$attribute = $value;
    }

    public function removeTranslation($locale)
    {
        if (!$this->hasTranslation($locale)) {
            return;
        }

        return $this->getTranslation($locale)->delete();
    }

    /**
     * Get all locales where this entity
     * already has any translations of
     *
     * @return array
     */
    public function getUsedLocales()
    {
        return $this->fetchLocales(true);
    }

    /**
     * Get all available locales where this entity
     * does not have any translations of
     *
     * @return array
     */
    public function getNonUsedLocales()
    {
        return $this->fetchLocales(false);
    }

    /**
     * Get the locales from squanto config.
     * Fallback is the list provided via the translation package
     *
     * @return array
     */
    public function getAvailableLocales()
    {
        return config('squanto.locales', config('translatable.locales', []));
    }

    /**
     * Get all locales associated with this entity
     *
     * @param bool $available
     * @return array
     */
    private function fetchLocales($available = true)
    {
        $available_locales = $this->getAvailableLocales();
        $current_locales = $this->translations()->lists('locale')->toArray();

        return array_filter($available_locales, function ($v) use ($current_locales, $available) {
            return $available ? in_array($v, $current_locales) : !in_array($v, $current_locales);
        }, ARRAY_FILTER_USE_BOTH);
    }

    /**
     * Is passed locale one of the allowed ones from config?
     *
     * @param $locale
     */
    private function validateLocale($locale)
    {
        if (!in_array($locale, $this->getAvailableLocales())) {
            throw new InvalidArgumentException('Improper locale [' . $locale . '] given or locale is not available');
        }
    }

    /**
     * Dimsav translatable trait overrides the toArray in order to
     * inject default translations. To ignore this behaviour and
     * present the actual values you should use this method.
     *
     * @return array
     */
    public function toRawArray()
    {
        return parent::toArray();

It seems like you call parent on a different method (toArray() instead of toRawArray()). Are you sure this is correct? If so, you might want to change this to $this->toArray().

    }
}