Класс Mapper

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

Открытые члены
	getById (int $id)
	getByEntityObject ($entityObject)
	create (Core\Base\EntityInterface $entity, array $params=[])
	update (Core\Base\EntityInterface $entity, array $params=[])
	delete (Core\Base\EntityInterface $entity, array $params=['softDelete'=> true])
	deleteMap (Core\Base\EntityMap $map, array $params=['softDelete'=> true])
	deleteByFilter ($filter, array $params=['softDelete'=> true])
	getMap ($filter, int $limit=null, array $order=null)
	resetCacheById (int $id)

Поля данных
const	POSITIVE_ANSWER = 'Y'
const	NEGATIVE_ANSWER = 'N'

Защищенные члены
	getCacheMap ()
	initCacheMap (string $class)
	getMapClass ()
	getEntityClass ()
	getDataManagerResult (array $params)
	getOneEntityByFilter (array $filter)
	convertToObject ($objectEO)
	getEntityName ()
	createEntity ($entity, array $params=[])
	updateEntity ($entity, array $params=[])
	deleteEntity (Core\Base\EntityInterface $entity, array $params)

Защищенные данные
const	DEFAULT_SELECT = ['*']

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

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

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

Методы

convertToObject()

convertToObject ( $objectEO )

abstractprotected

Переопределяется в Connection, Event, EventCategory, EventConnection, EventOption, Section, SectionConnection, HandledMessageMapper, MessageMapper, CrmDealLinkMapper, EventLinkMapper, GroupLinkMapper и UserLinkMapper.

create()

create	(	Core\Base\EntityInterface	$entity,
		array	$params = [] )

Аргументы

Core\Base\EntityInterface	$entity
array	$params

Возвращает

Core\Base\EntityInterface|Core\Event\Event|\Bitrix\Calendar\Sync\Connection\Connection|Core\Section\Section|\Bitrix\Calendar\Sync\Connection\SectionConnection|\Bitrix\Calendar\Sync\Connection\EventConnection

Исключения

ArgumentException

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

createEntity()

createEntity ( $entity, array $params = [] )

abstractprotected

Аргументы

	$entity
array	$params

Возвращает

Core\Base\EntityInterface|null

Переопределяется в Connection, Event, EventCategory, EventConnection, EventOption, Section, SectionConnection, HandledMessageMapper, MessageMapper и LinkMapper.

delete()

delete	(	Core\Base\EntityInterface	$entity,
		array	$params = ['softDelete' => true] )

Аргументы

Core\Base\EntityInterface	$entity
array	$params

Возвращает

object|null

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

deleteByFilter()

deleteByFilter	(		$filter,
		array	$params = ['softDelete' => true] )

Аргументы

	$filter
array	$params

Возвращает

$this

Исключения

ArgumentException
SystemException

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

deleteEntity()

deleteEntity ( Core\Base\EntityInterface $entity, array $params )

abstractprotected

Аргументы

Core\Base\EntityInterface	$entity
array	$params

Возвращает

Core\Base\EntityInterface|null

Переопределяется в Connection, Event, EventConnection, Section и SectionConnection.

deleteMap()

deleteMap	(	Core\Base\EntityMap	$map,
		array	$params = ['softDelete' => true] )

Аргументы

Core\Base\EntityMap	$map
array	$params

Возвращает

void

Исключения

Core

Base\BaseException

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

getByEntityObject()

getByEntityObject

(

$entityObject

)

Исключения

ArgumentException

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

getById()

getById

(

int

$id

)

Аргументы

int

$id

Возвращает

Core\Base\EntityInterface|null

Исключения

ArgumentException

Переопределяется в EventCategory.

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

getCacheMap()

getCacheMap ( )

finalprotected

Возвращает

Core\Base\Map

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

getDataManagerResult()

getDataManagerResult ( array $params )

abstractprotected

Аргументы

array

$params

Возвращает

Result

Переопределяется в Connection, Event, EventCategory, EventConnection, EventOption, Section, SectionConnection, HandledMessageMapper, MessageMapper, JointLinkMapper и LinkMapper.

getEntityClass()

getEntityClass ( )

abstractprotected

Возвращает

string

Переопределяется в Connection, Event, EventCategory, EventConnection, EventOption, Section, SectionConnection, HandledMessageMapper, MessageMapper, CrmDealLinkMapper, EventLinkMapper, GroupLinkMapper и UserLinkMapper.

getEntityName()

getEntityName ( )

abstractprotected

Возвращает

string

Переопределяется в Connection, Event, EventCategory, EventConnection, EventOption, Section, SectionConnection, HandledMessageMapper, MessageMapper, CrmDealLinkMapper, EventLinkMapper, GroupLinkMapper и UserLinkMapper.

getMap()

getMap	(		$filter,
		int	$limit = null,
		array	$order = null )

Аргументы

array	$filter
int | null	$limit
array | null	$order

Возвращает

Core\Base\Map

Исключения

ArgumentException
SystemException

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

getMapClass()

getMapClass ( )

protected

redefine this method if you need using custom Map class

Возвращает

string

Переопределяется в Connection, Event, EventConnection, Section и SectionConnection.

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

getOneEntityByFilter()

getOneEntityByFilter ( array $filter )

abstractprotected

Аргументы

array

$filter

Возвращает

object|null

Переопределяется в Connection, Event, EventCategory, EventConnection, EventOption, Section и LinkMapper.

initCacheMap()

initCacheMap ( string $class )

protected

Аргументы

string

$class

Возвращает

void

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

resetCacheById()

resetCacheById

(

int

$id

)

Аргументы

int

$id

Возвращает

$this

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

update()

update	(	Core\Base\EntityInterface	$entity,
		array	$params = [] )

Аргументы

Core\Base\EntityInterface	$entity
array	$params

Возвращает

Core\Event\Event

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

updateEntity()

updateEntity ( $entity, array $params = [] )

abstractprotected

Аргументы

	$entity
array	$params

Возвращает

Core\Base\EntityInterface|null

Переопределяется в Connection, Event, EventCategory, EventConnection, EventOption, Section, SectionConnection, HandledMessageMapper, MessageMapper и LinkMapper.

Поля

$cache

array $cache = []

staticprotected

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

DEFAULT_SELECT

const DEFAULT_SELECT = ['*']

protected

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

NEGATIVE_ANSWER

const NEGATIVE_ANSWER = 'N'

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

POSITIVE_ANSWER

const POSITIVE_ANSWER = 'Y'

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

---

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

• C:/bitrix/modules/calendar/lib/core/mappers/mapper.php