LAC-27: Log admin actions with Login as Customer.

Author: nmalevanec

app/code/Magento/LoginAsCustomerLog/Api/Data/LogInterface.php

@@ -16,15 +16,10 @@ interface LogInterface extends ExtensibleDataInterface
 {
     const LOG_ID = 'log_id';
     const TIME = 'time';
-    const ACTION_GROUP = 'action_group';
-    const ACTION = 'action';
-    const FULL_ACTION_NAME = 'full_action_name';
-    const RESULT = 'result';
-    const DETAILS = 'details';
-    const ERROR = 'error';
-    const IP_ADDRESS = 'ip_address';
-    const USERNAME = 'username';
     const CUSTOMER_ID = 'customer_id';
+    const CUSTOMER_EMAIL = 'customer_email';
+    const USER_ID = 'user_id';
+    const USERNAME = 'user_name';
 
     /**
      * Set login as customer log id.
@@ -44,10 +39,10 @@ public function getLogId(): ?int;
     /**
      * Set login as customer log time.
      *
-     * @param string $name
+     * @param string $time
      * @return void
      */
-    public function setTime(string $name): void;
+    public function setTime(string $time): void;
 
     /**
      * Retrieve login as customer log time.
@@ -57,139 +52,64 @@ public function setTime(string $name): void;
     public function getTime(): ?string;
 
     /**
-     * Set login as customer log action group.
+     * Set login as customer log user id.
      *
-     * @param string $actionGroup
+     * @param int $userId
      * @return void
      */
-    public function setActionGroup(string $actionGroup): void;
+    public function setUserId(int $userId): void;
 
     /**
-     * Retrieve login as customer log action group.
-     *
-     * @return null|string
-     */
-    public function getActionGroup(): ?string;
-
-    /**
-     * Set login as customer log action.
-     *
-     * @param string $action
-     * @return void
-     */
-    public function setAction(string $action): void;
-
-    /**
-     * Retrieve login as customer log action.
-     *
-     * @return null|string
-     */
-    public function getAction(): ?string;
-
-    /**
-     * Set login as customer log full action name.
-     *
-     * @param string $fullActionName
-     * @return void
-     */
-    public function setFullActionName(string $fullActionName): void;
-
-    /**
-     * Retrieve login as customer log full action name.
-     *
-     * @return null|string
-     */
-    public function getFullActionName(): ?string;
-
-    /**
-     * Set login as customer log result.
-     *
-     * @param int $result
-     * @return void
-     */
-    public function setResult(int $result): void;
-
-    /**
-     * Retrieve login as customer log result.
+     * Retrieve login as customer log user id.
      *
      * @return null|int
      */
-    public function getResult(): ?int;
+    public function getUserId(): ?int;
 
     /**
-     * Set login as customer log details.
+     * Set login as customer log user name.
      *
-     * @param string $details
+     * @param string $userName
      * @return void
      */
-    public function setDetails(string $details): void;
+    public function setUserName(string $userName): void;
 
     /**
-     * Retrieve login as customer log details.
+     * Retrieve login as customer log user name.
      *
      * @return null|string
      */
-    public function getDetails(): ?string;
+    public function getUserName(): ?string;
 
     /**
-     * Set login as customer log error.
-     *
-     * @param string $error
-     * @return void
-     */
-    public function setError(string $error): void;
-
-    /**
-     * Retrieve login as customer log error.
-     *
-     * @return string|null
-     */
-    public function getError(): ?string;
-
-    /**
-     * Set login as customer log ip address.
+     * Set login as customer log customer id.
      *
-     * @param int $ipAddress
+     * @param int $customerId
      * @return void
      */
-    public function setIpAddress(int $ipAddress): void;
+    public function setCustomerId(int $customerId): void;
 
     /**
-     * Retrieve login as customer log ip address.
+     * Retrieve login as customer log customer id.
      *
      * @return null|int
      */
-    public function getIpAddress(): ?int;
+    public function getCustomerId(): ?int;
 
     /**
-     * Set login as customer log user name.
+     * Set login as customer log customer email.
      *
-     * @param string $username
+     * @param string $customerEmail
      * @return void
      */
-    public function setUsername(string $username): void;
+    public function setCustomerEmail(string $customerEmail): void;
 
     /**
-     * Retrieve login as customer log user name.
+     * Retrieve login as customer log customer email.
      *
      * @return null|string
      */
-    public function getUsername(): ?string;
-
-    /**
-     * Set login as customer log customer id.
-     *
-     * @param int $customerId
-     * @return void
-     */
-    public function setCustomerId(int $customerId): void;
-
-    /**
-     * Retrieve login as customer log customer id.
-     *
-     * @return null|int
-     */
-    public function getCustomerId(): ?int;
+    public function getCustomerEmail(): ?string;
 
     /**
      * Set log extension attributes.

app/code/Magento/LoginAsCustomerLog/Api/Data/LogSearchResultsInterface.php

@@ -9,17 +9,20 @@
 
 use \Magento\Framework\Api\SearchResultsInterface;
 
+/**
+ * Login as customer log entity search results interface.
+ */
 interface LogSearchResultsInterface extends SearchResultsInterface
 {
     /**
-     * Get sources list
+     * Get log list.
      *
      * @return \Magento\LoginAsCustomerLog\Api\Data\LogInterface[]
      */
     public function getItems();
 
     /**
-     * Set sources list
+     * Set log list.
      *
      * @param \Magento\LoginAsCustomerLog\Api\Data\LogInterface[] $items
      * @return void

app/code/Magento/LoginAsCustomerLog/Api/GetLogsListInterface.php

@@ -11,11 +11,13 @@
 use Magento\LoginAsCustomerLog\Api\Data\LogSearchResultsInterface;
 
 /**
- * @todo: add description.
+ * Get login as customer log list considering search criteria.
  */
 interface GetLogsListInterface
 {
     /**
+     * Retrieve list of log entities.
+     *
      * @param SearchCriteriaInterface $searchCriteria
      * @return LogSearchResultsInterface
      */

app/code/Magento/LoginAsCustomerLog/Api/SaveLogsInterface.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomerLog\Api;
+
+/**
+ * Save login as custom logs entities.
+ */
+interface SaveLogsInterface
+{
+    /**
+     * Save logs.
+     *
+     * @param \Magento\LoginAsCustomerLog\Api\Data\LogInterface[] $logs
+     * @return void
+     */
+    public function execute(array $logs): void;
+}