Inheritance diagram for History:

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

	setOrder (\Magento\Sales\Model\Order $order)

	setIsCustomerNotified ($flag=null)

	isCustomerNotificationNotApplicable ()

	getOrder ()

	getStatusLabel ()

	getStore ()

	beforeSave ()

	getComment ()

	getCreatedAt ()

	setCreatedAt ($createdAt)

	getEntityId ()

	getEntityName ()

	getIsCustomerNotified ()

	getIsVisibleOnFront ()

	getParentId ()

	getStatus ()

	setParentId ($id)

	setIsVisibleOnFront ($isVisibleOnFront)

	setComment ($comment)

	setStatus ($status)

	setEntityName ($entityName)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Sales\Api\Data\OrderStatusHistoryExtensionInterface $extensionAttributes)

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

	getEventObject ()

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)

Public Member Functions inherited from OrderStatusHistoryInterface
	setEntityId ($entityId)

	setExtensionAttributes (\Magento\Sales\Api\Data\OrderStatusHistoryExtensionInterface $extensionAttributes)

Data Fields
const	CUSTOMER_NOTIFICATION_NOT_APPLICABLE = 2

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Data Fields inherited from OrderStatusHistoryInterface
const	ENTITY_ID = 'entity_id'

const	PARENT_ID = 'parent_id'

const	IS_CUSTOMER_NOTIFIED = 'is_customer_notified'

const	IS_VISIBLE_ON_FRONT = 'is_visible_on_front'

const	COMMENT = 'comment'

const	STATUS = 'status'

const	CREATED_AT = 'created_at'

const	ENTITY_NAME = 'entity_name'

Protected Member Functions
	_construct ()

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
	$_order

	$_eventPrefix = 'sales_order_status_history'

	$_eventObject = 'status_history'

	$_storeManager

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
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Order status history comments

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 19 of file History.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		AttributeValueFactory	$customAttributeFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\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
AttributeValueFactory	$customAttributeFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 56 of file History.php.

       {
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $resource,
             $resourceCollection,
             $data
         );
         $this->_storeManager = $storeManager;
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Initialize resource model

Returns: void

Definition at line 83 of file History.php.

     {
         $this->_init(\Magento\Sales\Model\ResourceModel\Order\Status\History::class);
     }

◆ beforeSave()

beforeSave ( )

Set order again if required

Returns: $this

Definition at line 169 of file History.php.

     {
         parent::beforeSave();
 
         if (!$this->getParentId() && $this->getOrder()) {
             $this->setParentId($this->getOrder()->getId());
         }
 
         return $this;
     }

◆ getComment()

getComment ( )

Returns comment

Returns: string

Implements OrderStatusHistoryInterface.

Definition at line 187 of file History.php.

     {
         return $this->getData(OrderStatusHistoryInterface::COMMENT);
     }

◆ getCreatedAt()

getCreatedAt ( )

Returns created_at

Returns: string

Implements OrderStatusHistoryInterface.

Definition at line 197 of file History.php.

     {
         return $this->getData(OrderStatusHistoryInterface::CREATED_AT);
     }

◆ getEntityId()

getEntityId ( )

Returns entity_id

Returns: int

Implements OrderStatusHistoryInterface.

Definition at line 215 of file History.php.

     {
         return $this->getData(OrderStatusHistoryInterface::ENTITY_ID);
     }

◆ getEntityName()

getEntityName ( )

Returns entity_name

Returns: string

Implements OrderStatusHistoryInterface.

Definition at line 225 of file History.php.

     {
         return $this->getData(OrderStatusHistoryInterface::ENTITY_NAME);
     }

◆ getExtensionAttributes()

getExtensionAttributes ( )

{Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Sales\Api\Data\OrderStatusHistoryExtensionInterface|null

}

Returns: \Magento\Sales\Api\Data\OrderStatusHistoryExtensionInterface|null

Implements OrderStatusHistoryInterface.

Definition at line 315 of file History.php.

     {
         return $this->_getExtensionAttributes();
     }

◆ getIsCustomerNotified()

getIsCustomerNotified ( )

Returns is_customer_notified

Returns: int

Implements OrderStatusHistoryInterface.

Definition at line 235 of file History.php.

     {
         return $this->getData(OrderStatusHistoryInterface::IS_CUSTOMER_NOTIFIED);
     }

◆ getIsVisibleOnFront()

getIsVisibleOnFront ( )

Returns is_visible_on_front

Returns: int

Implements OrderStatusHistoryInterface.

Definition at line 245 of file History.php.

     {
         return $this->getData(OrderStatusHistoryInterface::IS_VISIBLE_ON_FRONT);
     }

◆ getOrder()

getOrder ( )

Retrieve order instance

@codeCoverageIgnore

Returns: \Magento\Sales\Model\Order

Definition at line 133 of file History.php.

     {
         return $this->_order;
     }

◆ getParentId()

getParentId ( )

Returns parent_id

Returns: int

Implements OrderStatusHistoryInterface.

Definition at line 255 of file History.php.

     {
         return $this->getData(OrderStatusHistoryInterface::PARENT_ID);
     }

◆ getStatus()

getStatus ( )

Returns status

Returns: string

Implements OrderStatusHistoryInterface.

Definition at line 265 of file History.php.

     {
         return $this->getData(OrderStatusHistoryInterface::STATUS);
     }

◆ getStatusLabel()

getStatusLabel ( )

Retrieve status label

Returns: string|null

Definition at line 143 of file History.php.

     {
         if ($this->getOrder()) {
             return $this->getOrder()->getConfig()->getStatusLabel($this->getStatus());
         }
         return null;
     }

◆ getStore()

getStore ( )

Get store object

Returns: \Magento\Store\Model\Store

Definition at line 156 of file History.php.

     {
         if ($this->getOrder()) {
             return $this->getOrder()->getStore();
         }
         return $this->_storeManager->getStore();
     }

◆ isCustomerNotificationNotApplicable()

isCustomerNotificationNotApplicable ( )

Customer Notification Applicable check method

Returns: boolean

Definition at line 121 of file History.php.

     {
         return $this->getIsCustomerNotified() == self::CUSTOMER_NOTIFICATION_NOT_APPLICABLE;
     }

◆ setComment()

setComment ( $comment )

{Sets the comment for the order status history.

Parameters

string $comment

Returns: $this

}

Implements OrderStatusHistoryInterface.

Definition at line 289 of file History.php.

     {
         return $this->setData(OrderStatusHistoryInterface::COMMENT, $comment);
     }

◆ setCreatedAt()

setCreatedAt ( $createdAt )

{Sets the created-at timestamp for the order status history.

Parameters

string $createdAt timestamp

Returns: $this

}

Implements OrderStatusHistoryInterface.

Definition at line 205 of file History.php.

     {
         return $this->setData(OrderStatusHistoryInterface::CREATED_AT, $createdAt);
     }

◆ setEntityName()

setEntityName ( $entityName )

{Sets the entity name for the order status history.

Parameters

string $entityName

Returns: $this

}

Implements OrderStatusHistoryInterface.

Definition at line 305 of file History.php.

     {
         return $this->setData(OrderStatusHistoryInterface::ENTITY_NAME, $entityName);
     }

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Sales\Api\Data\OrderStatusHistoryExtensionInterface $extensionAttributes )

{}

Parameters

\Magento\Sales\Api\Data\OrderStatusHistoryExtensionInterface $extensionAttributes

Returns: $this

Definition at line 326 of file History.php.

       {
         return $this->_setExtensionAttributes($extensionAttributes);
     }

◆ setIsCustomerNotified()

setIsCustomerNotified ( $flag = null )

Notification flag

Parameters

mixed $flag OPTIONAL (notification is not applicable by default)

Returns: $this

Implements OrderStatusHistoryInterface.

Definition at line 107 of file History.php.

     {
         if ($flag === null) {
             $flag = self::CUSTOMER_NOTIFICATION_NOT_APPLICABLE;
         }
 
         return $this->setData('is_customer_notified', $flag);
     }

◆ setIsVisibleOnFront()

setIsVisibleOnFront ( $isVisibleOnFront )

{Sets the is-visible-on-storefront flag value for the order status history.

Parameters

int $isVisibleOnFront

Returns: $this

}

Implements OrderStatusHistoryInterface.

Definition at line 281 of file History.php.

     {
         return $this->setData(OrderStatusHistoryInterface::IS_VISIBLE_ON_FRONT, $isVisibleOnFront);
     }

◆ setOrder()

setOrder ( \Magento\Sales\Model\Order $order )

Set order object and grab some metadata from it

Parameters

\Magento\Sales\Model\Order $order

Returns: $this

Definition at line 94 of file History.php.

     {
         $this->_order = $order;
         $this->setStoreId($order->getStoreId());
         return $this;
     }

◆ setParentId()

setParentId ( $id )

{Sets the parent ID for the order status history.

Parameters

int $id

Returns: $this

}

Implements OrderStatusHistoryInterface.

Definition at line 273 of file History.php.

     {
         return $this->setData(OrderStatusHistoryInterface::PARENT_ID, $id);
     }

◆ setStatus()

setStatus ( $status )

{Sets the status for the order status history.

Parameters

string $status

Returns: $this

}

Implements OrderStatusHistoryInterface.

Definition at line 297 of file History.php.

     {
         return $this->setData(OrderStatusHistoryInterface::STATUS, $status);
     }

Field Documentation

◆ $_eventObject

$_eventObject = 'status_history'

protected

Definition at line 38 of file History.php.

◆ $_eventPrefix

$_eventPrefix = 'sales_order_status_history'

protected

Definition at line 33 of file History.php.

◆ $_order

$_order

protected

Definition at line 28 of file History.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 43 of file History.php.

◆ CUSTOMER_NOTIFICATION_NOT_APPLICABLE

const CUSTOMER_NOTIFICATION_NOT_APPLICABLE = 2

Definition at line 21 of file History.php.

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

vendor/magento/module-sales/Model/Order/Status/History.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ beforeSave()

◆ getComment()

◆ getCreatedAt()

◆ getEntityId()

◆ getEntityName()

◆ getExtensionAttributes()

◆ getIsCustomerNotified()

◆ getIsVisibleOnFront()

◆ getOrder()

◆ getParentId()

◆ getStatus()

◆ getStatusLabel()

◆ getStore()

◆ isCustomerNotificationNotApplicable()

◆ setComment()

◆ setCreatedAt()

◆ setEntityName()

◆ setExtensionAttributes()

◆ setIsCustomerNotified()

◆ setIsVisibleOnFront()

◆ setOrder()

◆ setParentId()

◆ setStatus()

Field Documentation

◆ $_eventObject

◆ $_eventPrefix

◆ $_order

◆ $_storeManager

◆ CUSTOMER_NOTIFICATION_NOT_APPLICABLE