View Source Bonfire.Tag (Bonfire v0.9.10-classic-beta.156)

An extension for Bonfire that handles tagging posts or other things:

@ mentions
#hashtags
others (e.g. with a Category from Bonfire.Classify or a location from Bonfire.Geolocate)

Handy commands

Copyright and License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Summary

Functions

cast(changeset, attrs, creator, opts)

For using on changesets (eg in epics)

context_module()

Callback implementation for Bonfire.Common.SchemaModule.context_module/0.

find(id, types \\ nil)

get(id, opts \\ [])

get_hashtag(name)

get_or_create_hashtag(name)

indexing_object_format(object)

indexing_object_format_name(object)

many(filters \\ [], opts \\ [])

Retrieves a list of tags by arbitrary filters. Used by

maybe_find_tag(current_user, id_or_username_or_url, types \\ nil)

Try to find one (best-match) tag

maybe_find_tags(current_user, id_or_username_or_url, types \\ nil)

Search / autocomplete for tags by name

maybe_lookup_tag(id_or_username_or_url, prefix \\ "@")

Lookup a single for a tag by its name/username

maybe_put_tree_parent(changeset, category, creator)

maybe_tag(user, thing, tags \\ nil, boost_category_mentions? \\ true)

Maybe tag something

maybe_taxonomy_tag(user, id)

one(filters, opts \\ [])

Retrieves a single tag by arbitrary filters. Used by

query_module()

Callback implementation for Bonfire.Common.SchemaModule.query_module/0.

search_hashtag(text, opts \\ [])

search_hashtag_query(text, opts)

tag_ids(tags)

tag_something(user, thing, tags, boost_or_label_category_tags? \\ true)

tag existing thing with one or multiple Tags, Needle, or anything that can be made into a tag

tag_things_changeset(tag, things)

Add things (Pointer objects) to a tag. You usually want to add tags to a thing instead, see thing_tags_changeset

thing_tags_changeset(thing, tags)

Add tags to a thing (any Pointer object which defines a many_to_many relation to tag). This function applies to your object schema but is here for convenience.