Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shopsys/form-types-bundle

[READ-ONLY] Easy to use custom Symfony form types
https://github.com/shopsys/form-types-bundle

Last synced: about 1 month ago
JSON representation

[READ-ONLY] Easy to use custom Symfony form types

Host: GitHub
URL: https://github.com/shopsys/form-types-bundle
Owner: shopsys
License: mit
Created: 2017-08-04T07:08:01.000Z (over 7 years ago)
Default Branch: 15.0
Last Pushed: 2024-05-22T10:36:13.000Z (7 months ago)
Last Synced: 2024-05-22T11:26:16.623Z (7 months ago)
Language: PHP
Homepage:
Size: 177 KB
Stars: 2
Watchers: 9
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # Shopsys Form Types Bundle

[![Downloads](https://img.shields.io/packagist/dt/shopsys/form-types-bundle.svg)](https://packagist.org/packages/shopsys/form-types-bundle)

Symfony bundle adding form types for usage in [Shopsys Platform](https://www.shopsys-framework.com), its components and plugins.

This repository is maintained by [shopsys/shopsys] monorepo, information about changes is in [monorepo CHANGELOG.md](https://github.com/shopsys/shopsys/blob/master/CHANGELOG.md).

## Installation

The plugin is a Symfony bundle and is installed in the same way:

### Download

First, you download the package using [Composer](https://getcomposer.org/):

```

composer require shopsys/form-types

```

## How to use a custom form type

The form types in this package are regular Symfony form types.

See [Symfony Forms Documentation](https://symfony.com/doc/current/forms.html) for detailed explanation.

## Contents

### [MultidomainType](./src/MultidomainType.php)

Compound type that renders one form of given type for each domain.

It can be configured via the following options:

-   `entry_type` - The type of the inner form.

    Defaults to `TextType::class`.

-   `entry_options` - The options of the inner forms.

    Defaults to `[]`.

-   `options_by_domain_id` - The options of the inner forms based on the domain ID.

    Provide arrays indexed by the domain ID, values are merged with the `entry_options`.

    Defaults to `[]`.

The data of the inner forms are returned as an array indexed by the domain ID.

![MultidomainType usage example](./docs/images/multidomain_type_example.png)

### [YesNoType](./src/YesNoType.php)

Natural looking choice type for boolean value inputs.

It has no notable options.

A boolean value is accepted/returned as data.

A null value can be accepted/returned when no radio button is checked.

![YesNoType usage example](./docs/images/yes_no_type_example.png)

## Contributing

Thank you for your contributions to Shopsys Form Types Bundle package.

Together we are making Shopsys Platform better.

This repository is READ-ONLY.

If you want to [report issues](https://github.com/shopsys/shopsys/issues/new) and/or send [pull requests](https://github.com/shopsys/shopsys/compare),

please use the main [Shopsys repository](https://github.com/shopsys/shopsys).

Please, check our [Contribution Guide](https://github.com/shopsys/shopsys/blob/master/CONTRIBUTING.md) before contributing.

## Support

What to do when you are in troubles or need some help?

The best way is to join our [Slack](https://join.slack.com/t/shopsysframework/shared_invite/zt-11wx9au4g-e5pXei73UJydHRQ7nVApAQ).

If you want to [report issues](https://github.com/shopsys/shopsys/issues/new), please use the main [Shopsys repository](https://github.com/shopsys/shopsys).

[shopsys/shopsys]: (https://github.com/shopsys/shopsys)