Menu

## SeedDMS_Core_Transmittal
in package

inc.ClassTransmittal.php : 25

Class to represent a transmittal in the document management system

##### Tags

category

  DMS

author

  Markus Westphal, Malcolm Cowe, Uwe Steinmann uwe@steinmann.cx

copyright

  Copyright (C) 2002-2005 Markus Westphal, 2006-2008 Malcolm Cowe, 2010 Uwe Steinmann

version

  Release: @package_version@

### Table of Contents

#### Properties

$_comment : string
$_date : object
$_dms : object
$_id : int
$_isPublic : bool
$_items : object
$_name : string
$_user : object

#### Methods

__construct() : mixed
addContent() : bool
  Add an item to the transmittal
getAllInstances() : object
  Get all instances of a transmittal object
getComment() : mixed
getID() : mixed
getInstance() : object
  Get an instance of a transmittal object
getItems() : mixed
getName() : mixed
getSize() : mixed
getUser() : mixed
remove() : mixed
setComment() : mixed
setDMS() : mixed
setName() : mixed

### Properties

#### $_comment

inc.ClassTransmittal.php : 45
`public string $_comment`

comment of transmittal

##### Tags

access

  protected

#### $_date

inc.ClassTransmittal.php : 66
`public object $_date`

date of creation

##### Tags

access

  protected

#### $_dms

inc.ClassTransmittal.php : 80
`public object $_dms`

reference to the dms instance this user belongs to

##### Tags

access

  protected

#### $_id

inc.ClassTransmittal.php : 31
`public int $_id`

id of transmittal

##### Tags

access

  protected

#### $_isPublic

inc.ClassTransmittal.php : 52
`public bool $_isPublic`

true if transmittal is public

##### Tags

access

  protected

#### $_items

inc.ClassTransmittal.php : 73
`public object $_items`

items

##### Tags

access

  protected

#### $_name

inc.ClassTransmittal.php : 38
`public string $_name`

name of transmittal

##### Tags

access

  protected

#### $_user

inc.ClassTransmittal.php : 59
`public object $_user`

user this transmittal belongs to

##### Tags

access

  protected

### Methods

#### __construct()

inc.ClassTransmittal.php : 82
`public __construct(mixed $id, mixed $user, mixed $name, mixed $comment[, mixed $isPublic = 0 ][, mixed $date = '' ]) : mixed`

##### Parameters

$id : mixed
$user : mixed
$name : mixed
$comment : mixed
$isPublic : mixed = 0
$date : mixed = ''

#### addContent()

inc.ClassTransmittal.php : 245

Add an item to the transmittal

`public addContent(object $item) : bool`

##### Parameters

$item : object

  instance of SeedDMS_Core_DocumentContent

##### Return values

bool —

true if item could be added, otherwise false

#### getAllInstances()

inc.ClassTransmittal.php : 141

Get all instances of a transmittal object

`public static getAllInstances(mixed $user, mixed $orderby, object $dms) : object`

##### Parameters

$user : mixed
$orderby : mixed
$dms : object

  instance of dms

##### Return values

object —

instance of class SeedDMS_Core_Transmittal

#### getComment()

inc.ClassTransmittal.php : 183
`public getComment() : mixed`

#### getID()

inc.ClassTransmittal.php : 167
`public getID() : mixed`

#### getInstance()

inc.ClassTransmittal.php : 103

Get an instance of a transmittal object

`public static getInstance(string|int $id, object $dms[, string $by = '' ]) : object`

##### Parameters

$id : string|int

  id or name of transmittal, depending on the 3rd parameter.

$dms : object

  instance of dms

$by : string = ''

  search by [id|name]. If this parameter is left empty, the user will be search by its Id.

##### Return values

object —

instance of class SeedDMS_Core_Transmittal

#### getItems()

inc.ClassTransmittal.php : 199
`public getItems() : mixed`

#### getName()

inc.ClassTransmittal.php : 169
`public getName() : mixed`

#### getSize()

inc.ClassTransmittal.php : 223
`public getSize() : mixed`

#### getUser()

inc.ClassTransmittal.php : 197
`public getUser() : mixed`

#### remove()

inc.ClassTransmittal.php : 263
`public remove() : mixed`

#### setComment()

inc.ClassTransmittal.php : 185
`public setComment(mixed $newComment) : mixed`

##### Parameters

$newComment : mixed

#### setDMS()

inc.ClassTransmittal.php : 163
`public setDMS(mixed $dms) : mixed`

##### Parameters

$dms : mixed

#### setName()

inc.ClassTransmittal.php : 171
`public setName(mixed $newName) : mixed`

##### Parameters

$newName : mixed

## Search results