SeedDMS_Core_Transmittal
in package
Class to represent a transmittal in the document management system
Tags
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
public
string
$_comment
comment of transmittal
Tags
$_date
public
object
$_date
date of creation
Tags
$_dms
public
object
$_dms
reference to the dms instance this user belongs to
Tags
$_id
public
int
$_id
id of transmittal
Tags
$_isPublic
public
bool
$_isPublic
true if transmittal is public
Tags
$_items
public
object
$_items
items
Tags
$_name
public
string
$_name
name of transmittal
Tags
$_user
public
object
$_user
user this transmittal belongs to
Tags
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
getComment()
public
getComment() : mixed
getID()
public
getID() : mixed
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
getItems()
public
getItems() : mixed
getName()
public
getName() : mixed
getSize()
public
getSize() : mixed
getUser()
public
getUser() : mixed
remove()
public
remove() : mixed
setComment()
public
setComment(mixed $newComment) : mixed
Parameters
- $newComment : mixed
setDMS()
public
setDMS(mixed $dms) : mixed
Parameters
- $dms : mixed
setName()
public
setName(mixed $newName) : mixed
Parameters
- $newName : mixed