Documentation

Task
in package

PHPProject_Task

Tags
category

PHPProject

copyright

Copyright (c) 2012 - 2012 PHPProject (https://github.com/PHPOffice/PHPProject)

Table of Contents

Properties

$lastIndex  : int
Index of Resource
$duration  : string
Duration
$endDate  : int
End Date
$index  : int
Index
$name  : string
Name
$progress  : float
Progress
$resourceCollection  : array<string|int, resource>
Collection of Resource
$startDate  : int
Start Date
$taskCollection  : array<string|int, self>
Collection of task objects

Methods

__construct()  : mixed
addResource()  : self
Add a resource used by the current task
createTask()  : self
getDuration()  : string|null
Get duration
getEndDate()  : int|null
Get End Date
getIndex()  : int
Get index
getName()  : string
Get name
getProgress()  : float|null
Get Progress
getResourceCount()  : int
getResources()  : array<string|int, resource>
Returns a collection of all resources used by the task
getStartDate()  : int|null
Get Start Date
getTaskCount()  : int
getTasks()  : array<string|int, self>
Returns a collection of all subtasks created in the task
setDuration()  : self
Set duration (in days)
setEndDate()  : self
Set End Date
setIndex()  : self
Set index
setName()  : self
Set name
setProgress()  : self
Set progress
setStartDate()  : self
Set Start Date

Properties

$lastIndex

Index of Resource

public static int $lastIndex = 0

$duration

Duration

private string $duration

$endDate

End Date

private int $endDate

$index

Index

private int $index

$name

Name

private string $name = ''

$progress

Progress

private float $progress

$resourceCollection

Collection of Resource

private array<string|int, resource> $resourceCollection = array()

$startDate

Start Date

private int $startDate

$taskCollection

Collection of task objects

private array<string|int, self> $taskCollection = array()

Methods

__construct()

public __construct() : mixed

addResource()

Add a resource used by the current task

public addResource(resource $oResource) : self
Parameters
$oResource : resource
Return values
self

createTask()

public createTask() : self
Return values
self

getDuration()

Get duration

public getDuration() : string|null
Return values
string|null

getEndDate()

Get End Date

public getEndDate() : int|null
Return values
int|null

getIndex()

Get index

public getIndex() : int
Return values
int

getName()

Get name

public getName() : string
Return values
string

getProgress()

Get Progress

public getProgress() : float|null
Return values
float|null

getResourceCount()

public getResourceCount() : int
Return values
int

getResources()

Returns a collection of all resources used by the task

public getResources() : array<string|int, resource>
Return values
array<string|int, resource>

getStartDate()

Get Start Date

public getStartDate() : int|null
Return values
int|null

getTaskCount()

public getTaskCount() : int
Return values
int

getTasks()

Returns a collection of all subtasks created in the task

public getTasks() : array<string|int, self>
Return values
array<string|int, self>

setDuration()

Set duration (in days)

public setDuration(int|float|string $pValue) : self
Parameters
$pValue : int|float|string

Duration of the resource

Return values
self

setEndDate()

Set End Date

public setEndDate([int|string|null $pValue = null ]) : self
Parameters
$pValue : int|string|null = null
Return values
self

setIndex()

Set index

public setIndex(int|string $value) : self
Parameters
$value : int|string
Return values
self

setName()

Set name

public setName(string $pValue) : self
Parameters
$pValue : string

Name of the task

Return values
self

setProgress()

Set progress

public setProgress([int|float|string $pValue = 0 ]) : self
Parameters
$pValue : int|float|string = 0

Progress of the task

Return values
self

setStartDate()

Set Start Date

public setStartDate([int|string|null $pValue = null ]) : self
Parameters
$pValue : int|string|null = null
Return values
self
On this page

Search results