Bitrix API

Fragment

Table of Contents

Methods

__construct()  : mixed
Finds entity object by filter.
getAttachedCount()  : int
Returns total amount of attached objects selecting by filter.
getDiskCount()  : int
Returns amount of objects on disk.
getDiskSize()  : int
Returns volume size of objects on disk.
getEntityId()  : string|null
Returns entity id.
getEntityType()  : string|null
Returns entity type.
getFile()  : File|null
Returns disk file.
getFileCount()  : int
Returns amount of objects selecting by filter.
getFileId()  : int|null
Returns disk file Id.
getFileSize()  : int
Returns volume size of objects selecting by filter.
getFolder()  : Folder|null
Returns disk folder.
getFolderId()  : int|null
Returns disk folder Id.
getIndicatorType()  : string
Returns type of the entity object.
getLinkCount()  : int
Returns total amount of external links to objects selecting by filter.
getModuleId()  : string|null
Returns module Id.
getPreviewCount()  : int
Returns amount of preview files.
getPreviewSize()  : int
Returns volume size of preview files.
getSharingCount()  : int
Returns total number sharing of objects selecting by filter.
getSpecific()  : array<string|int, mixed>
Returns entity specific corresponding to module.
getStorage()  : Storage|null
Returns disk storage.
getStorageId()  : int|null
Returns disk storage Id.
getTitle()  : string
Returns title of the entity object.
getUnnecessaryVersionCount()  : int
Returns total count of files without links and attached object.
getUnnecessaryVersionSize()  : int
Returns total amount of files without links and attached object.
getVersionCount()  : int
Returns total amount of objects selecting by filter.

Methods

__construct()

Finds entity object by filter.

public __construct(array<string|int, string> $parameters) : mixed
Parameters
$parameters : array<string|int, string>

Array filter set to find entity object.

getAttachedCount()

Returns total amount of attached objects selecting by filter.

public getAttachedCount() : int
Return values
int

getDiskCount()

Returns amount of objects on disk.

public getDiskCount() : int
Return values
int

getDiskSize()

Returns volume size of objects on disk.

public getDiskSize() : int
Return values
int

getEntityId()

Returns entity id.

public getEntityId() : string|null
Return values
string|null

getEntityType()

Returns entity type.

public getEntityType() : string|null
Return values
string|null

getFile()

Returns disk file.

public getFile() : File|null
Return values
File|null

getFileCount()

Returns amount of objects selecting by filter.

public getFileCount() : int
Return values
int

getFileId()

Returns disk file Id.

public getFileId() : int|null
Return values
int|null

getFileSize()

Returns volume size of objects selecting by filter.

public getFileSize() : int
Return values
int

getFolder()

Returns disk folder.

public getFolder() : Folder|null
Return values
Folder|null

getFolderId()

Returns disk folder Id.

public getFolderId() : int|null
Return values
int|null

getIndicatorType()

Returns type of the entity object.

public getIndicatorType() : string
Return values
string

getLinkCount()

Returns total amount of external links to objects selecting by filter.

public getLinkCount() : int
Return values
int

getModuleId()

Returns module Id.

public getModuleId() : string|null
Return values
string|null

getPreviewCount()

Returns amount of preview files.

public getPreviewCount() : int
Return values
int

getPreviewSize()

Returns volume size of preview files.

public getPreviewSize() : int
Return values
int

getSharingCount()

Returns total number sharing of objects selecting by filter.

public getSharingCount() : int
Return values
int

getSpecific()

Returns entity specific corresponding to module.

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

getStorage()

Returns disk storage.

public getStorage() : Storage|null
Return values
Storage|null

getStorageId()

Returns disk storage Id.

public getStorageId() : int|null
Return values
int|null

getTitle()

Returns title of the entity object.

public getTitle() : string
Return values
string

getUnnecessaryVersionCount()

Returns total count of files without links and attached object.

public getUnnecessaryVersionCount() : int
Return values
int

getUnnecessaryVersionSize()

Returns total amount of files without links and attached object.

public getUnnecessaryVersionSize() : int
Return values
int

getVersionCount()

Returns total amount of objects selecting by filter.

public getVersionCount() : int
Return values
int

        
On this page

Search results