Bitrix API

ContactCompanyCollection extends EntityCollection

Class ContactCompanyCollection

Table of Contents

Methods

addItem()  : CollectableEntity
clearCollection()  : mixed
clearStartField()  : bool
count()  : int
Count elements of an object
createCompany()  : mixed
createContact()  : mixed
current()  : mixed
Return the current element
disableAutoCreationMode()  : void
doFinalAction()  : Result
getCompanies()  : CollectionFilterIterator
getCompany()  : Company|null
Returns the company that is bound to the order Order doesn't supports multiple companies For details, @see ContactCompanyCollection::addItem()
getContacts()  : CollectionFilterIterator
getEntityCommunication()  : Company|Contact|null
getEntityCommunicationPhone()  : string|null
getIndexById()  : bool|int|null
getItemById()  : CollectableEntity|null
getItemByIdentifier()  : ContactCompanyEntity|null
Returns an entity specified by the identifier
getItemByIndex()  : CollectableEntity|null
getIterator()  : ArrayIterator
getList()  : Result
getOrder()  : null
getPrimaryCompany()  : Company|null
getPrimaryContact()  : Contact|null
getRegistryType()  : string
hasMeaningfulField()  : bool
isAnyItemAdded()  : bool
isAnyItemDeleted()  : bool
isAutoCreationModeEnabled()  : bool
isChanged()  : bool
isClone()  : bool
isEmpty()  : bool
Checks if collection is empty.
isMathActionOnly()  : bool
isPrimaryItemExists()  : bool
isStartField()  : bool
key()  : mixed
Return the key of the current element
load()  : ContactCompanyCollection
next()  : mixed
Move forward to next element
offsetExists()  : bool
Whether a offset exists
offsetGet()  : mixed
Offset to retrieve
offsetSet()  : void
Offset to set
offsetUnset()  : void
Offset to unset
rewind()  : mixed
Rewind the Iterator to the first element
save()  : Result
setMathActionOnly()  : bool
setOrder()  : mixed
toArray()  : mixed
valid()  : mixed
Checks if current position is valid
verify()  : Result

Methods

clearCollection()

public clearCollection() : mixed
Tags
throws
ArgumentOutOfRangeException
throws
ObjectNotFoundException

count()

Count elements of an object

public count() : int
Return values
int

createCompany()

public createCompany() : mixed
Tags
throws
ArgumentException
throws
ArgumentTypeException
throws
SystemException

createContact()

public createContact() : mixed
Tags
throws
ArgumentException
throws
ArgumentTypeException
throws
SystemException

doFinalAction()

public doFinalAction([bool $hasMeaningfulField = false ]) : Result
Parameters
$hasMeaningfulField : bool = false
Return values
Result

getCompany()

Returns the company that is bound to the order Order doesn't supports multiple companies For details, @see ContactCompanyCollection::addItem()

public getCompany() : Company|null
Return values
Company|null

getEntityCommunicationPhone()

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

getIndexById()

public getIndexById(mixed $id) : bool|int|null
Parameters
$id : mixed
Tags
throws
ArgumentNullException
Return values
bool|int|null

getIterator()

public getIterator() : ArrayIterator
Return values
ArrayIterator

getList()

public static getList([array<string|int, mixed> $parameters = array() ]) : Result
Parameters
$parameters : array<string|int, mixed> = array()
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

hasMeaningfulField()

public hasMeaningfulField() : bool
Return values
bool

isEmpty()

Checks if collection is empty.

public isEmpty() : bool
Return values
bool

isPrimaryItemExists()

public isPrimaryItemExists(mixed $type) : bool
Parameters
$type : mixed
Return values
bool

isStartField()

public isStartField([bool $isMeaningfulField = false ]) : bool
Parameters
$isMeaningfulField : bool = false
Return values
bool

key()

Return the key of the current element

public key() : mixed

offsetExists()

Whether a offset exists

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

Offset to retrieve

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Attributes
#[ReturnTypeWillChange]

offsetSet()

Offset to set

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

offsetUnset()

Offset to unset

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

rewind()

Rewind the Iterator to the first element

public rewind() : mixed

save()

public save() : Result
Tags
throws
ArgumentException
throws
ObjectNotFoundException
throws
ObjectPropertyException
throws
SystemException
throws
Exception
Return values
Result

setMathActionOnly()

public setMathActionOnly([bool|false $value = false ]) : bool
Parameters
$value : bool|false = false
Return values
bool

valid()

Checks if current position is valid

public valid() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results