Download the PHP package symkit/settings-bundle without Composer

On this page you can find all versions of the php package symkit/settings-bundle. 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?

Example code of symkit/settings-bundle

Informations about the package settings-bundle

Settings Bundle

CI Latest Version PHPStan Level 9

A Symfony bundle for managing application-wide settings with a sectioned UI, automatic cache invalidation, and WebManifest generation. Features are activable per block (admin, webmanifest, Twig, metadata provider). Entity and repository are configurable so you can use your own classes.

Requirements

Features

Installation

  1. Install the bundle:

  2. Register the bundle in config/bundles.php:

  3. Configure Doctrine mapping in config/packages/doctrine.yaml (adjust dir/prefix if using a custom entity):

  4. Create config/packages/symkit_settings.yaml:

  5. Routes: Import only the route files for features you enable.

    • If admin.enabled is true, in config/routes.yaml:

    • If webmanifest.enabled is true:
  6. Metadata (optional)
    If metadata_provider.enabled is true, set your app’s metadata bundle to use the settings provider, e.g. in config/packages/symkit_metadata.yaml:

Configuration

Option Type Default Description
cache_expires_after int 86400 Cache TTL in seconds.
admin.enabled bool true Register admin controller and admin routes.
admin.route_prefix string admin URL prefix for admin (e.g. /admin/settings).
webmanifest.enabled bool true Register webmanifest controller and route.
twig.enabled bool true Register Twig extension (settings, app_settings()).
metadata_provider.enabled bool true Register SiteInfoProvider for symkit/metadata-bundle.
doctrine.entity string Symkit\SettingsBundle\Entity\Settings FQCN of settings entity.
doctrine.repository string Symkit\SettingsBundle\Repository\SettingsRepository FQCN of settings repository.

Disabling a feature (e.g. admin.enabled: false) means the corresponding services and routes are not registered; do not import the related route file in that case.

Custom entity and repository

Your entity must implement Symkit\SettingsBundle\Contract\SettingsInterface. Your repository must implement Symkit\SettingsBundle\Contract\SettingsRepositoryInterface and provide a constructor compatible with the bundle (e.g. ManagerRegistry + string $entityClass for a Doctrine repository).

Example:

Map your entity in Doctrine and import only the admin route if you use the bundled admin UI.

Usage

Twig (when twig.enabled is true)

PHP

Inject the manager interface:

WebManifest

When webmanifest.enabled is true and the route is imported, the manifest is served at /site.webmanifest.

Translations

The bundle uses the domain SymkitSettingsBundle and ships with translations/SymkitSettingsBundle.en.xlf and SymkitSettingsBundle.fr.xlf. You can override or add messages in your app’s translations/ directory with the same domain.

Contributing

Run make quality before committing.

License

MIT.

All versions of settings-bundle with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
symfony/framework-bundle Version ^7.0 || ^8.0
symkit/crud-bundle Version ~0.0.1
symkit/form-bundle Version ~0.0.1
symkit/media-bundle Version ~0.0.1
symkit/metadata-bundle Version ~0.0.1
symkit/menu-bundle Version ~0.0.1
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 symkit/settings-bundle contains the following files

Loading the files please wait ...