Jalle19 / tvheadend-status-manager

src/cli/Manager/StatisticsManager.php

<?php

namespace Jalle19\StatusManager\Manager;

use Jalle19\StatusManager\Database\InstanceQuery;
use Jalle19\StatusManager\Database\SubscriptionQuery;
use Jalle19\StatusManager\Database\User;
use Jalle19\StatusManager\Database\UserQuery;
use Jalle19\StatusManager\Message\AbstractMessage;
use Jalle19\StatusManager\Message\Handler\HandlerInterface;
use Jalle19\StatusManager\Message\Request\InstancesRequest;
use Jalle19\StatusManager\Message\Request\MostActiveWatchersRequest;
use Jalle19\StatusManager\Message\Request\PopularChannelsRequest;
use Jalle19\StatusManager\Message\Request\UsersRequest;
use Jalle19\StatusManager\Message\Response\InstancesResponse;
use Jalle19\StatusManager\Message\Response\MostActiveWatchersResponse;
use Jalle19\StatusManager\Message\Response\PopularChannelsResponse;
use Jalle19\StatusManager\Message\Response\UsersResponse;
use Jalle19\StatusManager\TimeFrame;
use Jalle19\tvheadend\exception\RequestFailedException;
use Propel\Runtime\Exception\PropelException;
use Ratchet\ConnectionInterface;

/**
 * Class StatisticsManager
 * @package   Jalle19\StatusManager\Manager
 * @copyright Copyright &copy; Sam Stenvall 2016-
 * @license   https://www.gnu.org/licenses/gpl.html The GNU General Public License v2.0
 */
class StatisticsManager extends AbstractManager implements HandlerInterface
{

	/**
	 * @inheritdoc
	 */
	public function handleMessage(AbstractMessage $message, ConnectionInterface $sender)
	{
		// Wrap database exceptions in the more generic RequestFailedException
		try
		{
			switch ($message->getType())
			{
				case AbstractMessage::TYPE_POPULAR_CHANNELS_REQUEST:
					/* @var PopularChannelsRequest $message */
					return new PopularChannelsResponse($message, $this->getPopularChannels(
						$message->getInstanceName(),
						$message->getUserName(),
						$message->getLimit(),
						$message->getTimeFrame()));
				case AbstractMessage::TYPE_MOST_ACTIVE_WATCHERS_REQUEST:
					/* @var MostActiveWatchersRequest $message */
					return new MostActiveWatchersResponse($message, $this->getMostActiveWatchers(
						$message->getInstanceName(),
						$message->getLimit(),
						$message->getTimeFrame()));
				case AbstractMessage::TYPE_INSTANCES_REQUEST:
					/* @var InstancesRequest $message */
					return new InstancesResponse($this->configuration->getInstances());
				case AbstractMessage::TYPE_USERS_REQUEST:
					/* @var UsersRequest $message */
					return new UsersResponse($this->getUsers($message->getInstanceName()));
			}
		}
		catch (PropelException $e)
		{
			throw new RequestFailedException('A database error occured: ' . $e->getMessage());

'A database error occured: ' . $e->getMessage() of type string is incompatible with the type Laminas\Http\Response expected by parameter $response of Jalle19\tvheadend\exception\RequestFailedException::__construct().

		}

		return false;
	}


	/**
	 * @param string      $instanceName
	 * @param string|null $userName
	 * @param int|null    $limit
	 * @param TimeFrame   $timeFrame
	 *
	 * @return array the popular channels
	 */
	private function getPopularChannels($instanceName, $userName, $limit, $timeFrame)
	{
		// Find the instance and the user
		$instance     = InstanceQuery::create()->findOneByName($instanceName);
		$user         = UserQuery::create()->findOneByName($userName);
		$query        = SubscriptionQuery::create()->getPopularChannelsQuery($instance, $user);

It seems like $instance can also be of type null; however, parameter $instance of Jalle19\StatusManager\Database\SubscriptionQuery::getPopularChannelsQuery() does only seem to accept Jalle19\StatusManager\Database\Instance, maybe add an additional type check?

It seems like $user can also be of type null; however, parameter $user of Jalle19\StatusManager\Database\SubscriptionQuery::getPopularChannelsQuery() does only seem to accept Jalle19\StatusManager\Database\User, maybe add an additional type check?

		$ignoredUsers = $this->configuration->getInstanceByName($instanceName)->getIgnoredUsers();

		$query = $query->filterByLimit($limit);
		$query = $query->filterByTimeFrame($timeFrame);
		$query = $query->useUserQuery()->filterIgnoredUsers($ignoredUsers)->endUse();

		return $query->find()->getData();
	}


	/**
	 * @param string    $instanceName
	 * @param int       $limit
	 * @param TimeFrame $timeFrame
	 *
	 * @return array
	 */
	private function getMostActiveWatchers($instanceName, $limit, $timeFrame)
	{
		$instance     = InstanceQuery::create()->findOneByName($instanceName);
		$query        = UserQuery::create()->getMostActiveWatchersQuery($instance);
		$ignoredUsers = $this->configuration->getInstanceByName($instanceName)->getIgnoredUsers();

		$query = $query->filterByLimit($limit);
		$query = $query->useSubscriptionQuery()->filterByTimeFrame($timeFrame)->endUse();
		$query = $query->filterIgnoredUsers($ignoredUsers);

The method filterIgnoredUsers() does not exist on Jalle19\StatusManager\Database\InstanceQuery. Since you implemented __call, consider adding a @method annotation.

The method filterIgnoredUsers() does not exist on Jalle19\StatusManager\Database\ChannelQuery. Since you implemented __call, consider adding a @method annotation.

The method filterIgnoredUsers() does not exist on Jalle19\StatusManager\Database\InputQuery. Since you implemented __call, consider adding a @method annotation.

		return $query->find()->getData();
	}


	/**
	 * Returns all users found so far for the specified instance name
	 *
	 * @param string $instanceName
	 *
	 * @return User[]
	 */
	private function getUsers($instanceName)
	{
		$ignoredUsers = $this->configuration->getInstanceByName($instanceName)->getIgnoredUsers();

		return UserQuery::create()
		                ->filterIgnoredUsers($ignoredUsers)
		                ->findByInstanceName($instanceName)->getArrayCopy();
	}

}