Skip to content

Latest commit

 

History

History
113 lines (50 loc) · 1.78 KB

File metadata and controls

113 lines (50 loc) · 1.78 KB
title footer
\leantime\domain\services\canvas
false

canvas

  • Full name: \leantime\domain\services\canvas

Methods

import

import - Import canvas from XML file

public canvas::import(string $filename, string $canvasName, int $projectId, int $authorId): bool|int

Parameters:

Parameter Type Description
filename string File to import
canvasName string
projectId int Project identifier
authorId int

Return Value:

False if import failed and the id of the newly created canvas otherwise


getBoardProgress

getBoardProgress - gets the progress of canvas types. counts items in each box-type and calculates percent done if each box type has at least 1 item.

public canvas::getBoardProgress(string $projectId = '', array $boards = array()): array

Parameters:

Parameter Type Description
projectId string projectId (optional)
boards array Array of project board types

Return Value:

List of boards with a progress percentage


getLastUpdatedCanvas

getLastUpdatedCanvas - gets the list of canvas boards ordered by last updated item

public canvas::getLastUpdatedCanvas(string $projectId = '', array $boards = array()): array

Parameters:

Parameter Type Description
projectId string projectId (optional)
boards array Array of project board types

Return Value:

List of boards with a progress percentage



Automatically generated from source code comments on 2023-02-28 using phpDocumentor