Cryptographer Class Reference

Public Member Functions
	__construct (AnalyticsToken $analyticsToken, EncodedContextFactory $encodedContextFactory)
	encode ($source)

Detailed Description

Class for encrypting data.

Definition at line 13 of file Cryptographer.php.

Constructor & Destructor Documentation

__construct()

__construct	(	AnalyticsToken	$analyticsToken,
		EncodedContextFactory	$encodedContextFactory
	)

Parameters

AnalyticsToken	$analyticsToken
EncodedContextFactory	$encodedContextFactory

Definition at line 38 of file Cryptographer.php.

      {
        $this->analyticsToken = $analyticsToken;
        $this->encodedContextFactory = $encodedContextFactory;
    }

Member Function Documentation

encode()

encode

(

$source

)

Encrypt input data.

Parameters

string

$source

Returns

EncodedContext

Exceptions

LocalizedException

Definition at line 53 of file Cryptographer.php.

    {
        if (!is_string($source)) {
            try {
                $source = (string)$source;
            } catch (\Exception $e) {
                throw new LocalizedException(
                    __(
                        'The data is invalid. '
                        . 'Enter the data as a string or data that can be converted into a string and try again.'
                    )
                );
            }
        } elseif (!$source) {
            throw new LocalizedException(__('The data is invalid. Enter the data as a string and try again.'));
        }
        if (!$this->validateCipherMethod($this->cipherMethod)) {
            throw new LocalizedException(__('The data is invalid. Use a valid cipher method and try again.'));
        }
        $initializationVector = $this->getInitializationVector();

        $encodedContext = $this->encodedContextFactory->create([
            'content' => openssl_encrypt(
                $source,
                $this->cipherMethod,
                $this->getKey(),
                OPENSSL_RAW_DATA,
                $initializationVector
            ),
            'initializationVector' => $initializationVector,
        ]);

        return $encodedContext;
    }

---

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

• vendor/magento/module-analytics/Model/Cryptographer.php