people

Documentation

Overview

Package people deals with people, person names, aliases and their roles.

Index

• Variables
• func Cronjob(force bool) error
• func DataList(filename string, r Request) error
• func Filters() []string
• func Fix() error
• func HTML(filename string, r Request) error
• func Print(r Request) error
• func Roles() string
• func Wheres() []string
• type Request
  • func (r Request) HTML(name string) error

Examples

• Fix

Variables

var (
	ErrCJDir  = errors.New("cronjob directory does not exist")
	ErrCJFile = errors.New("cronjob file to save html does not exist")
	ErrCfg    = errors.New("the directory.html setting is empty")
)

Functions

func Cronjob

func Cronjob(force bool) error

Cronjob is used for system automation to generate dynamic HTML pages.

func DataList

func DataList(filename string, r Request) error

DataList prints an auto-complete list for HTML input elements.

func Filters

func Filters() []string

Filters is a Role slice for use with the Cobra filterFlag.

func Fix

func Fix() error

Fix any malformed group names found in the database.

Example

package main

import (
	"log"
	"os"

	"github.com/Defacto2/df2/pkg/people"
)

func main() {
	// suppress dynamic output for this example
	os.Stdout, _ = os.OpenFile(os.DevNull, os.O_APPEND|os.O_WRONLY, os.ModeAppend)
	defer os.Stdout.Close()
	if err := people.Fix(); err != nil {
		log.Print(err)
	}
}

func HTML

func HTML(filename string, r Request) error

HTML prints a snippet listing links to each person.

func Print

func Print(r Request) error

Print lists people filtered by a role and summaries the results.

func Roles

func Roles() string

Roles or jobs of people.

func Wheres

func Wheres() []string

Wheres are group categories.

Types

type Request

type Request struct {
	Filter   string // Filter people by category.
	Counts   bool   // Counts the person's total files.
	Progress bool   // Progress counter when requesting database data.
}

Request flags for people functions.

func (Request) HTML

func (r Request) HTML(name string) error

HTML prints a snippet listing links to each group, with an optional file count.