https://github.com/dynamic/silverstripe-elemental-baseobject
A simple base DataObject to use with Elemental Content Blocks
https://github.com/dynamic/silverstripe-elemental-baseobject
hacktoberfest silverstripe silverstripe-elemental
Last synced: 6 months ago
JSON representation
A simple base DataObject to use with Elemental Content Blocks
- Host: GitHub
- URL: https://github.com/dynamic/silverstripe-elemental-baseobject
- Owner: dynamic
- License: bsd-3-clause
- Created: 2018-05-01T19:26:41.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-18T20:43:14.000Z (almost 2 years ago)
- Last Synced: 2024-04-23T11:18:21.861Z (about 1 year ago)
- Topics: hacktoberfest, silverstripe, silverstripe-elemental
- Language: PHP
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 9
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# Silverstripe Elemental Baseobject
a simple base dataobject to use with elements
[](https://github.com/dynamic/silverstripe-elemental-baseobject/actions/workflows/ci.yml)
[](https://codecov.io/gh/dynamic/silverstripe-elemental-baseobject)
[](https://packagist.org/packages/dynamic/silverstripe-elemental-baseobject)
[](https://packagist.org/packages/dynamic/silverstripe-elemental-baseobject)
[](https://packagist.org/packages/dynamic/silverstripe-elemental-baseobject)
[](https://packagist.org/packages/dynamic/silverstripe-elemental-baseobject)
## Requirements
* dnadesign/silverstripe-elemental: ^5.0
* silverstripe/linkfield: ^4.0
## Installation
`composer require dynamic/silverstripe-elemental-baseobject`
## License
See [License](LICENSE.md)
## Upgrading from version 2
BaseObject drops `sheadawson/silverstripe-linkable` usage in favor of `gorriecoe/silverstripe-linkfield`. To avoid data loss, install the `dynamic/silverstripe-link-migrator` module as follows:
```markdown
composer require dynamic/silverstripe-link-migrator
```
Then, run the task "Linkable to SilverStripe Link Migration" via `/dev/tasks`, or cli via:
```markdown
vendor/bin/sake dev/tasks/LinkableMigrationTask
```
This will populate all of the new Link fields with data from the old class.
## Usage
A base DataObject used in the following Elemental content blocks:
* [Accordion](https://github.com/dynamic/silverstripe-elemental-accordion)
* [Features](https://github.com/dynamic/silverstripe-elemental-features)
* [Gallery](https://github.com/dynamic/silverstripe-elemental-gallery)
* [Promos](https://github.com/dynamic/silverstripe-elemental-promos)
* [Sponsors](https://github.com/dynamic/silverstripe-elemental-sponsors)
* [Timeline](https://github.com/dynamic/silverstripe-elemental-timeline)
## Getting more elements
See [Elemental modules by Dynamic](https://github.com/orgs/dynamic/repositories?q=elemental&type=all&language=&sort=)
## Configuration
See [SilverStripe Elemental Configuration](https://github.com/silverstripe/silverstripe-elemental#configuration)
## Translations
The translations for this project are managed via [Transifex](https://www.transifex.com/dynamicagency/silverstripe-elemental-baseobject/)
and are updated automatically during the release process. To contribute, please head to the link above and get
translating!
## Maintainers
* [Dynamic](https://www.dynamicagency.com) ()
## Bugtracker
Bugs are tracked in the issues section of this repository. Before submitting an issue please read over
existing issues to ensure yours is unique.
If the issue does look like a new bug:
- Create a new issue
- Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots
and screencasts can help here.
- Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version,
Operating System, any installed SilverStripe modules.
Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.
## 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.