project

package
v1.22.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 4, 2024 License: MIT Imports: 14 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var BoardColorPattern = regexp.MustCompile("^#[0-9a-fA-F]{6}$")

BoardColorPattern is a regexp witch can validate BoardColor

Functions

func ChangeProjectStatus 

func ChangeProjectStatus(ctx context.Context, p *Project, isClosed bool) error

ChangeProjectStatus toggle a project between opened and closed

func ChangeProjectStatusByRepoIDAndID 

func ChangeProjectStatusByRepoIDAndID(ctx context.Context, repoID, projectID int64, isClosed bool) error

ChangeProjectStatusByRepoIDAndID toggles a project between opened and closed

func DeleteBoardByID 

func DeleteBoardByID(ctx context.Context, boardID int64) error

DeleteBoardByID removes all issues references to the project board.

func DeleteProjectByID 

func DeleteProjectByID(ctx context.Context, id int64) error

DeleteProjectByID deletes a project from a repository. if it's not in a database transaction, it will start a new database transaction

func DeleteProjectByRepoID added in v1.17.4 

func DeleteProjectByRepoID(ctx context.Context, repoID int64) error

func GetSearchOrderByBySortType added in v1.20.0 

func GetSearchOrderByBySortType(sortType string) db.SearchOrderBy

func IsBoardTypeValid 

func IsBoardTypeValid(p BoardType) bool

IsBoardTypeValid checks if the project board type is valid

func IsCardTypeValid added in v1.19.0 

func IsCardTypeValid(p CardType) bool

IsCardTypeValid checks if the project board card type is valid

func IsErrProjectBoardNotExist 

func IsErrProjectBoardNotExist(err error) bool

IsErrProjectBoardNotExist checks if an error is a ErrProjectBoardNotExist

func IsErrProjectNotExist 

func IsErrProjectNotExist(err error) bool

IsErrProjectNotExist checks if an error is a ErrProjectNotExist

func IsTypeValid 

func IsTypeValid(p Type) bool

IsTypeValid checks if a project type is valid

func MoveColumnsOnProject added in v1.22.0 

func MoveColumnsOnProject(ctx context.Context, project *Project, sortedColumnIDs map[int64]int64) error

MoveColumnsOnProject sorts columns in a project

func MoveIssuesOnProjectBoard 

func MoveIssuesOnProjectBoard(ctx context.Context, board *Board, sortedIssueIDs map[int64]int64) error

MoveIssuesOnProjectBoard moves or keeps issues in a column and sorts them inside that column

func NewBoard 

func NewBoard(ctx context.Context, board *Board) error

NewBoard adds a new project board to a given project

func NewProject 

func NewProject(ctx context.Context, p *Project) error

NewProject creates a new Project

func SetDefaultBoard 

func SetDefaultBoard(ctx context.Context, projectID, boardID int64) error

SetDefaultBoard represents a board for issues not assigned to one

func UpdateBoard 

func UpdateBoard(ctx context.Context, board *Board) error

UpdateBoard updates a project board

func UpdateBoardSorting 

func UpdateBoardSorting(ctx context.Context, bs BoardList) error

UpdateBoardSorting update project board sorting

func UpdateProject 

func UpdateProject(ctx context.Context, p *Project) error

UpdateProject updates project properties

Types

type Board 

type Board struct {
	ID      int64 `xorm:"pk autoincr"`
	Title   string
	Default bool   `xorm:"NOT NULL DEFAULT false"` // issues not assigned to a specific board will be assigned to this board
	Sorting int8   `xorm:"NOT NULL DEFAULT 0"`
	Color   string `xorm:"VARCHAR(7)"`

	ProjectID int64 `xorm:"INDEX NOT NULL"`
	CreatorID int64 `xorm:"NOT NULL"`

	CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
	UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
}

Board is used to represent boards on a project

func GetBoard 

func GetBoard(ctx context.Context, boardID int64) (*Board, error)

GetBoard fetches the current board of a project

func (*Board) GetIssues added in v1.22.0 

func (b *Board) GetIssues(ctx context.Context) ([]*ProjectIssue, error)

func (*Board) NumIssues 

func (b *Board) NumIssues(ctx context.Context) int

NumIssues return counter of all issues assigned to the board

func (Board) TableName 

func (Board) TableName() string

TableName return the real table name

type BoardConfig added in v1.19.0 

type BoardConfig struct {
	BoardType   BoardType
	Translation string
}

BoardConfig is used to identify the type of board that is being created

func GetBoardConfig added in v1.19.0 

func GetBoardConfig() []BoardConfig

GetBoardConfig retrieves the types of configurations project boards could have

type BoardList 

type BoardList []*Board

BoardList is a list of all project boards in a repository

func GetColumnsByIDs added in v1.22.0 

func GetColumnsByIDs(ctx context.Context, projectID int64, columnsIDs []int64) (BoardList, error)

type BoardType 

type BoardType uint8

BoardType is used to represent a project board type 

const (
	// BoardTypeNone is a project board type that has no predefined columns
	BoardTypeNone BoardType = iota

	// BoardTypeBasicKanban is a project board type that has basic predefined columns
	BoardTypeBasicKanban

	// BoardTypeBugTriage is a project board type that has predefined columns suited to hunting down bugs
	BoardTypeBugTriage
)

type CardConfig added in v1.19.0 

type CardConfig struct {
	CardType    CardType
	Translation string
}

CardConfig is used to identify the type of board card that is being used

func GetCardConfig added in v1.19.0 

func GetCardConfig() []CardConfig

GetCardConfig retrieves the types of configurations project board cards could have

type CardType added in v1.19.0 

type CardType uint8

CardType is used to represent a project board card type 

const (
	// CardTypeTextOnly is a project board card type that is text only
	CardTypeTextOnly CardType = iota

	// CardTypeImagesAndText is a project board card type that has images and text
	CardTypeImagesAndText
)

type ErrProjectBoardNotExist 

type ErrProjectBoardNotExist struct {
	BoardID int64
}

ErrProjectBoardNotExist represents a "ProjectBoardNotExist" kind of error.

func (ErrProjectBoardNotExist) Error 

func (err ErrProjectBoardNotExist) Error() string

func (ErrProjectBoardNotExist) Unwrap added in v1.17.4 

func (err ErrProjectBoardNotExist) Unwrap() error

type ErrProjectNotExist 

type ErrProjectNotExist struct {
	ID     int64
	RepoID int64
}

ErrProjectNotExist represents a "ProjectNotExist" kind of error.

func (ErrProjectNotExist) Error 

func (err ErrProjectNotExist) Error() string

func (ErrProjectNotExist) Unwrap added in v1.17.4 

func (err ErrProjectNotExist) Unwrap() error

type Project 

type Project struct {
	ID          int64                  `xorm:"pk autoincr"`
	Title       string                 `xorm:"INDEX NOT NULL"`
	Description string                 `xorm:"TEXT"`
	OwnerID     int64                  `xorm:"INDEX"`
	Owner       *user_model.User       `xorm:"-"`
	RepoID      int64                  `xorm:"INDEX"`
	Repo        *repo_model.Repository `xorm:"-"`
	CreatorID   int64                  `xorm:"NOT NULL"`
	IsClosed    bool                   `xorm:"INDEX"`
	BoardType   BoardType
	CardType    CardType
	Type        Type

	RenderedContent template.HTML `xorm:"-"`

	CreatedUnix    timeutil.TimeStamp `xorm:"INDEX created"`
	UpdatedUnix    timeutil.TimeStamp `xorm:"INDEX updated"`
	ClosedDateUnix timeutil.TimeStamp
}

Project represents a project board

func GetProjectByID 

func GetProjectByID(ctx context.Context, id int64) (*Project, error)

GetProjectByID returns the projects in a repository

func GetProjectForRepoByID added in v1.20.6 

func GetProjectForRepoByID(ctx context.Context, repoID, id int64) (*Project, error)

GetProjectForRepoByID returns the projects in a repository

func (*Project) CanBeAccessedByOwnerRepo added in v1.22.0 

func (p *Project) CanBeAccessedByOwnerRepo(ownerID int64, repo *repo_model.Repository) bool

func (*Project) GetBoards added in v1.20.0 

func (p *Project) GetBoards(ctx context.Context) (BoardList, error)

GetBoards fetches all boards related to a project

func (*Project) GetDefaultBoard added in v1.22.0 

func (p *Project) GetDefaultBoard(ctx context.Context) (*Board, error)

GetDefaultBoard return default board and ensure only one exists

func (*Project) IconName added in v1.20.0 

func (p *Project) IconName() string

func (*Project) IsOrganizationProject added in v1.19.0 

func (p *Project) IsOrganizationProject() bool

func (*Project) IsRepositoryProject added in v1.20.0 

func (p *Project) IsRepositoryProject() bool
func (p *Project) Link(ctx context.Context) string

Link returns the project's relative URL.

func (*Project) LoadOwner added in v1.19.0 

func (p *Project) LoadOwner(ctx context.Context) (err error)

func (*Project) LoadRepo added in v1.19.0 

func (p *Project) LoadRepo(ctx context.Context) (err error)

func (*Project) NumClosedIssues 

func (p *Project) NumClosedIssues(ctx context.Context) int

NumClosedIssues return counter of closed issues assigned to a project

func (*Project) NumIssues 

func (p *Project) NumIssues(ctx context.Context) int

NumIssues return counter of all issues assigned to a project

func (*Project) NumOpenIssues 

func (p *Project) NumOpenIssues(ctx context.Context) int

NumOpenIssues return counter of open issues assigned to a project

type ProjectIssue 

type ProjectIssue struct {
	ID        int64 `xorm:"pk autoincr"`
	IssueID   int64 `xorm:"INDEX"`
	ProjectID int64 `xorm:"INDEX"`

	// ProjectBoardID should not be zero since 1.22. If it's zero, the issue will not be displayed on UI and it might result in errors.
	ProjectBoardID int64 `xorm:"INDEX"`

	// the sorting order on the board
	Sorting int64 `xorm:"NOT NULL DEFAULT 0"`
}

ProjectIssue saves relation from issue to a project

type SearchOptions 

type SearchOptions struct {
	db.ListOptions
	OwnerID  int64
	RepoID   int64
	IsClosed optional.Option[bool]
	OrderBy  db.SearchOrderBy
	Type     Type
	Title    string
}

SearchOptions are options for GetProjects

func (SearchOptions) ToConds added in v1.22.0 

func (opts SearchOptions) ToConds() builder.Cond

func (SearchOptions) ToOrders added in v1.22.0 

func (opts SearchOptions) ToOrders() string

type Type 

type Type uint8

Type is used to identify the type of project in question and ownership 

const (
	// TypeIndividual is a type of project board that is owned by an individual
	TypeIndividual Type = iota + 1

	// TypeRepository is a project that is tied to a repository
	TypeRepository

	// TypeOrganization is a project that is tied to an organisation
	TypeOrganization
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.