You are here

class PhotosStatisticsUpdateController in Album Photos 6.0.x

Same name and namespace in other branches
  1. 8.5 src/Controller/PhotosStatisticsUpdateController.php \Drupal\photos\Controller\PhotosStatisticsUpdateController

Update image view count(s).

@package Drupal\statistics\Controller

Hierarchy

Expanded class hierarchy of PhotosStatisticsUpdateController

File

src/Controller/PhotosStatisticsUpdateController.php, line 15

Namespace

Drupal\photos\Controller
View source
class PhotosStatisticsUpdateController extends ControllerBase {

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   */
  public function __construct(Connection $connection) {
    $this->connection = $connection;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('database'));
  }

  /**
   * Ajax callback to record photos_image visit.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   A JSON object containing the image visit count.
   */
  public function updateCount() {
    $photosImageCountDisabled = $this
      ->config('photos.settings')
      ->get('photos_image_count');
    $json = [
      'count' => 1,
    ];
    if (!$photosImageCountDisabled) {
      $id = filter_input(INPUT_POST, 'id', FILTER_VALIDATE_INT);
      if ($id) {

        // $this->request_stack->push(Request::createFromGlobals());
        $json['count'] = $this
          ->recordView($id);
      }
    }
    return new JsonResponse($json);
  }

  /**
   * Record the image view to the database.
   *
   * @param int $id
   *   The photos_image entity id.
   *
   * @return int
   *   The current visit count for this image.
   */
  public function recordView($id) {

    // @todo use core stats instead (when ready).
    $count = 1;
    try {
      $this->connection
        ->merge('photos_count')
        ->keys([
        'cid' => $id,
        'type' => 'image_views',
      ])
        ->fields([
        'value' => $count,
        'changed' => \Drupal::time()
          ->getRequestTime(),
      ])
        ->expression('value', 'value + :count', [
        ':count' => $count,
      ])
        ->execute();
      $count = $this->connection
        ->select('photos_count', 'c')
        ->fields('c', [
        'value',
      ])
        ->condition('c.cid', $id)
        ->condition('c.type', 'image_views')
        ->execute()
        ->fetchField();
      return $count;
    } catch (\Exception $e) {
      \Drupal::logger('photos')
        ->notice('Image view statistics failed.');
      watchdog_exception('photos', $e);
      return $count;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PhotosStatisticsUpdateController::$connection protected property The database connection.
PhotosStatisticsUpdateController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
PhotosStatisticsUpdateController::recordView public function Record the image view to the database.
PhotosStatisticsUpdateController::updateCount public function Ajax callback to record photos_image visit.
PhotosStatisticsUpdateController::__construct public function Constructor.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.