Documentation

SeedDMS_Core_Transmittal
in package

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

$_dms

public object $_dms

reference to the dms instance this user belongs to

Tags
access

protected

Methods

__construct()

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()

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()

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

getInstance()

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

setComment()

public setComment(mixed $newComment) : mixed
Parameters
$newComment : mixed

        
On this page

Search results