smcanvas.md

title	footer
\leantime\domain\repositories\smcanvas	false

smcanvas

• Full name: \leantime\domain\repositories\smcanvas
• Parent class: \leantime\domain\repositories\canvas

Constants

Constant	Type	Value
\leantime\domain\repositories\smcanvas::CANVAS_NAME		'sm'

Inherited methods

__construct

__construct - get db connection

public canvas::__construct(): \leantime\domain\repositories\unknown_type

Return Value:

---

getIcon

getIcon() - Retrieve canvas icon

public canvas::getIcon(): string

Return Value:

Canvas icon

---

getDisclaimer

getDisclaimer() - Retrieve disclaimer

public canvas::getDisclaimer(): string

Return Value:

Canvas disclaimer

---

getCanvasTypes

getCanvasTypes() - Retrieve translated canvaas items

public canvas::getCanvasTypes(): array

Return Value:

Array of data

---

getStatusLabels

getStatusLabels() - Retrieve translated status labels

public canvas::getStatusLabels(): array

Return Value:

Array of data

---

getRelatesLabels

getRelatesLabels() - Retrieve translated relates labels

public canvas::getRelatesLabels(): array

Return Value:

Array of data

---

getDataLabels

getDataLabels() - Retrieve translated data labels

public canvas::getDataLabels(): array

Return Value:

Array of data

---

getAllCanvas

public canvas::getAllCanvas(mixed $projectId): mixed

Parameters:

Parameter	Type	Description
projectId	mixed

Return Value:

---

getSingleCanvas

public canvas::getSingleCanvas(mixed $canvasId): mixed

Parameters:

Parameter	Type	Description
canvasId	mixed

Return Value:

---

deleteCanvas

public canvas::deleteCanvas(mixed $id): mixed

Parameters:

Parameter	Type	Description
id	mixed

Return Value:

---

addCanvas

public canvas::addCanvas(mixed $values): mixed

Parameters:

Parameter	Type	Description
values	mixed

Return Value:

---

updateCanvas

public canvas::updateCanvas(mixed $values): mixed

Parameters:

Parameter	Type	Description
values	mixed

Return Value:

---

editCanvasItem

public canvas::editCanvasItem(mixed $values): mixed

Parameters:

Parameter	Type	Description
values	mixed

Return Value:

---

patchCanvasItem

public canvas::patchCanvasItem(mixed $id, mixed $params): mixed

Parameters:

Parameter	Type	Description
id	mixed
params	mixed

Return Value:

---

getCanvasItemsById

public canvas::getCanvasItemsById(mixed $id): mixed

Parameters:

Parameter	Type	Description
id	mixed

Return Value:

---

getSingleCanvasItem

public canvas::getSingleCanvasItem(mixed $id): mixed

Parameters:

Parameter	Type	Description
id	mixed

Return Value:

---

addCanvasItem

public canvas::addCanvasItem(mixed $values): mixed

Parameters:

Parameter	Type	Description
values	mixed

Return Value:

---

delCanvasItem

public canvas::delCanvasItem(mixed $id): mixed

Parameters:

Parameter	Type	Description
id	mixed

Return Value:

---

getNumberOfCanvasItems

public canvas::getNumberOfCanvasItems(mixed $projectId = null): mixed

Parameters:

Parameter	Type	Description
projectId	mixed

Return Value:

---

getNumberOfBoards

public canvas::getNumberOfBoards(mixed $projectId = null): mixed

Parameters:

Parameter	Type	Description
projectId	mixed

Return Value:

---

existCanvas

existCanvas - return if a canvas exists with a given title in the specified project

public canvas::existCanvas(int $projectId, string $canvasTitle): bool

Parameters:

Parameter	Type	Description
projectId	int	Project identifier
canvasTitle	string	Canvas title

Return Value:

True if canvas exists

---

copyCanvas

public canvas::copyCanvas(int $projectId, int $canvasId, int $authorId, string $canvasTitle): int

Parameters:

Parameter	Type	Description
projectId	int
canvasId	int
authorId	int
canvasTitle	string

Return Value:

---

mergeCanvas

public canvas::mergeCanvas(int $canvasId, string $mergeId): bool

Parameters:

Parameter	Type	Description
canvasId	int
mergeId	string

Return Value:

---

getCanvasProgressCount

public canvas::getCanvasProgressCount(int $projectId, array $boards): mixed

Parameters:

Parameter	Type	Description
projectId	int
boards	array

Return Value:

---

getLastUpdatedCanvas

public canvas::getLastUpdatedCanvas(int $projectId, array $boards): mixed

Parameters:

Parameter	Type	Description
projectId	int
boards	array

Return Value:

---

getTags

public canvas::getTags(int $projectId): mixed

Parameters:

Parameter	Type	Description
projectId	int

Return Value:

---

---

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