spletna-postaja / translatable

src/Builder.php

<?php

namespace Laraplus\Data;

use Illuminate\Database\Eloquent\Builder as EloquentBuilder;

class Builder extends EloquentBuilder
{
    /**
     * Update a record in the database.
     *
     * @param array $values
     *
     * @return int
     */
    public function update(array $values)
    {
        $updated = 0;
        $modelKey = $this->getModel()->getKey();
        $modelKeyName = $this->model->getKeyName();
        $values = $this->addUpdatedAtColumn($values);
        [$values, $i18nValues] = $this->filterValues($values);
        $ids = $modelKey ? [$modelKey] : $this->pluck($modelKeyName)->all();

        if ($values) {
            $updated += $this->updateBase($values, $ids);
        }

        if ($i18nValues) {
            $updated += $this->updateI18n($i18nValues, $ids);
        }

        return $updated;
    }

    /**
     * Increment a column's value by a given amount.
     *
     * @param string $column
     * @param int $amount
     * @param array $extra
     *
     * @return int
     */
    public function increment($column, $amount = 1, array $extra = [])
    {
        $extra = $this->addUpdatedAtColumn($extra);

        return $this->noTranslationsQuery()->increment($column, $amount, $extra);
    }

    /**
     * Decrement a column's value by a given amount.
     *
     * @param string $column
     * @param int $amount
     * @param array $extra
     *
     * @return int
     */
    public function decrement($column, $amount = 1, array $extra = [])
    {
        $extra = $this->addUpdatedAtColumn($extra);

        return $this->noTranslationsQuery()->decrement($column, $amount, $extra);
    }

    /**
     * Insert a new record into the database.
     *
     * @param array $values
     *
     * @return bool
     */
    public function insert(array $values)
    {
        [$values, $i18nValues] = $this->filterValues($values);

        if ($this->query->insert($values)) {
            return $this->insertI18n($i18nValues, $values[$this->model->getKeyName()]);
        }

        return false;
    }

    /**
     * Insert a new record and get the value of the primary key.
     *
     * @param array $values
     * @param string $sequence
     *
     * @return int
     */
    public function insertGetId(array $values, $sequence = null)
    {
        [$values, $i18nValues] = $this->filterValues($values);

        if ($id = $this->query->insertGetId($values, $sequence)) {
            if ($this->insertI18n($i18nValues, $id)) {
                return $id;
            }
        }

        return false;

The expression return false returns the type false which is incompatible with the documented return type integer.

    }

    /**
     * Delete a record from the database.
     *
     * @return mixed
     */
    public function delete()
    {
        if (isset($this->onDelete)) {
            return call_user_func($this->onDelete, $this);
        }

        return $this->i18nDeleteQuery()->delete() | $this->toBase()->delete();
    }

    /**
     * Run the default delete function on the builder.
     *
     * @return mixed
     */
    public function forceDelete()
    {
        return $this->i18nDeleteQuery(false)->delete() & $this->query->delete();
    }

    /**
     * Filters translatable values from non-translatable.
     *
     * @param array $values
     *
     * @return array
     */
    protected function filterValues(array $values)
    {
        $attributes = $this->model->translatableAttributes();
        $translatable = [];

        foreach ($attributes as $key) {
            if (array_key_exists($key, $values)) {
                $translatable[$key] = $values[$key];

                unset($values[$key]);
            }
        }

        return [$values, $translatable];
    }

    /**
     * Insert translation.
     *
     * @param array $values
     * @param mixed $key
     *
     * @return bool
     */
    protected function insertI18n(array $values, $key)
    {
        if (count($values) == 0) {
            return true;
        }

        $values[$this->model->getForeignKey()] = $key;
        $values[$this->model->getLocaleKey()] = $this->model->getLocale();

        return $this->i18nQuery()->insert($values);
    }

    /**
     * Update values in base table.
     *
     * @param array $values
     * @param array $ids
     *
     * @return mixed
     */
    private function updateBase(array $values, array $ids)
    {
        $query = $this->model
            ->newQuery()
            ->whereIn($this->model->getKeyName(), $ids)
            ->getQuery();

        return $query->update($values);
    }

    /**
     * Update translations.
     *
     * @param array $values
     * @param array $ids
     *
     * @return bool
     */
    protected function updateI18n(array $values, array $ids)
    {
        if (count($values) == 0) {
            return true;
        }

        $updated = 0;

        foreach ($ids as $id) {
            $query = $this->i18nQuery()
                ->whereOriginal($this->model->getForeignKey(), $id)
                ->whereOriginal($this->model->getLocaleKey(), $this->model->getLocale());

            if ($query->exists()) {
                unset($values[$this->model->getLocaleKey()]);

                $updated += $query->update($values);
            } else {
                $updated += $this->insertI18n($values, $id);
            }
        }

        return $updated;
    }

    /**
     * Get the query builder instance for translation table.
     *
     * @return \Illuminate\Database\Query\Builder
     */
    public function i18nQuery()
    {
        $query = $this->getModel()->newQueryWithoutScopes()->getQuery();

        $query->from($this->model->getI18nTable());

        return $query;
    }

    /**
     * Get the delete query instance for translation table.
     *
     * @param bool $withGlobalScopes
     *
     * @return \Illuminate\Database\Query\Builder
     */
    protected function i18nDeleteQuery($withGlobalScopes = true)
    {
        $subQuery = $withGlobalScopes ? $this->toBase() : $this->getQuery();

        $subQuery->select($this->model->getQualifiedKeyName());

        return $this->i18nQuery()->whereIn(
            $this->model->getForeignKey(), $subQuery->pluck($this->model->getKeyName())
        );
    }

    /**
     * Get the base query without translations.
     *
     * @return \Illuminate\Database\Query\Builder
     */
    protected function noTranslationsQuery()
    {
        return $this->withoutGlobalScope(TranslatableScope::class)->toBase();
    }
}