Inheritance diagram for Info:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory, \Magento\Payment\Helper\Data $paymentData, \Magento\Framework\Encryption\EncryptorInterface $encryptor, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getData ($key='', $index=null)

	getMethodInstance ()

	encrypt ($data)

	decrypt ($data)

	setAdditionalInformation ($key, $value=null)

	getAdditionalInformation ($key=null)

	unsAdditionalInformation ($key=null)

	hasAdditionalInformation ($key=null)

Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getCustomAttributes ()

	getCustomAttribute ($attributeCode)

	setCustomAttributes (array $attributes)

	setCustomAttribute ($attributeCode, $attributeValue)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	setId ($value)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Protected Member Functions
	_initAdditionalInformation ()

Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)

	initializeCustomAttributes ()

	convertCustomAttributeValues (array &$customAttributes)

	getCustomAttributesCodes ()

	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

	_getExtensionAttributes ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_additionalInformation = []

	$_paymentData

	$_encryptor

Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory

	$extensionAttributes

	$customAttributeFactory

	$customAttributesCodes = null

	$customAttributesChanged = false

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Payment information model

@api

Since: 100.0.2

Definition at line 16 of file Info.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory,
		\Magento\Payment\Helper\Data	$paymentData,
		\Magento\Framework\Encryption\EncryptorInterface	$encryptor,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory

Definition at line 48 of file Info.php.

       {
         $this->_paymentData = $paymentData;
         $this->_encryptor = $encryptor;
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ _initAdditionalInformation()

_initAdditionalInformation ( )

protected

Initialize _additionalInformation with $this->_data['additional_information'] if empty

Returns: void

Definition at line 222 of file Info.php.

     {
         $additionalInfo = $this->_getData('additional_information');
         if (empty($this->_additionalInformation) && $additionalInfo) {
             $this->_additionalInformation = $additionalInfo;
         }
     }

◆ decrypt()

decrypt ( $data )

Decrypt data

Parameters

string $data

Returns: string

Implements InfoInterface.

Definition at line 139 of file Info.php.

     {
         return $this->_encryptor->decrypt($data);
     }

◆ encrypt()

encrypt ( $data )

Encrypt data

Parameters

string $data

Returns: string

Implements InfoInterface.

Definition at line 128 of file Info.php.

     {
         return $this->_encryptor->encrypt($data);
     }

◆ getAdditionalInformation()

getAdditionalInformation ( $key = null )

Getter for entire additional_information value or one of its element by key

Parameters

string $key

Returns: array|null|mixed

Implements InfoInterface.

Definition at line 174 of file Info.php.

     {
         $this->_initAdditionalInformation();
         if (null === $key) {
             return $this->_additionalInformation;
         }
         return isset($this->_additionalInformation[$key]) ? $this->_additionalInformation[$key] : null;
     }

◆ getData()

getData	(	$key = `''`,
		$index = `null`
	)

Retrieve data

Parameters

string	$key
mixed	$index

Returns: mixed

Definition at line 79 of file Info.php.

     {
         if ('cc_number' === $key) {
             if (empty($this->_data['cc_number']) && !empty($this->_data['cc_number_enc'])) {
                 $this->_data['cc_number'] = $this->decrypt($this->getCcNumberEnc());
             }
         }
         if ('cc_cid' === $key) {
             if (empty($this->_data['cc_cid']) && !empty($this->_data['cc_cid_enc'])) {
                 $this->_data['cc_cid'] = $this->decrypt($this->getCcCidEnc());
             }
         }
         return parent::getData($key, $index);
     }

◆ getMethodInstance()

getMethodInstance ( )

Retrieve payment method model object

Returns: \Magento\Payment\Model\MethodInterface

Exceptions

Implements InfoInterface.

Definition at line 100 of file Info.php.

     {
         if (!$this->hasMethodInstance()) {
             if (!$this->getMethod()) {
                 throw new \Magento\Framework\Exception\LocalizedException(
                     __('The payment method you requested is not available.')
                 );
             }
 
             try {
                 $instance = $this->_paymentData->getMethodInstance($this->getMethod());
             } catch (\UnexpectedValueException $e) {
                 $instance = $this->_paymentData->getMethodInstance(Method\Substitution::CODE);
             }
 
             $instance->setInfoInstance($this);
             $this->setMethodInstance($instance);
         }
 
         return $this->_getData('method_instance');
     }

◆ hasAdditionalInformation()

hasAdditionalInformation ( $key = null )

Check whether there is additional information by specified key

Parameters

mixed | null $key

Returns: bool

Implements InfoInterface.

Definition at line 208 of file Info.php.

     {
         $this->_initAdditionalInformation();
         return null === $key ? !empty($this->_additionalInformation) : array_key_exists(
             $key,
             $this->_additionalInformation
         );
     }

◆ setAdditionalInformation()

setAdditionalInformation	(	$key,
		$value = `null`
	)

Additional information setter Updates data inside the 'additional_information' array or all 'additional_information' if key is data array

Parameters

string \| array	$key
mixed	$value

Returns: $this

Exceptions

Implements InfoInterface.

Definition at line 154 of file Info.php.

     {
         if (is_object($value)) {
             throw new \Magento\Framework\Exception\LocalizedException(__('The payment disallows storing objects.'));
         }
         $this->_initAdditionalInformation();
         if (is_array($key) && $value === null) {
             $this->_additionalInformation = $key;
         } else {
             $this->_additionalInformation[$key] = $value;
         }
         return $this->setData('additional_information', $this->_additionalInformation);
     }

◆ unsAdditionalInformation()

unsAdditionalInformation ( $key = null )

Unsetter for entire additional_information value or one of its element by key

Parameters

string $key

Returns: $this

Implements InfoInterface.

Definition at line 189 of file Info.php.

     {
         if ($key && isset($this->_additionalInformation[$key])) {
             unset($this->_additionalInformation[$key]);
             return $this->setData('additional_information', $this->_additionalInformation);
         } elseif (null === $key) {
             $this->_additionalInformation = [];
             return $this->unsetData('additional_information');
         }
 
         return $this;
     }

Field Documentation

◆ $_additionalInformation

$_additionalInformation = []

protected

Definition at line 23 of file Info.php.

◆ $_encryptor

$_encryptor

protected

Definition at line 35 of file Info.php.

◆ $_paymentData

$_paymentData

protected

Definition at line 30 of file Info.php.

The documentation for this class was generated from the following file:

vendor/magento/module-payment/Model/Info.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _initAdditionalInformation()

◆ decrypt()

◆ encrypt()

◆ getAdditionalInformation()

◆ getData()

◆ getMethodInstance()

◆ hasAdditionalInformation()

◆ setAdditionalInformation()

◆ unsAdditionalInformation()

Field Documentation

◆ $_additionalInformation

◆ $_encryptor

◆ $_paymentData