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

Открытые члены
	createItem (Service $service=null)

	addItem (Internals\CollectableEntity $payment)

	deleteItem ($index)

	onItemModify (Internals\CollectableEntity $item, $name=null, $oldValue=null, $value=null)

	isPaid ()

	onOrderModify ($name, $oldValue, $value)

	setOrder (Order $order)

	getOrder ()

	getPaidSum ()

	getSum ()

	hasPaidPayment ()

	hasUnpaidPayment ()

	save ()

	getInnerPayment ()

	createInnerPayment ()

	isExistsInnerPayment ()

	verify ()

	createClone (\SplObjectStorage $cloneEntity)

	isMarked ()
	Is the entire collection of marked. Подробнее...

Открытые члены унаследованные от EntityCollection
	onItemModify (CollectableEntity $item, $name=null, $oldValue=null, $value=null)

	clearCollection ()

	getItemById ($id)

	getIndexById ($id)

	getItemByIndex ($index)

	isStartField ($isMeaningfulField=false)

	clearStartField ()

	hasMeaningfulField ()

	doFinalAction ($hasMeaningfulField=false)

	isMathActionOnly ()

	setMathActionOnly ($value=false)

	isChanged ()

	isClone ()

	isAnyItemDeleted ()

	clearChanged ()

Открытые члены унаследованные от CollectionBase
	getIterator ()

	offsetExists ($offset)
	Whether a offset exists. Подробнее...

	offsetGet ($offset)
	Offset to retrieve. Подробнее...

	offsetSet ($offset, $value)
	Offset to set. Подробнее...

	offsetUnset ($offset)
	Offset to unset. Подробнее...

	count ()
	Count elements of an object. Подробнее...

	current ()
	Return the current element. Подробнее...

	next ()
	Move forward to next element. Подробнее...

	key ()
	Return the key of the current element. Подробнее...

	valid ()
	Checks if current position is valid. Подробнее...

	rewind ()
	Rewind the Iterator to the first element. Подробнее...

	isEmpty ()
	Checks if collection is empty. Подробнее...

Открытые статические члены
static	getRegistryType ()

static	load (Order $order)

static	getList (array $parameters=array())

static	getInnerPaySystemId ()

Защищенные члены
	getEntityParent ()

	deleteInternal ($primary)

Защищенные члены унаследованные от EntityCollection
	__construct ()
	EntityCollection constructor. Подробнее...

	addItem (CollectableEntity $item)

	createIndex ()

	getDeletableItems ()

	callEventOnBeforeCollectionClear ()

	setAnyItemDeleted ($value)

Защищенные статические члены
static	createPaymentCollectionObject ()

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

Защищенные данные унаследованные от EntityCollection
	$isClone = false

	$anyItemDeleted = false

Защищенные данные унаследованные от CollectionBase
	$collection = array()

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

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

Методы

◆ addItem()

addItem ( Internals\CollectableEntity $payment )

Аргументы

Internals\CollectableEntity $payment

Возвращает: Result

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

     {
         /** @var Payment $payment */
         $payment = parent::addItem($payment);
  
         $order = $this->getOrder();
         return $order->onPaymentCollectionModify(EventActions::ADD, $payment);
     }

◆ createClone()

createClone ( \SplObjectStorage $cloneEntity )

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

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

     {
         if ($this->isClone() && $cloneEntity->contains($this))
         {
             return $cloneEntity[$this];
         }
  
         /** @var PaymentCollection $paymentCollectionClone */
         $paymentCollectionClone = parent::createClone($cloneEntity);
  
         if ($this->order)
         {
             if ($cloneEntity->contains($this->order))
             {
                 $paymentCollectionClone->order = $cloneEntity[$this->order];
             }
         }
  
         return $paymentCollectionClone;
     }

◆ createInnerPayment()

createInnerPayment ( )

Возвращает: Payment|bool

Исключения

Main

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

     {
         $payment = $this->getInnerPayment();
         if ($payment)
         {
             return $payment;
         }
  
         $paySystemId = PaySystem\Manager::getInnerPaySystemId();
         if (!empty($paySystemId))
         {
             /** @var Service $paySystem */
             $paySystem = Manager::getObjectById($paySystemId);
             if ($paySystem)
             {
                 return $this->createItem($paySystem);
             }
         }
  
         return false;
     }

◆ createItem()

createItem ( Service $service = null )

Аргументы

Service | null $service

Возвращает: Payment

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

     {
         /** @var Payment $paymentClassName */
         $paymentClassName = static::getItemCollectionClassName();
  
         $payment = $paymentClassName::create($this, $service);
         $this->addItem($payment);
  
         return $payment;
     }

◆ createPaymentCollectionObject()

static createPaymentCollectionObject ( )

staticprotected

Возвращает: PaymentCollection

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

     {
         $registry = Registry::getInstance(static::getRegistryType());
         $paymentCollectionClassName = $registry->getPaymentCollectionClassName();
  
         return new $paymentCollectionClassName();
     }

◆ deleteInternal()

deleteInternal ( $primary )

protected

Аргументы

$primary

Возвращает: Entity\DeleteResult

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

     {
         return Internals\PaymentTable::delete($primary);
     }

◆ deleteItem()

deleteItem ( $index )

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

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

     {
         $oldItem = parent::deleteItem($index);
  
         /** @var Order $order */
         $order = $this->getOrder();
         return $order->onPaymentCollectionModify(EventActions::DELETE, $oldItem);
     }

◆ getEntityParent()

getEntityParent ( )

protected

Возвращает: Order

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

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

     {
         return $this->getOrder();
     }

◆ getInnerPayment()

getInnerPayment ( )

Возвращает: Payment|bool

Исключения

Main

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

     {
         /** @var Order $order */
         if (!$order = $this->getOrder())
         {
             throw new Main\ObjectNotFoundException('Entity "Order" not found');
         }
  
         if ($paySystemId = PaySystem\Manager::getInnerPaySystemId())
         {
             /** @var Payment $payment */
             foreach ($this->collection as $payment)
             {
                 if ($payment->getPaymentSystemId() == $paySystemId)
                     return $payment;
             }
         }
  
         return false;
     }

◆ getInnerPaySystemId()

static getInnerPaySystemId ( )

static

Уст.:: Use \Bitrix\Sale\PaySystem\Manager::getInnerPaySystemId instead

Возвращает: int

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

     {
         return PaySystem\Manager::getInnerPaySystemId();
     }

◆ getList()

static getList ( array $parameters = array() )

static

Аргументы

array $parameters

Возвращает: Main\DB\Result

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

     {
         return Internals\PaymentTable::getList($parameters);
     }

◆ getOrder()

getOrder ( )

Возвращает: Order

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

     {
         return $this->order;
     }

◆ getPaidSum()

getPaidSum ( )

Возвращает: float

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

     {
         $sum = 0;
         if (!empty($this->collection) && is_array($this->collection))
         {
             /** @var Payment $payment */
             foreach ($this->collection as $payment)
             {
                 if ($payment->getField('PAID') == "Y")
                 {
                     $sum += $payment->getSum();
                 }
             }
         }
  
         return $sum;
     }

◆ getRegistryType()

static getRegistryType ( )

static

Возвращает: string

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

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

     {
         return Registry::REGISTRY_TYPE_ORDER;
     }

◆ getSum()

getSum ( )

Возвращает: float

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

     {
         $sum = 0;
         if (!empty($this->collection) && is_array($this->collection))
         {
             /** @var Payment $payment */
             foreach ($this->collection as $payment)
             {
                 $sum += $payment->getSum();
             }
         }
  
         return $sum;
     }

◆ hasPaidPayment()

hasPaidPayment ( )

Возвращает: bool

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

     {
         /** @var Payment $payment */
         foreach ($this->collection as $payment)
         {
             if ($payment->getField('PAID') === "Y")
             {
                 return true;
             }
         }
  
         return false;
     }

◆ hasUnpaidPayment()

hasUnpaidPayment ( )

Возвращает: bool

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

     {
         /** @var Payment $payment */
         foreach ($this->collection as $payment)
         {
             if ($payment->getField('PAID') === "N")
             {
                 return true;
             }
         }
  
         return false;
     }

◆ isExistsInnerPayment()

isExistsInnerPayment ( )

Возвращает: bool

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

     {
         if ($paySystemId = PaySystem\Manager::getInnerPaySystemId())
         {
             /** @var Payment $payment */
             foreach ($this->collection as $payment)
             {
                 if ($payment->getPaymentSystemId() == $paySystemId)
                     return true;
             }
         }
  
         return false;
     }

◆ isMarked()

isMarked ( )

Is the entire collection of marked.

Возвращает: bool

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

     {
         if (!empty($this->collection) && is_array($this->collection))
         {
             /** @var Payment $payment */
             foreach ($this->collection as $payment)
             {
                 if ($payment->isMarked())
                     return true;
             }
         }
  
         return false;
     }

◆ isPaid()

isPaid ( )

Возвращает: bool

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

     {
         if (!empty($this->collection) && is_array($this->collection))
         {
             /** @var Payment $payment */
             foreach ($this->collection as $payment)
             {
                 if (!$payment->isPaid())
                     return false;
             }
  
             return true;
         }
  
         return false;
     }

◆ load()

static load ( Order $order )

static

Аргументы

Order $order

Возвращает: PaymentCollection

Исключения

Main

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

     {
         /** @var PaymentCollection $paymentCollection */
         $paymentCollection = static::createPaymentCollectionObject();
         $paymentCollection->setOrder($order);
  
         if ($order->getId() > 0)
         {
             /** @var Payment $paymentClassName */
             $paymentClassName = static::getItemCollectionClassName();
  
             $paymentList = $paymentClassName::loadForOrder($order->getId());
             /** @var Payment $payment */
             foreach ($paymentList as $payment)
             {
                 $payment->setCollection($paymentCollection);
                 $paymentCollection->addItem($payment);
             }
         }
  
         return $paymentCollection;
     }

◆ onItemModify()

onItemModify	(	Internals\CollectableEntity	$item,
			$name = `null`,
			$oldValue = `null`,
			$value = `null`
	)

Аргументы

Internals\CollectableEntity	$item
null	$name
null	$oldValue
null	$value

Возвращает: Result

Исключения

Main

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

     {
         /** @var Order $order */
         $order = $this->getOrder();
         return $order->onPaymentCollectionModify(EventActions::UPDATE, $item, $name, $oldValue, $value);
     }

◆ onOrderModify()

onOrderModify	(	$name,
		$oldValue,
		$value
	)

Аргументы

$name
$oldValue
$value

Возвращает: Result

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

     {
         $result = new Result();
  
         switch($name)
         {
             case "CANCELED":
  
                 if ($value == "Y")
                 {
                     $isPaid = false;
  
                     /** @var Payment $payment */
                     foreach ($this->collection as $payment)
                     {
                         if ($payment->isPaid())
                         {
                             $isPaid = true;
                             break;
                         }
                     }
  
                     if ($isPaid)
                     {
                         $result->addError(new ResultError(Loc::getMessage('SALE_ORDER_CANCEL_PAYMENT_EXIST_ACTIVE'), 'SALE_ORDER_CANCEL_PAYMENT_EXIST_ACTIVE'));
                     }
                 }
  
             break;
  
             case "PRICE":
                 if (($order = $this->getOrder()) && !$order->isCanceled())
                 {
                     $currentPayment = false;
                     $allowSumChange = false;
                     if (count($this->collection) == 1)
                     {
                         /** @var Payment $currentPayment */
                         if ($currentPayment = $this->rewind())
                         {
                             $allowSumChange = (bool)(!$currentPayment->isPaid() && !$currentPayment->isReturn() && ($currentPayment->getSum() == $oldValue));
                             
                             if ($allowSumChange)
                             {
                                 if ($paySystemService = $currentPayment->getPaysystem())
                                 {
                                     $allowSumChange = $paySystemService->isAllowEditPayment();
                                 }
                             }
                         }
                     }
  
                     if ($allowSumChange && $currentPayment)
                     {
                         $r = $currentPayment->setField("SUM", $value);
                         if (!$r->isSuccess())
                         {
                             $result->addErrors($r->getErrors());
                         }
  
                         $service = $currentPayment->getPaySystem();
                         if ($service)
                         {
                             $price = $service->getPaymentPrice($currentPayment);
                             $currentPayment->setField('PRICE_COD', $price);
                         }
                     }
                 }
             break;
         }
  
         return $result;
     }

◆ save()

save ( )

Возвращает: Entity\Result

Исключения

Main

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

     {
         $result = new Entity\Result();
  
         /** @var Order $order */
         if (!$order = $this->getOrder())
         {
             throw new Main\ObjectNotFoundException('Entity "Order" not found');
         }
  
         $itemsFromDb = array();
         if ($this->getOrder()->getId() > 0)
         {
             $itemsFromDbList = static::getList(
                 array(
                     "filter" => array("ORDER_ID" => $this->getOrder()->getId()),
                     "select" => array("ID", "PAY_SYSTEM_NAME", "PAY_SYSTEM_ID")
                 )
             );
             while ($itemsFromDbItem = $itemsFromDbList->fetch())
                 $itemsFromDb[$itemsFromDbItem["ID"]] = $itemsFromDbItem;
         }
  
         $changeMeaningfulFields = array(
             "PAID",
             "PAY_SYSTEM_ID",
             "PAY_SYSTEM_NAME",
             "SUM",
             "IS_RETURN",
             "ACCOUNT_NUMBER",
             "EXTERNAL_PAYMENT",
         );
  
         /** @var Payment $payment */
         foreach ($this->collection as $payment)
         {
             $isNew = (bool)($payment->getId() <= 0);
             $isChanged = $payment->isChanged();
  
             if ($order->getId() > 0 && $isChanged)
             {
                 $logFields = array();
  
                 $fields = $payment->getFields();
                 $originalValues = $fields->getOriginalValues();
  
                 foreach($originalValues as $originalFieldName => $originalFieldValue)
                 {
                     if (in_array($originalFieldName, $changeMeaningfulFields) && $payment->getField($originalFieldName) != $originalFieldValue)
                     {
                         $logFields[$originalFieldName] = $payment->getField($originalFieldName);
                         if (!$isNew)
                             $logFields['OLD_'.$originalFieldName] = $originalFieldValue;
                     }
                 }
             }
  
             $r = $payment->save();
             if ($r->isSuccess())
             {
                 if ($order->getId() > 0)
                 {
                     if ($isChanged)
                     {
                         $registry = Registry::getInstance(static::getRegistryType());
  
                         /** @var OrderHistory $orderHistory */
                         $orderHistory = $registry->getOrderHistoryClassName();
                         $orderHistory::addLog(
                             'PAYMENT',
                             $order->getId(),
                             $isNew ? 'PAYMENT_ADD' : 'PAYMENT_UPDATE',
                             $payment->getId(),
                             $payment,
                             $logFields,
                             $orderHistory::SALE_ORDER_HISTORY_LOG_LEVEL_1
                         );
                         
                         $orderHistory::addAction(
                             'PAYMENT',
                             $order->getId(),
                             "PAYMENT_SAVED",
                             $payment->getId(),
                             $payment,
                             array(),
                             OrderHistory::SALE_ORDER_HISTORY_ACTION_LOG_LEVEL_1
                         );
                     }
  
                 }
             }
             else
             {
                 $result->addErrors($r->getErrors());
             }
  
             if (isset($itemsFromDb[$payment->getId()]))
                 unset($itemsFromDb[$payment->getId()]);
         }
  
         foreach ($itemsFromDb as $k => $v)
         {
             $v['ENTITY_REGISTRY_TYPE'] = static::getRegistryType();
  
             /** @var Main\Event $event */
             $event = new Main\Event('sale', "OnBeforeSalePaymentDeleted", array(
                     'VALUES' => $v,
             ));
             $event->send();
  
             static::deleteInternal($k);
  
             /** @var Main\Event $event */
             $event = new Main\Event('sale', "OnSalePaymentDeleted", array(
                     'VALUES' => $v,
             ));
             $event->send();
  
             if ($order->getId() > 0)
             {
                 $registry = Registry::getInstance(static::getRegistryType());
  
                 /** @var OrderHistory $orderHistory */
                 $orderHistory = $registry->getOrderHistoryClassName();
                 $orderHistory::addAction('PAYMENT', $order->getId(), 'PAYMENT_REMOVE', $k, null, array(
                     "PAY_SYSTEM_NAME" => $v["PAY_SYSTEM_NAME"],
                     "PAY_SYSTEM_ID" => $v["PAY_SYSTEM_ID"],
                 ));
  
                 $registry = Registry::getInstance(static::getRegistryType());
  
                 /** @var EntityMarker $entityMarker */
                 $entityMarker = $registry->getEntityMarkerClassName();
                 $entityMarker::deleteByFilter(array(
                      '=ORDER_ID' => $order->getId(),
                      '=ENTITY_TYPE' => $entityMarker::ENTITY_TYPE_PAYMENT,
                      '=ENTITY_ID' => $k,
                 ));
             }
  
         }
  
         if ($order->getId() > 0)
         {
             $registry = Registry::getInstance(static::getRegistryType());
  
             /** @var OrderHistory $orderHistory */
             $orderHistory = $registry->getOrderHistoryClassName();
             $orderHistory::collectEntityFields('PAYMENT', $order->getId());
         }
  
         return $result;
     }

◆ setOrder()

setOrder ( Order $order )

Аргументы

Order $order

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

     {
         $this->order = $order;
     }

◆ verify()

verify ( )

Возвращает: Result

Исключения

Main

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

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

     {
         $result = new Result();
  
         /** @var Payment $payment */
         foreach ($this->collection as $payment)
         {
             $r = $payment->verify();
             if (!$r->isSuccess())
             {
                 $result->addErrors($r->getErrors());
                 
                 /** @var Order $order */
                 if (!$order = $this->getOrder())
                 {
                     throw new Main\ObjectNotFoundException('Entity "Order" not found');
                 }
  
                 $registry = Registry::getInstance(static::getRegistryType());
  
                 /** @var EntityMarker $entityMarker */
                 $entityMarker = $registry->getEntityMarkerClassName();
                 $entityMarker::addMarker($order, $payment, $r);
                 $order->setField('MARKED', 'Y');
             }
         }
         return $result;
     }

Поля

◆ $order

$order

protected

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

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

paymentcollection.php

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

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

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

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

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

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

Методы

◆ addItem()

◆ createClone()

◆ createInnerPayment()

◆ createItem()

◆ createPaymentCollectionObject()

◆ deleteInternal()

◆ deleteItem()

◆ getEntityParent()

◆ getInnerPayment()

◆ getInnerPaySystemId()

◆ getList()

◆ getOrder()

◆ getPaidSum()

◆ getRegistryType()

◆ getSum()

◆ hasPaidPayment()

◆ hasUnpaidPayment()

◆ isExistsInnerPayment()

◆ isMarked()

◆ isPaid()

◆ load()

◆ onItemModify()

◆ onOrderModify()

◆ save()

◆ setOrder()

◆ verify()

Поля

◆ $order