Класс FileCollection

Граф наследования:FileCollection:

Открытые члены
	__construct (?array $diskFiles=null, ?int $chatId=null)
	getDiskFiles ()
	getMessageOut ()
	copyTo (Folder $folder)
	copyToOwnSavedFiles ()
	copyToOwnUploadedFiles ()
	addToTmp (string $source)
	getFileDiskAttributes (int $chatId, array $options=[])
	getPopupData (array $excludedList=[])
	filterByDate (DateTime $date)
	getRelatedChatId ()
Открытые члены унаследованные от Registry
	unsetByKeys (array $keys)
	mergeRegistry (Registry $registry)
	filter (callable $predicate)
	getAny ()
	isEmpty ()
Открытые члены унаследованные от EntityCollection
	getUnique ()
	getIds ()
	getById (int $id)
	toRestFormat (array $option=[])
	offsetSet ($offset, $value)

Открытые статические члены
static	getRestEntityName ()
static	initByDiskFilesIds (array $diskFilesIds, ?int $chatId=null)
static	addDiskFilesToPreload (array $diskFiles)
Открытые статические члены унаследованные от EntityCollection
static	initByArray (array $entities)

Защищенные статические члены
static	getPreloadDiskFile (array $diskFileIds)

Статические защищенные данные
static array	$preloadDiskFiles = []

Дополнительные унаследованные члены
Защищенные данные унаследованные от EntityCollection
array	$entitiesWithId = []

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

<FileItem> @method FileItem offsetGet($key)

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

Конструктор(ы)

__construct()

__construct	(	?array	$diskFiles = null,
		?int	$chatId = null )

Аргументы

int[] | File[] | null	$diskFiles
int | null	$chatId

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

Методы

addDiskFilesToPreload()

addDiskFilesToPreload ( array $diskFiles )

static

Аргументы

File[]

$diskFiles

Возвращает

void

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

addToTmp()

addToTmp

(

string

$source

)

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

copyTo()

copyTo

(

Folder

$folder

)

Аргументы

Folder

$folder

Возвращает

Result<FileCollection>

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

copyToOwnSavedFiles()

copyToOwnSavedFiles

(

)

Возвращает

Result<FileCollection>

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

copyToOwnUploadedFiles()

copyToOwnUploadedFiles

(

)

Возвращает

Result<FileCollection>

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

filterByDate()

filterByDate

(

DateTime

$date

)

Аргументы

DateTime

$date

Возвращает

FilterResult<?static>

Замещает DateFilterable.

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

getDiskFiles()

getDiskFiles

(

)

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

getFileDiskAttributes()

getFileDiskAttributes	(	int	$chatId,
		array	$options = [] )

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

getMessageOut()

getMessageOut

(

)

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

getPopupData()

getPopupData

(

array

$excludedList = []

)

Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.

См. также

RestAdapter::toRestFormat()

Аргументы

string[]

$excludedList

Возвращает

PopupData

Переопределяет метод предка EntityCollection.

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

getPreloadDiskFile()

getPreloadDiskFile ( array $diskFileIds )

staticprotected

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

getRelatedChatId()

getRelatedChatId

(

)

Замещает DateFilterable.

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

getRestEntityName()

getRestEntityName ( )

static

Returns the name of the entity that will be used in the rest response

Возвращает

string

Замещает RestConvertible.

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

initByDiskFilesIds()

initByDiskFilesIds ( array $diskFilesIds, ?int $chatId = null )

static

Аргументы

int[]	$diskFilesIds
int | null	$chatId

Возвращает

static

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

Поля

$preloadDiskFiles

array $preloadDiskFiles = []

staticprotected

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

---

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

• C:/bitrix/modules/im/lib/V2/Entity/File/FileCollection.php