silverstripe/tagfield

Tag field for Silverstripe

Installs: 55 454

Dependents: 5

Suggesters: 0

Stars: 47

Watchers: 13

Forks: 42

Open Issues: 17

Language:JavaScript

Type:silverstripe-module

1.3.1 2016-08-08 02:31 UTC

README

Custom tag input field, for SilverStripe.

Build Status Code Quality Code Coverage Version License

Requirements

  • SilverStripe 3.1 or newer
  • Database: MySQL 5+, SQLite3, Postgres 8.3, SQL Server 2008

Installing

$ composer require silverstripe/tagfield

Using

Relational Tags

class BlogPost extends DataObject {
    private static $many_many = array(
        'BlogTags' => 'BlogTag'
    );
}
class BlogTag extends DataObject {
    private static $db = array(
        'Title' => 'Varchar(200)',
    );

    private static $belongs_many_many = array(
        'BlogPosts' => 'BlogPost'
    );
}
$field = TagField::create(
    'BlogTags',
    'Blog Tags',
    BlogTag::get(),
    $this->BlogTags()
)
    ->setShouldLazyLoad(true) // tags should be lazy loaded
    ->setCanCreate(true);     // new tag DataObjects can be created

String Tags

class BlogPost extends DataObject {
    private static $db = array(
        'Tags' => 'Text'
    );
}
$field = StringTagField::create(
    'Tags',
    'Tags',
    array('one', 'two'),
    explode(',', $this->Tags)
);

$field->setShouldLazyLoad(true); // tags should be lazy loaded

You can find more in-depth documentation in docs/en.

Versioning

This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.

All methods, with public visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep protected methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.

Reporting Issues

Please create an issue for any bugs you've found, or features you're missing.