SectionPool Class Reference

Inheritance diagram for SectionPool:

Public Member Functions
	__construct (ObjectManagerInterface $objectManager, \Magento\Customer\CustomerData\Section\Identifier $identifier, array $sectionSourceMap=[])
	getSectionsData (array $sectionNames=null, $updateIds=false)

Protected Member Functions
	getSectionDataByNames ($sectionNames)
	getAllSectionData ()
	get ($name)

Protected Attributes
	$objectManager
	$sectionSourceMap
	$identifier

Detailed Description

Section pool

@api

Since

100.0.2

Definition at line 17 of file SectionPool.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ObjectManagerInterface	$objectManager,
		\Magento\Customer\CustomerData\Section\Identifier	$identifier,
		array	$sectionSourceMap = []
	)

Construct

Parameters

ObjectManagerInterface	$objectManager
\Magento\Customer\CustomerData\Section\Identifier	$identifier
array	$sectionSourceMap

Definition at line 45 of file SectionPool.php.

      {
        $this->objectManager = $objectManager;
        $this->identifier = $identifier;
        $this->sectionSourceMap = $sectionSourceMap;
    }

Member Function Documentation

get()

get (   $name )

protected

Get section source by name

Parameters

string

$name

Returns

SectionSourceInterface

Exceptions

LocalizedException

Definition at line 105 of file SectionPool.php.

    {
        $sectionSource = $this->objectManager->get($name);

        if (!$sectionSource instanceof SectionSourceInterface) {
            throw new LocalizedException(
                __('%1 doesn\'t extend \Magento\Customer\CustomerData\SectionSourceInterface', $name)
            );
        }
        return $sectionSource;
    }

getAllSectionData()

getAllSectionData ( )

protected

Get all section sources

Returns

array

Definition at line 89 of file SectionPool.php.

    {
        $data = [];
        foreach ($this->sectionSourceMap as $sectionName => $sectionClass) {
            $data[$sectionName] = $this->get($sectionClass)->getSectionData();
        }
        return $data;
    }

getSectionDataByNames()

getSectionDataByNames (   $sectionNames )

protected

Get section sources by section names

Parameters

array

$sectionNames

Returns

array

Exceptions

Definition at line 72 of file SectionPool.php.

    {
        $data = [];
        foreach ($sectionNames as $sectionName) {
            if (!isset($this->sectionSourceMap[$sectionName])) {
                throw new LocalizedException(__('The "%1" section source isn\'t supported.', $sectionName));
            }
            $data[$sectionName] = $this->get($this->sectionSourceMap[$sectionName])->getSectionData();
        }
        return $data;
    }

getSectionsData()

getSectionsData	(	array	$sectionNames = null,
			$updateIds = false
	)

{Get section data by section names. If $sectionNames is null then return all sections data

Parameters

array	$sectionNames
bool	$updateIds

Returns

array

}

Implements SectionPoolInterface.

Definition at line 58 of file SectionPool.php.

    {
        $sectionsData = $sectionNames ? $this->getSectionDataByNames($sectionNames) : $this->getAllSectionData();
        $sectionsData = $this->identifier->markSections($sectionsData, $sectionNames, $updateIds);
        return $sectionsData;
    }

Field Documentation

$identifier

$identifier

protected

Definition at line 36 of file SectionPool.php.

$objectManager

$objectManager

protected

Definition at line 24 of file SectionPool.php.

$sectionSourceMap

$sectionSourceMap

protected

Definition at line 31 of file SectionPool.php.

---

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

• vendor/magento/module-customer/CustomerData/SectionPool.php