Интерфейс IBPWorkflowDocument

Открытые статические члены
static	getDocument ($documentId)
static	getDocumentFields ($documentType)
static	createDocument ($parentDocumentId, $arFields)
static	updateDocument ($documentId, $arFields)
static	deleteDocument ($documentId)
static	publishDocument ($documentId)
static	unpublishDocument ($documentId)
static	lockDocument ($documentId, $workflowId)
static	unlockDocument ($documentId, $workflowId)
static	isDocumentLocked ($documentId, $workflowId)
static	canUserOperateDocument ($operation, $userId, $documentId, $arParameters=array())
static	canUserOperateDocumentType ($operation, $userId, $documentType, $arParameters=array())
static	getDocumentAdminPage ($documentId)
static	getDocumentForHistory ($documentId, $historyIndex)
static	recoverDocumentFromHistory ($documentId, $arDocument)
static	getAllowableOperations ($documentType)
static	getAllowableUserGroups ($documentType)
static	getUsersFromUserGroup ($group, $documentId)

Подробное описание

См. определение в файле interface.php строка 47

Методы

canUserOperateDocument()

canUserOperateDocument ( $operation, $userId, $documentId, $arParameters = array() )

static

Method checks can user operate specified document with specified operation.

Аргументы

int	$operation	- Operation.
int	$userId	- User id.
string | int	$documentId	- Document id.
array	$arParameters	- Additional parameters.

Возвращает

bool

canUserOperateDocumentType()

canUserOperateDocumentType ( $operation, $userId, $documentType, $arParameters = array() )

static

Method checks can user operate specified document type with specified operation.

Аргументы

int	$operation	- Operation.
int	$userId	- User id.
string	$documentType	- Document type.
array	$arParameters	- Additional parameters.

Возвращает

bool

createDocument()

createDocument ( $parentDocumentId, $arFields )

static

Method creates new document with specified fields.

Аргументы

	$parentDocumentId	- Parent document id.
array	$arFields	- Fields values array(field_code => value, ...). Fields codes must be compatible with codes from GetDocumentFields.

Возвращает

int - New document id.

deleteDocument()

deleteDocument ( $documentId )

static

Method deletes specified document.

Аргументы

string

$documentId

- Document id.

getAllowableOperations()

getAllowableOperations ( $documentType )

static

getAllowableUserGroups()

getAllowableUserGroups ( $documentType )

static

getDocument()

getDocument ( $documentId )

static

Method returns document fields values as array (field_code => value, ...). Must be compatible with GetDocumentFields.

Аргументы

string

$documentId

- Document id.

Возвращает

array - Fields values.

getDocumentAdminPage()

getDocumentAdminPage ( $documentId )

static

Get document admin page URL.

Аргументы

string | int

$documentId

- Document id.

Возвращает

string - URL.

getDocumentFields()

getDocumentFields ( $documentType )

static

Method returns document type fields list.

Аргументы

string

$documentType

- Document type.

Возвращает

array - Fields array(field_code => array("NAME" => field_name, "TYPE" => field_type), ...).

getDocumentForHistory()

getDocumentForHistory ( $documentId, $historyIndex )

static

Method returns document information. This information uses in method RecoverDocumentFromHistory.

Аргументы

string	$documentId	- Document id.
	$historyIndex	- History index.

Возвращает

array - Document data.

getUsersFromUserGroup()

getUsersFromUserGroup ( $group, $documentId )

static

isDocumentLocked()

isDocumentLocked ( $documentId, $workflowId )

static

Method checks lock status.

Аргументы

string	$documentId	- Document id.
string	$workflowId	- Workflow id.

Возвращает

bool True if document locked.

lockDocument()

lockDocument ( $documentId, $workflowId )

static

Method locks specified document for specified workflow state. A locked document can be changed only by the specified workflow.

Аргументы

string	$documentId	- Document id.
string	$workflowId	- Workflow id.

Возвращает

bool - True on success, false on failure.

publishDocument()

publishDocument ( $documentId )

static

Method publishes document.

Аргументы

string

$documentId

- Document id.

recoverDocumentFromHistory()

recoverDocumentFromHistory ( $documentId, $arDocument )

static

Method recovers specified document from information, provided by method RecoverDocumentFromHistory.

Аргументы

string	$documentId	- Document id.
array	$arDocument	- Document data.

unlockDocument()

unlockDocument ( $documentId, $workflowId )

static

Method unlocks specified document. On unlock fires events like "Entity_OnUnlockDocument" with document id as first parameter.

Аргументы

string	$documentId	- Document id.
string	$workflowId	- Workflow id.

Возвращает

bool - True on success, false on failure.

unpublishDocument()

unpublishDocument ( $documentId )

static

Method unpublishes document.

Аргументы

string

$documentId

- Document id.

updateDocument()

updateDocument ( $documentId, $arFields )

static

Method updates document fields.

Аргументы

string	$documentId	- Document id.
array	$arFields	- New fields values array(field_code => value, ...). Fields codes must be compatible with codes from GetDocumentFields.

---

Объявления и описания членов интерфейса находятся в файле:

• C:/bitrix/modules/bizproc/classes/general/interface.php