Class Warning

com.woltlab.wcf.user.infraction.data.user.infraction.warning

Description

Represents a predefined warning.

  • author: Marcel Werk
  • copyright: 2001-2009 WoltLab GmbH
  • license: WoltLab
DatabaseObject
   |
   --Warning

Direct descendents

Class Description
WarningEditor Provides functions to add, edit and delete warnings.

Variable Summary

Type Name
static array<WarningObjectType> $availableWarningObjectTypes

Method Summary

Return Name
Warning __construct(integer $warningID, [array<mixed> $row = null])
static array<WarningObjectType> getAvailableWarningObjectTypes()
static mixed getWarningObjectByID(string $objectType, mixed $objectID)
static WarningObjectType getWarningObjectTypeObject(string $objectType)
static array<Warning> getWarnings()
string __toString()

Variables

$availableWarningObjectTypes

public static array<WarningObjectType> $availableWarningObjectTypes = null

list of available warning object types

Inherited variables from DatabaseObject

DatabaseObject::$data

Methods

__construct

public Warning __construct(integer $warningID, [array<mixed> $row = null])

Creates a new Warning object.

Parameters:

  • $warningID
  • $row

Redefinition of: DatabaseObject::__construct()

getAvailableWarningObjectTypes

public static array<WarningObjectType> getAvailableWarningObjectTypes()

Returns a list of available warning object types.

getWarningObjectByID

public static mixed getWarningObjectByID(string $objectType, mixed $objectID)

Gets warning objects by their ids.

Parameters:

  • $objectType
  • $objectID

getWarningObjectTypeObject

public static WarningObjectType getWarningObjectTypeObject(string $objectType)

Returns the object of a warning object type.

Parameters:

  • $objectType

getWarnings

public static array<Warning> getWarnings()

Returns a list of warnings.

__toString

public string __toString()

Returns the title of this warning.

Inherited methods from DatabaseObject

DatabaseObject::__construct(), DatabaseObject::handleData(), DatabaseObject::sort(), DatabaseObject::__get()