Documentation

PhpProject
in package

PHPProject

Tags
category

PHPProject

copyright

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

Table of Contents

Properties

$informations  : DocumentInformations
Document informations
$properties  : DocumentProperties
Document properties
$resourceCollection  : array<string|int, resource>
Collection of resource objects
$taskCollection  : array<string|int, Task>
Collection of task objects

Methods

__construct()  : mixed
Create a new PHPProject
createResource()  : resource
Create a resource
createTask()  : Task
Create a task
getActiveResource()  : resource|null
Get active resource
getActiveTask()  : Task|null
Get active task
getAllResources()  : array<string|int, Resource>
Get all resources
getAllTasks()  : array<string|int, Task>
Get all tasks
getInformations()  : DocumentInformations
Get informations
getProperties()  : DocumentProperties
Get properties
getResourceCount()  : int
Get resource count
getResourceFromIndex()  : resource|null
Get resource from index
getTaskCount()  : int
Get task count
getTaskFromIndex()  : Task|null
Get task from index
removeTaskByIndex()  : void
Remove task by index
setInformations()  : self
Set informations
setProperties()  : self
Set properties

Properties

$resourceCollection

Collection of resource objects

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

$taskCollection

Collection of task objects

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

Methods

__construct()

Create a new PHPProject

public __construct() : mixed

createResource()

Create a resource

public createResource() : resource
Tags
throws
Exception
Return values
resource

createTask()

Create a task

public createTask() : Task
Tags
throws
Exception
Return values
Task

getActiveResource()

Get active resource

public getActiveResource() : resource|null
Return values
resource|null

getActiveTask()

Get active task

public getActiveTask() : Task|null
Return values
Task|null

getAllResources()

Get all resources

public getAllResources() : array<string|int, Resource>
Return values
array<string|int, Resource>

getAllTasks()

Get all tasks

public getAllTasks() : array<string|int, Task>
Return values
array<string|int, Task>

getResourceCount()

Get resource count

public getResourceCount() : int
Return values
int

getResourceFromIndex()

Get resource from index

public getResourceFromIndex(mixed $pIndex) : resource|null
Parameters
$pIndex : mixed
Return values
resource|null

getTaskCount()

Get task count

public getTaskCount() : int
Return values
int

getTaskFromIndex()

Get task from index

public getTaskFromIndex(mixed $pIndex[, Task|null $oTaskParent = null ]) : Task|null
Parameters
$pIndex : mixed
$oTaskParent : Task|null = null
Return values
Task|null

removeTaskByIndex()

Remove task by index

public removeTaskByIndex([int $pIndex = 0 ]) : void
Parameters
$pIndex : int = 0

Active task index

Tags
throws
Exception
On this page

Search results