Knowledge Base

• # Introduction
• # ERD
• # How to use
• # BaseDataKey
  • # Relations
  • # Traits
  • # Scopes
  • # Routes
  • # Services
• # BaseDataValue
  • # Relations
  • # Traits
  • # Scopes
  • # Routes
  • # Services

In all our application we use a lot of key value lists. For example client types. The purpose of BaseData is to prevent development time waste, make all our list translatable and managable by our client.

BaseDataKeys can only be created by defining them in a module file Read how. BaseDataValues can be assigned to a key in the same place. When a key is editable_by_tenant the tenant can manage the values through the manage interface. When it is not possible to manage the values by a tenant he can still maintain translations for the values.

• Values – relation to BaseDataValues
• Properties – relation to morph property
• Module – BelongsToModule trait

• BelongsToModule
• HasFactory
• BelongsToDataType
• HasPropertyValues
• HasProperties

• scopeByKey()

getBaseQueryForRole()

Get a baseQuery

    /**
     * Get the base query for base data keys
     *
     * @return mixed
     */
    protected function getBaseQueryForRole()
    {
        return $this->getModel()
            ->whereIn('module_id', $this->moduleRepository->getForRole()->pluck('id'));
    }

getForTenantWithValues()

Get all BaseDataKeys with values for the current tenant dedicted from current role.

    /**
     * Get all base data for a tenant including values
     *
     * @return Collection
     */
    public function getForTenantWithValues(): Collection
    {
        $role = UserManager::get()->currentRole;

        <...>
    }

getForTenantWithValuesAndTranslations()

Same as method getForTenantWithValues but now also with the translations

    /**
     * Get all base data for a role including values and translations
     *
     * @return mixed
     */
    public function getForRoleWithValuesAndTranslations() 

Boot

If the config base-data.use_order === true The global scope is applied setting the default sort on the attribute order

This trait ensures the response cache is flushed on updates or deletes.

• Key – relation to the BaseDataKey
• Parent – relation to a parent BaseDataValue
• Children – relation to children BaseDataValue
• Properties – relation to morph property
• Module – BelongsToModule trait

• SoftDeletes
• HasFactory
• BelongsToTenant
• TenantScopable
• HasTranslations
• HasPropertyValues

• scopeByKey()
• scopeByValue()

MarkasNotFromConfig()

Set a base data value as not_from_config now when the command blueprint:update is run this value will be skipped.

    /**
     * @param BaseDataValueContract $baseDataValue
     * @return void
     */
    public function markAsNotFromConfig(BaseDataValueContract $baseDataValue): void
    {
        $this->repository->update($baseDataValue, ['is_from_config' => false]);
    }