groups

Documentation

Index

• func AddSortOrder(ctx context.Context, coll *mongo.Collection, displaySep *string) error
• func Create(ctx context.Context, api GroupAPI, display string, upsert bool, ...) (string, error)
• func DefaultDisplayToSortOrder(display string) interface{}
• func DeleteEmptyGroups(ctx context.Context, coll *mongo.Collection, ids []string) ([]string, []string)
• func FindEmptyGroups(ctx context.Context, coll *mongo.Collection) ([]string, error)
• func ListChildren(ctx context.Context, api GroupAPI, params *apis.GroupListParams, ...) error
• func Update(ctx context.Context, api GroupAPI, id string, update *apis.GroupUpdate, ...) error
• func UpdateGroupPhotoCountsAndVisTokens(ctx context.Context, api GroupAPI, oldIDs []string, newIDs []string, ...) error
• type CreateOptions
• type GroupAPI
• type UpdateOptions

Functions

func AddSortOrder

func AddSortOrder(ctx context.Context, coll *mongo.Collection, displaySep *string) error

AddSortOrder adds sort order to all groups in the given collection OUTDATED: should use GroupAPI.DisplayToSortOrder

func Create

func Create(ctx context.Context, api GroupAPI, display string, upsert bool, opts *CreateOptions) (string, error)

Create creates the any group for the given path. Path must not already exist. Returns the id.

func DefaultDisplayToSortOrder

func DefaultDisplayToSortOrder(display string) interface{}

Default implementation for DisplayToSortOrder. If the display string is an integer, use the integer value as the sort order. Otherwise just use the lowercase string (case-insensitive sort order).

func DeleteEmptyGroups

func DeleteEmptyGroups(ctx context.Context, coll *mongo.Collection, ids []string) ([]string, []string)

Delete given empty groups. Returns array of ids that were and were not deleted.

func FindEmptyGroups

func FindEmptyGroups(ctx context.Context, coll *mongo.Collection) ([]string, error)

Find empty groups, which are groups with no descendants except itself.

func ListChildren

func ListChildren(ctx context.Context, api GroupAPI, params *apis.GroupListParams, results interface{}) error

ListChildren returns an array of documents for each child of the given id. Children are sorted by id. If no projection keys are provided (nil), the default projection is just the folder id.

func Update

func Update(ctx context.Context, api GroupAPI, id string, update *apis.GroupUpdate, opts *UpdateOptions) error

Update group

func UpdateGroupPhotoCountsAndVisTokens

func UpdateGroupPhotoCountsAndVisTokens(
	ctx context.Context,
	api GroupAPI,
	oldIDs []string, newIDs []string,
	oldTokens []string, newTokens []string,
	count int,
) error

UpdateGroupPhotoCountsAndVisTokens updates a set of group documents based on the diff of ids. Also updates the visibility token photo counts in each affected group document.

Types

type CreateOptions

type CreateOptions struct {
	LowerCase      bool
	SlugifyPath    func(displayParts ...string) string
	Model          func(base docs.GroupBase) interface{}
	PostInsert     func(ctx context.Context, model interface{}) error
	ExistingParent func(ctx context.Context, id string) error
}

CreateOptions allows for extensions for how Create works

type GroupAPI

type GroupAPI interface {
	Collection() *mongo.Collection
	Separator() *string
	MakeProjectionFromKeys(keys []string) (interface{}, error)

	// Converts a display string to a sort order.
	DisplayToSortOrder(display string) interface{}
}

GroupAPI define general methods that all groups must support

type UpdateOptions

type UpdateOptions struct {
	PreUpdate func(ctx context.Context, id string, toSet *bson.M, toUnset *bson.M) error
}

UpdateOptions allows for extensions for how Update works