Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pointybeard/symext-yaml-field
A field for Symphony CMS that validates and stores YAML formatted data.
https://github.com/pointybeard/symext-yaml-field
Last synced: 9 days ago
JSON representation
A field for Symphony CMS that validates and stores YAML formatted data.
- Host: GitHub
- URL: https://github.com/pointybeard/symext-yaml-field
- Owner: pointybeard
- License: other
- Created: 2020-12-12T02:31:06.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-04T01:34:58.000Z (over 2 years ago)
- Last Synced: 2024-10-12T06:21:06.100Z (about 1 month ago)
- Language: PHP
- Size: 12.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# YAML Field for Symphony CMS
A field for [Symphony CMS][ext-Symphony-cms] that validates and stores YAML formatted data.
- [Installation](#installation)
- [With Git and Composer](#with-git-and-composer)
- [With Orchestra](#with-orchestra)
- [Basic Usage](#basic-usage)
- [About](#about)
- [Requirements](#dependencies)
- [Dependencies](#dependencies)
- [Support](#support)
- [Contributing](#contributing)
- [License](#license)
## Installation
This is an extension for [Symphony CMS][ext-Symphony-cms]. Add it to the `/extensions` folder of your Symphony CMS installation, then enable it though the interface.
### With Git and Composer
```bash
$ git clone --depth 1 https://github.com/pointybeard/symext-yaml-field.git extensions/yamlfield
$ composer update -vv --profile -d ./extensions/yamlfield
```
After finishing the steps above, enable "Field: YAML" though the administration interface or, if using [Orchestra][ext-Orchestra], with `bin/extension enable yamlfield`.
### With Orchestra
1. Add the following extension defintion to your `.orchestra/build.json` file in the `"extensions"` block:
```json
{
"name": "yamlfield",
"repository": {
"url": "https://github.com/pointybeard/symext-yaml-field.git"
}
}
```
2. Run the following command to rebuild your Extensions
```bash
$ bin/orchestra build \
--skip-import-sections \
--database-skip-import-data \
--database-skip-import-structure \
--skip-create-author \
--skip-seeders \
--skip-git-reset \
--skip-composer \
--skip-postbuild
```
## Basic Usage
This extension adds a new field called "Yaml". It can be added to sections like any other field. It functions in a similar way to a Text Box field, however, upon saving it will validate the contents and throw an error if it is not valid YAML.
## About
### Requirements
- This extension works with PHP 7.4 or above.
### Dependencies
This extension depends on the following Composer libraries:
- [PHP Helpers][dep-helpers]
- [Symphony CMS: Extended Base Class Library][dep-symphony-extended]
- [Dallgoot: YAML library for PHP][dep-dallgoot-yaml]
## Support
If you believe you have found a bug, please report it using the [GitHub issue tracker][ext-issues],
or better yet, fork the library and submit a pull request.
## Contributing
We encourage you to contribute to this project. Please check out the [Contributing to this project][doc-CONTRIBUTING] documentation for guidelines about how to get involved.
## Author
- Alannah Kearney -
- See also the list of [contributors][ext-contributor] who participated in this project
## License
"YAML Field for Symphony CMS" is released under the MIT License. See [LICENCE][doc-LICENCE] for details.
[doc-CONTRIBUTING]: https://github.com/pointybeard/symext-yaml-field/blob/master/CONTRIBUTING.md
[doc-LICENCE]: http://www.opensource.org/licenses/MIT
[dep-helpers]: https://github.com/pointybeard/helpers
[dep-dallgoot-yaml]: https://github.com/dallgoot/yaml
[dep-symphony-extended]: https://github.com/pointybeard/symphony-extended
[ext-issues]: https://github.com/pointybeard/symext-yaml-field/issues
[ext-Symphony-cms]: http://getsymphony.com
[ext-Orchestra]: https://github.com/pointybeard/orchestra
[ext-contributor]: https://github.com/pointybeard/symext-yaml-field/contributors
[ext-docs]: https://github.com/pointybeard/symext-yaml-field/blob/master/.docs/toc.md