Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
FlagManager Class Reference

Public Member Functions

 __construct (FlagFactory $flagFactory, FlagResource $flagResource)
 
 getFlagData ($code)
 
 saveFlag ($code, $value)
 
 deleteFlag ($code)
 

Detailed Description

Service that allows to handle a flag object as a scalar value.

Definition at line 13 of file FlagManager.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( FlagFactory  $flagFactory,
FlagResource  $flagResource 
)
Parameters
FlagFactory$flagFactoryThe factory of flags
FlagResource$flagResourceThe flag resource

Definition at line 35 of file FlagManager.php.

38  {
39  $this->flagFactory = $flagFactory;
40  $this->flagResource = $flagResource;
41  }

Member Function Documentation

◆ deleteFlag()

deleteFlag (   $code)

Deletes the flag by code.

Parameters
string$codeThe code of flag
Returns
bool

Definition at line 76 of file FlagManager.php.

77  {
78  $flag = $this->getFlagObject($code);
79 
80  if ($flag->getId()) {
81  $this->flagResource->delete($flag);
82  }
83 
84  return true;
85  }
$code
Definition: info.phtml:12

◆ getFlagData()

getFlagData (   $code)

Retrieves raw data from the flag.

Parameters
string$codeThe code of flag
Returns
string|int|float|bool|array|null

Definition at line 49 of file FlagManager.php.

50  {
51  return $this->getFlagObject($code)->getFlagData();
52  }
$code
Definition: info.phtml:12

◆ saveFlag()

saveFlag (   $code,
  $value 
)

Saves the flag value by code.

Parameters
string$codeThe code of flag
string | int | float | bool | array | null$valueThe value of flag
Returns
bool

Definition at line 61 of file FlagManager.php.

62  {
63  $flag = $this->getFlagObject($code);
64  $flag->setFlagData($value);
65  $this->flagResource->save($flag);
66 
67  return true;
68  }
$value
Definition: gender.phtml:16
$code
Definition: info.phtml:12

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