Menu

## SeedDMS_Core_DocumentCategory
in package

inc.ClassDocumentCategory.php : 25

Class to represent a document category in the document management system

##### Tags

category

  DMS

author

  Uwe Steinmann uwe@steinmann.cx

copyright

  Copyright (C) 2011-2024 Uwe Steinmann

version

  Release: @package_version@

### Table of Contents

#### Properties

$_dms : object
$_id : int
$_name : string

#### Methods

__construct() : mixed
countDocumentsByCategory() : mixed
getDocumentsByCategory() : mixed
getID() : mixed
getName() : mixed
isUsed() : mixed
remove() : mixed
setDMS() : mixed
setName() : mixed

### Properties

#### $_dms

inc.ClassDocumentCategory.php : 42
`protected object $_dms`

reference to dms this category belongs to

##### Tags

access

  protected

#### $_id

inc.ClassDocumentCategory.php : 30
`protected int $_id`

id of document category

##### Tags

access

  protected

#### $_name

inc.ClassDocumentCategory.php : 36
`protected string $_name`

name of category

##### Tags

access

  protected

### Methods

#### __construct()

inc.ClassDocumentCategory.php : 44
`public __construct(mixed $id, mixed $name) : mixed`

##### Parameters

$id : mixed
$name : mixed

#### countDocumentsByCategory()

inc.ClassDocumentCategory.php : 113
`public countDocumentsByCategory() : mixed`

#### getDocumentsByCategory()

inc.ClassDocumentCategory.php : 93
`public getDocumentsByCategory([mixed $limit = 0 ][, mixed $offset = 0 ]) : mixed`

##### Parameters

$limit : mixed = 0
$offset : mixed = 0

#### getID()

inc.ClassDocumentCategory.php : 54
`public getID() : mixed`

#### getName()

inc.ClassDocumentCategory.php : 56
`public getName() : mixed`

#### isUsed()

inc.ClassDocumentCategory.php : 73
`public isUsed() : mixed`

#### remove()

inc.ClassDocumentCategory.php : 83
`public remove() : mixed`

#### setDMS()

inc.ClassDocumentCategory.php : 50
`public setDMS(mixed $dms) : mixed`

##### Parameters

$dms : mixed

#### setName()

inc.ClassDocumentCategory.php : 58
`public setName(mixed $newName) : mixed`

##### Parameters

$newName : mixed

## Search results