Download the PHP package tatter/settings without Composer

On this page you can find all versions of the php package tatter/settings. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package settings

Tatter\Settings

Lightweight settings management for CodeIgniter 4

Coverage Status

WARNING

Since this library's last major version the CodeIgniter team has published its own Settings Library. That library and this offer some non-overlapping features but they do represent a conflict in name and implementation. The future of this library is not yet determined, but some options are:

To follow or contribute to the planning for this library please visit the Upcoming Changes Discussion.

Quick Start

  1. Install with Composer: > composer require tatter/settings
  2. Update the database: > php spark migrate -all
  3. Use spark to create templates: > php spark settings:add timezone user America/New_York
  4. Use the service to access user settings:

Features

Provides ready-to-use settings management for CodeIgniter 4

Installation

Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities and always be up-to-date:

Or, install manually by downloading the source files and adding the directory to app/Config/Autoload.php.

Once the files are downloaded and included in the autoload, run any library migrations to ensure the database is setup correctly:

Usage

Once the library is included all the resources are ready to go and you are ready to start adding settings. You may import setting templates directly into the settings table or add them manually with the CLI command php spark settings:add.

Settings also comes with a database seeder for some recommended default templates. Run the seeder from the command line:

php spark db:seed "Tatter\Settings\Database\Seeds\SettingsSeeder"

This will add appropriately-scoped templates and default values for the following settings:

Name Description Data Type Default Value Protected
siteVersion Current version of this project string 1.0.0 Yes
brandName Brand name for this project string Brand Yes
brandLogo Brand logo for this project string /assets/images/logo.png Yes
orgName Your organization name string Organization Yes
orgLogo Your organization logo string /assets/images/logo.png Yes
orgUrl Your organization URL uri https://example.com Yes
orgAddress Your organization address string 4141 Postmark Dr Anchorage, AK Yes
orgPhone Your organization phone string (951) 262-3062 Yes
currencyUnit Currency format for number helper string USD Yes
currencyScale Conversion rate to the fractional monetary unit int 100 Yes
databaseTimezone Timezone for the database server(s string UTC Yes
serverTimezone Timezone for the web server(s) string UTC Yes
timezone Timezone for the user string America/New_York No
theme Site display theme int 1 No
perPage Number of items to show per page int 10 No

Warning: This list is subject to change between major versions.

Note that the seeder will not overwrite existing values so it is safe to re-run at any time. See also src/Database/Seeds/SettingsSeeder.php.

Setting Scope

Settings come in three modes: global, user, and dynamic.

Examples:

Name Scope Content Notes Protected?
latestRelease Global 0.7.6 Git-style tag of latest code release 1
timezone User America/New_York Local timezone to use across the application 0
perPage User 10 Default number of items to show per page 0
jobsSearch Dynamic backend php User's most recent search term for jobs n/a

Magic Config

Settings comes with a magic configuration file that allows direct access to template values. This is a convenient way to access the library in a traditional framework fashion:

$logo = config('Settings')->projectLogo;

Note that unlike the Service or Library values from the magic config are directly from the template default and are not affected by user overrides:

service('settings')->set('perPage', 20);

echo service('settings')->perPage; // 20
echo config('Settings')->perPage; // 10

All versions of settings with dependencies

PHP Build Version
Package Version
Requires php Version ^7.3 || ^8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package tatter/settings contains the following files

Loading the files please wait ....