Status Class Reference

Inheritance diagram for Status:

Public Member Functions
	__construct (\Magento\Sales\Model\Order\Config $orderConfig)
	toOptionArray ()

Data Fields
const	UNDEFINED_OPTION_LABEL = '-- Please Select --'

Protected Attributes
	$_stateStatuses
	$_orderConfig

Detailed Description

Class Status @api

Since

100.0.2

Definition at line 17 of file Status.php.

Constructor & Destructor Documentation

__construct()

__construct

(

\Magento\Sales\Model\Order\Config

$orderConfig

)

Parameters

\Magento\Sales\Model\Order\Config

$orderConfig

Definition at line 41 of file Status.php.

    {
        $this->_orderConfig = $orderConfig;
    }

Member Function Documentation

toOptionArray()

toOptionArray

(

)

Returns

array

Implements OptionSourceInterface.

Definition at line 49 of file Status.php.

    {
        $statuses = $this->_stateStatuses
            ? $this->_orderConfig->getStateStatuses($this->_stateStatuses)
            : $this->_orderConfig->getStatuses();

        $options = [['value' => '', 'label' => __('-- Please Select --')]];
        foreach ($statuses as $code => $label) {
            $options[] = ['value' => $code, 'label' => $label];
        }
        return $options;
    }

Field Documentation

$_orderConfig

$_orderConfig

protected

Definition at line 36 of file Status.php.

$_stateStatuses

$_stateStatuses

protected

Initial value:

= [
        \Magento\Sales\Model\Order::STATE_NEW,
        \Magento\Sales\Model\Order::STATE_PROCESSING,
        \Magento\Sales\Model\Order::STATE_COMPLETE,
        \Magento\Sales\Model\Order::STATE_CLOSED,
        \Magento\Sales\Model\Order::STATE_CANCELED,
        \Magento\Sales\Model\Order::STATE_HOLDED,
    ]

Definition at line 24 of file Status.php.

UNDEFINED_OPTION_LABEL

const UNDEFINED_OPTION_LABEL = '-- Please Select --'

Definition at line 19 of file Status.php.

---

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

• vendor/magento/module-sales/Model/Config/Source/Order/Status.php