TypeService
FinalYes
Service for working with b2e documents.
Table of Contents
Constants
- CACHE_TTL = 86400
- SIGN_B2E_EMPLOYEE_ITEM_CATEGORY_CODE = 'SIGN_B2E_EMPLOYEE_ITEM_CATEGORY'
- SIGN_B2E_ITEM_CATEGORY_CODE = 'SIGN_B2E_ITEM_CATEGORY'
Methods
- addCategory() : AddResult
- addCategoryDefaultPermissions() : Result
- enableCategories() : Result
- getCategories() : array<int, DateTime, NAME: string, SORT: int, SETTINGS: string}>
- getCategoryByCode() : DateTime, NAME: string, SORT: int, SETTINGS: string}|null
- getCategoryById() : DateTime, NAME: string, SORT: int, SETTINGS: string}|null
- getDefaultCategoryId() : int
- isCategoriesEnabled() : bool
- isCreated() : bool
- isDefaultCategory() : bool
- updateDefaultCategory() : Result
Constants
CACHE_TTL
public
mixed
CACHE_TTL
= 86400
SIGN_B2E_EMPLOYEE_ITEM_CATEGORY_CODE
public
mixed
SIGN_B2E_EMPLOYEE_ITEM_CATEGORY_CODE
= 'SIGN_B2E_EMPLOYEE_ITEM_CATEGORY'
SIGN_B2E_ITEM_CATEGORY_CODE
public
mixed
SIGN_B2E_ITEM_CATEGORY_CODE
= 'SIGN_B2E_ITEM_CATEGORY'
Methods
addCategory()
public
addCategory(string $name, string $code) : AddResult
Parameters
- $name : string
- $code : string
Return values
AddResultaddCategoryDefaultPermissions()
public
addCategoryDefaultPermissions(int $categoryId) : Result
Parameters
- $categoryId : int
Return values
ResultenableCategories()
public
enableCategories() : Result
Return values
ResultgetCategories()
public
getCategories() : array<int, DateTime, NAME: string, SORT: int, SETTINGS: string}>
Return values
array<int, DateTime, NAME: string, SORT: int, SETTINGS: string}>getCategoryByCode()
public
getCategoryByCode(string $code) : DateTime, NAME: string, SORT: int, SETTINGS: string}|null
Parameters
- $code : string
Return values
DateTime, NAME: string, SORT: int, SETTINGS: string}|nullgetCategoryById()
public
getCategoryById(int $categoryId) : DateTime, NAME: string, SORT: int, SETTINGS: string}|null
Parameters
- $categoryId : int
Return values
DateTime, NAME: string, SORT: int, SETTINGS: string}|nullgetDefaultCategoryId()
public
getDefaultCategoryId() : int
Return values
intisCategoriesEnabled()
public
isCategoriesEnabled() : bool
Return values
boolisCreated()
public
isCreated() : bool
Return values
boolisDefaultCategory()
public
isDefaultCategory(int $categoryId) : bool
Parameters
- $categoryId : int
Return values
boolupdateDefaultCategory()
public
updateDefaultCategory(string $name, string $code) : Result
Parameters
- $name : string
- $code : string