Documentation

PaymentCollection

\Bitrix\Sale\PaymentCollection class for payment collections.


Inheritance chain

\Bitrix\Sale\PaymentCollection > \Bitrix\Sale\Internals\CollectableEntity > \Bitrix\Sale\Internals\Entity

Class methods

MethodDescription Available from version
createInnerPayment Creates payment for internal account payment systems.
createItem Creates a payment.
getInnerPayment Searches the collection for a payment from internal account and returns it When such payment doesn't exist, returns false.
getOrder Returns order with associated collection.
getPaidSum Returns amount paid.
getRegistryType Returns register type for an object.
getSum Returns total for all payments.
hasPaidPayment Checks if order has payments that are paid.
isExistsInnerPayment Checks, if collection contains payment from internal account.
isMarked Checks, if there are payments marked as problematic.
isPaid Checks, if all payments, included into the order, are paid.
load Returns order with associated collection заказ, к которому привязана коллекция.
loadForOrder Returns array with payment objects for an order.
setOrder Associates order to a collection.

Methods for parent class \Bitrix\Sale\Internals\CollectableEntity

MethodDescription Available from version
createCloneClones this item.
deleteDeletes an item.
doFinalActionExecutes finalizing actions.
getCollectionReturns collection with associated item.
getInternalIndexReturns internal index for a collection item.
isCloneChecks if this item is a clone.
setCollectionAssociates collection to an item.

Methods for parent class \Bitrix\Sale\Internals\Entity

MethodDescription Available from version
doFinalActionAbstract method, designed to implement "final" calculation logic.
getAvailableFieldsReturns array of fields to be set via methods setField() and setFields().
getAvailableFieldsMapReturns array of fields to be set via the methods setField() and setFields(). getAvailableFields values are used as array keys.
getFieldReturns value for $name field.
getFieldValuesReturns array of fields with values.
getIdReturns entity ID.
initFieldInitializes field by a value. Object is not considered as updated.
initFieldsInitializes fields by values. Object is not considered as updated.
isChangedChecks, if entity was updated. If yes, returns true, otherwise returns false.
isMathActionOnlyChecks, if current data is used for calculations (provider data is not requested). If yes, returns true, otherwise returns false.
setFieldSets values for the field $name.
setFieldsInitializes fields by values. Object is not considered as updated.
setMathActionOnlyDisables requests to provider when during calculations.
verifyChecks, if object is correct. Returns object \Bitrix\Sale\Result.


© «Bitrix24», 2001-2022
Up