Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс FileItem
+ Граф наследования:FileItem:

Открытые члены

 __construct ($source=null)
 
 save ()
 
 setSubtype (string $subtype)
 
 getSubtype ()
 
 fillFile ()
 
 setChatId (int $chatId)
 
 getEntity ()
 
 setEntity (RestEntity $entity)
 
 getPopupData (array $excludedList=[])
 
 toRestFormat (array $option=[])
 
- Открытые члены унаследованные от ActiveRecord
 load ($source)
 
 prepareFields ()
 
 getDataEntity ()
 
 delete ()
 
 markChanged ()
 
 isChanged ()
 
 markDrop ()
 
 isDeleted ()
 
 fill (array $source)
 
 toArray ()
 
- Открытые члены унаследованные от RegistryEntry
 setRegistry (Registry $registry)
 
 getRegistry ()
 

Открытые статические члены

static isSubtypeValid (string $subtype)
 
static getSubtypeFromJsonFormat (string $subtypeInJsonFormat)
 
static getEntityClassName ()
 
static getRestEntityName ()
 
static getDataClass ()
 
static getByDiskFileId (int $diskFileId)
 

Открытые атрибуты

const MEDIA_SUBTYPE = 'MEDIA'
 
const AUDIO_SUBTYPE = 'AUDIO'
 
const BRIEF_SUBTYPE = 'BRIEF'
 
const OTHER_SUBTYPE = 'OTHER'
 
const DOCUMENT_SUBTYPE = 'DOCUMENT'
 
const ALLOWED_SUBTYPE
 
const BRIEF_CODE = 'resume'
 
const MEDIA_ORIGINAL_CODE = 'media_original'
 

Защищенные члены

 validateSubtype ()
 
 calculateSubtype ()
 
 getSubtypeByDiskFileType (string $diskFileType)
 

Защищенные статические члены

static getEntityIdFieldName ()
 
static mirrorDataEntityFields ()
 

Защищенные данные

string $subtype
 

Статические защищенные данные

static string $migrationOptionName = 'im_link_file_migration'
 

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

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

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

◆ __construct()

__construct ( $source = null)
Аргументы
int | array | EO_LinkFile | null$source

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

Методы

◆ calculateSubtype()

calculateSubtype ( )
protected

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

◆ fillFile()

fillFile ( )

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

◆ getByDiskFileId()

static getByDiskFileId ( int $diskFileId)
static

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

◆ getDataClass()

static getDataClass ( )
static

Returns ORM tablet class name.

Возвращает
string

Замещает ActiveRecord.

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

◆ getEntity()

getEntity ( )
Возвращает
Entity|\Bitrix\Im\V2\Entity\File\FileItem

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

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

◆ getEntityClassName()

static getEntityClassName ( )
static
Возвращает
string|RestEntity

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

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

◆ getEntityIdFieldName()

static getEntityIdFieldName ( )
staticprotected

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

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

◆ 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

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

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

◆ getRestEntityName()

static getRestEntityName ( )
static

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

Возвращает
string

Замещает RestConvertible.

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

◆ getSubtype()

getSubtype ( )

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

◆ getSubtypeByDiskFileType()

getSubtypeByDiskFileType ( string $diskFileType)
protected

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

◆ getSubtypeFromJsonFormat()

static getSubtypeFromJsonFormat ( string $subtypeInJsonFormat)
static

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

◆ isSubtypeValid()

static isSubtypeValid ( string $subtype)
static

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

◆ mirrorDataEntityFields()

static mirrorDataEntityFields ( )
staticprotected
См. также
FileItem::setSubtype
FileItem::getSubtype
FileItem::validateSubtype

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

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

◆ save()

save ( )

Saves object state into database.

Возвращает
Result

Замещает ActiveRecord.

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

◆ setChatId()

setChatId ( int $chatId)

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

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

◆ setEntity()

setEntity ( RestEntity $entity)
Аргументы
RestEntity$entity
Возвращает
static
Исключения
ArgumentTypeException

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

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

◆ setSubtype()

setSubtype ( string $subtype)

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

◆ toRestFormat()

toRestFormat ( array $option = [])

Returns an array in JSON like format to return the entity as a rest response.

Аргументы
array$option
Возвращает
array

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

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

◆ validateSubtype()

validateSubtype ( )
protected

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

Данные класса

◆ $migrationOptionName

string $migrationOptionName = 'im_link_file_migration'
staticprotected

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

◆ $subtype

string $subtype
protected

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

◆ ALLOWED_SUBTYPE

const ALLOWED_SUBTYPE
Инициализатор
= [
self::MEDIA_SUBTYPE,
self::AUDIO_SUBTYPE,
self::BRIEF_SUBTYPE,
self::OTHER_SUBTYPE,
self::DOCUMENT_SUBTYPE,
]

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

◆ AUDIO_SUBTYPE

const AUDIO_SUBTYPE = 'AUDIO'

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

◆ BRIEF_CODE

const BRIEF_CODE = 'resume'

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

◆ BRIEF_SUBTYPE

const BRIEF_SUBTYPE = 'BRIEF'

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

◆ DOCUMENT_SUBTYPE

const DOCUMENT_SUBTYPE = 'DOCUMENT'

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

◆ MEDIA_ORIGINAL_CODE

const MEDIA_ORIGINAL_CODE = 'media_original'

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

◆ MEDIA_SUBTYPE

const MEDIA_SUBTYPE = 'MEDIA'

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

◆ OTHER_SUBTYPE

const OTHER_SUBTYPE = 'OTHER'

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