Documentation

SeedDMS_Core_KeywordCategory
in package

Class to represent a keyword category 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-2024 Uwe Steinmann

version

Release: @package_version@

Table of Contents

Properties

$_dms  : SeedDMS_Core_DMS
$_id  : int
$_name  : string
$_ownerID  : int

Methods

__construct()  : mixed
SeedDMS_Core_KeywordCategory constructor.
addKeywordList()  : bool
Add a new keyword to category
countKeywordLists()  : int
Return number of keywords in category
editKeywordList()  : bool
Change a keyword
getID()  : int
Return internal id of keyword category
getKeywordLists()  : array<string|int, mixed>
Get list of keywords in category
getName()  : string
Return name of keyword category
getOwner()  : bool|SeedDMS_Core_User
Return owner of keyword category
remove()  : bool
Delete all keywords of category and category itself
removeKeywordList()  : bool
Remove keyword
setDMS()  : mixed
setName()  : bool
Set name of keyword category
setOwner()  : bool
Set owner of keyword category

Properties

$_ownerID

protected int $_ownerID

id of user who is the owner

Tags
access

protected

Methods

__construct()

SeedDMS_Core_KeywordCategory constructor.

public __construct( $id,  $ownerID,  $name) : mixed
Parameters
$id :
$ownerID :
$name :

addKeywordList()

Add a new keyword to category

public addKeywordList( $keywords) : bool
Parameters
$keywords :

new keyword

Return values
bool

countKeywordLists()

Return number of keywords in category

public countKeywordLists() : int
Return values
int

number of keywords in this list

editKeywordList()

Change a keyword

public editKeywordList( $kid,  $keywords) : bool

This method identifies the keyword by its id and also ensures that the keyword belongs to the category, though the keyword id would be sufficient to uniquely identify the keyword.

Parameters
$kid :
$keywords :
Return values
bool

getID()

Return internal id of keyword category

public getID() : int
Return values
int

getKeywordLists()

Get list of keywords in category

public getKeywordLists() : array<string|int, mixed>
Return values
array<string|int, mixed>

keywords of category

getName()

Return name of keyword category

public getName() : string
Return values
string

remove()

Delete all keywords of category and category itself

public remove() : bool
Return values
bool

removeKeywordList()

Remove keyword

public removeKeywordList( $kid) : bool

This method identifies the keyword by its id and also ensures that the keyword belongs to the category, though the keyword id would be sufficient to uniquely identify the keyword.

Parameters
$kid :
Return values
bool

setName()

Set name of keyword category

public setName( $newName) : bool
Parameters
$newName :
Return values
bool

        
On this page

Search results