Download the PHP package nswdpc/silverstripe-field-hint without Composer

On this page you can find all versions of the php package nswdpc/silverstripe-field-hint. 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 nswdpc/silverstripe-field-hint

Informations about the package silverstripe-field-hint

Field hinting for Silverstripe forms

This module allows developers to add usage hints to form fields. Hints are just arbitrary string values.

The hints can be used by themes and templates in a project to render the field in a specific way, to be interpreted by whatever frontend UI-kit is in use for your site.

This avoids polluting module PHP code with theme-specific CSS classes.

Instead of this $field->addExtraClass('btn btn-danger'), do this $field->setHint('danger').

Default fields

Out-of-the-box the following fields are configured to support the Hintable extension:

No changes are made to the field itself, the extension just exposes some methods on the field to use in module code.

Usage

Important: In your theme or project, you need to provide a template that is used by the class using the Hintable extension. Read: template inheritance.

Forms

Set field hints on your forms:

The value of setHint is a string, it can be any value that a template can interpret.

The second parameter is whether a class should be added as an extraClass on the field based on the hint provided. Configuration provides mapping between hints and class(es).

In your FormAction template, you might add this:

Templates

Use the value of $FormFieldHint to modify how your theme/project templates render the field.

Here's an example using HTMLReadonlyField:

Icons

Set a field hint icon on a supporting field:

Configuration

There is none, unless:

Sample project configuration

Note that classes are added as extra classes, which by default in Silverstripe are added to both the field holder and the field input element. Your templates should take that into account.

Installation

The only supported way of installing this module is via composer

You may need to add a repositories entry to you composer.json, depending on packagist status.

License

BSD-3-Clause

Configuration

See _config/config.yml

Maintainers

Bugtracker

We welcome bug reports, pull requests and feature requests on the Github Issue tracker for this project.

Please review the code of conduct prior to opening a new issue.

Security

If you have found a security issue with this module, please email digital[@]dpc.nsw.gov.au in the first instance, detailing your findings.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

Please review the code of conduct prior to completing a pull request.

All versions of silverstripe-field-hint with dependencies

PHP Build Version
Package Version
Requires silverstripe/framework Version ^5
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 nswdpc/silverstripe-field-hint contains the following files

Loading the files please wait ....