AdminStatsController::adminStatsApiAction() - Code Metrics - Inspection of "Merge pull request #113 from x-tools/adminstats-re..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cd44b6...7febf5 )

by MusikAnimal

created 2017-10-16 19:58 UTC

AdminStatsController::adminStatsApiAction() B

↳ Parent: AdminStatsController

Complexity

Conditions	2
Paths	2

Size

Total Lines	26
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	26
rs	8.8571
c	0
b	0
f	0
cc	2
eloc	16
nc	2
nop	2

<?php

/**
 * This file contains the code that powers the AdminStats page of XTools.
 *
 * @version 1.5.1
 */

namespace AppBundle\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\JsonResponse;
use Xtools\AdminStats;
use Xtools\AdminStatsRepository;
use Xtools\ProjectRepository;

/**
 * Class AdminStatsController
 *
 * @category AdminStats
 * @package  AppBundle\Controller
 * @author   XTools Team <[email protected]>
 * @license  GPL 3.0
 */
class AdminStatsController extends XtoolsController
{
    /** @var Project The project being queried. */
    protected $project;

    /** @var AdminStats The admin stats instance that does all the work. */
    protected $adminStats;

    /**
     * Get the tool's shortname.
     * @return string
     * @codeCoverageIgnore
     */
    public function getToolShortname()
    {
        return 'adminstats';
    }

    /**
     * Every action in this controller (other than 'index') calls this first.
     * If a response is returned, the calling action is expected to return it.
     * @param string $project
     * @param string $start
     * @param string $end
     * @return AdminStats|RedirectResponse
     */
    public function setUpAdminStats($project, $start = null, $end = null)
    {
        // Load the database information for the tool.
        // $projectData will be a redirect if the project is invalid.
        $projectData = $this->validateProject($project);
        if ($projectData instanceof RedirectResponse) {
            return $projectData;
        }
        $this->project = $projectData;


        list($start, $end) = $this->getUTCFromDateParams($start, $end);

        $this->adminStats = new AdminStats($this->project, $start, $end);
        $adminStatsRepo = new AdminStatsRepository();
        $adminStatsRepo->setContainer($this->container);
        $this->adminStats->setRepository($adminStatsRepo);

        // For testing purposes.
        return $this->adminStats;
    }

    /**
     * Method for rendering the AdminStats Main Form.
     * This method redirects if valid parameters are found, making it a
     * valid form endpoint as well.
     *
     * @param Request $request Generated by Symfony
     *
     * @Route("/adminstats",           name="adminstats")
     * @Route("/adminstats/",          name="AdminStatsSlash")
     * @Route("/adminstats/index.php", name="AdminStatsIndexPhp")
     *
     * @return Route|\Symfony\Component\HttpFoundation\Response
     */
    public function indexAction(Request $request)

    {
        $params = $this->parseQueryParams($request);

        // Redirect if we have a project. $results may also include start and/or end date.
        if (isset($params['project'])) {
            return $this->redirectToRoute('AdminStatsResult', $params);
        }

        // Otherwise render form.
        return $this->render('adminStats/index.html.twig', [
            'xtPage' => 'adminstats',
            'xtPageTitle' => 'tool-adminstats',
            'xtSubtitle' => 'tool-adminstats-desc',
        ]);
    }

    /**
     * Method for rendering the AdminStats Results
     *
     * @param Request $request The HTTP request.
     * @param string $project Project to run the results against
     * @param string $start   Date to start on.  Must parse by strtotime.
     * @param string $end     Date to end on.  Must parse by strtotime.
     *
     * @Route(
     *   "/adminstats/{project}/{start}/{end}", name="AdminStatsResult",
     *   requirements={"start" = "|\d{4}-\d{2}-\d{2}", "end" = "|\d{4}-\d{2}-\d{2}"}
     * )
     *
     * @return Route|\Symfony\Component\HttpFoundation\Response
     * @todo Move SQL to a model.
     * @codeCoverageIgnore
     */
    public function resultAction(Request $request, $project, $start = null, $end = null)

    {
        $ret = $this->setUpAdminStats($project, $start, $end);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        $this->adminStats->prepareStats();

        // Render the result!
        return $this->render('adminStats/result.html.twig', [
            'xtPage' => 'adminstats',
            'xtTitle' => $this->project->getDomain(),
            'project' => $this->project,
            'as' => $this->adminStats,
        ]);
    }

    /************************ API endpoints ************************/

    /**
     * Get users of the project that are capable of making 'admin actions',
     * keyed by user name with a list of the relevant user groups as the values.
     * @Route("/api/project/admins_groups/{project}", name="ProjectApiAdminsGroups")
     * @param string $project Project domain or database name.
     * @return Response
     * @codeCoverageIgnore
     */
    public function adminsGroupsApiAction($project)
    {
        $ret = $this->setUpAdminStats($project);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        return new JsonResponse(
            $this->adminStats->getAdminsAndGroups(false),
            Response::HTTP_OK
        );
    }

    /**
     * Get users of the project that are capable of making 'admin actions',
     * along with various stats about which actions they took. Time period is limited
     * to one month.
     * @Route("/api/project/adminstats/{project}/{days}", name="ProjectApiAdminStats")
     * @param string $project Project domain or database name.
     * @param int $days Number of days from present to grab data for. Maximum 30.
     * @return Response
     * @codeCoverageIgnore
     */
    public function adminStatsApiAction($project, $days = 30)
    {
        // Maximum 30 days.
        $days = min((int) $days, 30);
        $start = date('Y-m-d', strtotime("-$days days"));
        $end = date('Y-m-d');

        $ret = $this->setUpAdminStats($project, $start, $end);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        $this->adminStats->prepareStats(false);

        $response = [
            'project' => $this->project->getDomain(),
            'start' => $this->adminStats->getStart(),
            'end' => $this->adminStats->getEnd(),
            'users' => $this->adminStats->getStats(false),
        ];

        return new JsonResponse(
            $response,
            Response::HTTP_OK
        );
    }
}


1		<?php
2
3		/**
4		* This file contains the code that powers the AdminStats page of XTools.
5		*
6		* @version 1.5.1
7		*/
8
9		namespace AppBundle\Controller;
10
11		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
12		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
13		use Symfony\Component\HttpFoundation\Request;
14		use Symfony\Component\HttpFoundation\Response;
15		use Symfony\Component\HttpFoundation\RedirectResponse;
16		use Symfony\Component\HttpFoundation\JsonResponse;
17		use Xtools\AdminStats;
18		use Xtools\AdminStatsRepository;
19		use Xtools\ProjectRepository;
20
21		/**
22		* Class AdminStatsController
23		*
24		* @category AdminStats
25		* @package AppBundle\Controller
26		* @author XTools Team <[email protected]>
27		* @license GPL 3.0
28		*/
29		class AdminStatsController extends XtoolsController
30		{
31		/** @var Project The project being queried. */
32		protected $project;
33
34		/** @var AdminStats The admin stats instance that does all the work. */
35		protected $adminStats;
36
37		/**
38		* Get the tool's shortname.
39		* @return string
40		* @codeCoverageIgnore
41		*/
42		public function getToolShortname()
43		{
44		return 'adminstats';
45		}
46
47		/**
48		* Every action in this controller (other than 'index') calls this first.
49		* If a response is returned, the calling action is expected to return it.
50		* @param string $project
51		* @param string $start
52		* @param string $end
53		* @return AdminStats\|RedirectResponse
54		*/
55		public function setUpAdminStats($project, $start = null, $end = null)
56		{
57		// Load the database information for the tool.
58		// $projectData will be a redirect if the project is invalid.
59		$projectData = $this->validateProject($project);
60		if ($projectData instanceof RedirectResponse) {
61		return $projectData;
62		}
63		$this->project = $projectData;
		0 ignored issues – show Documentation Bug introduced 2017-10-16 18:43 UTC by Report Bug Copy Issue Report It seems like `$projectData` of type `object<Xtools\Project>` is incompatible with the declared type `object<AppBundle\Controller\Project>` of property `$project`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
64
65		list($start, $end) = $this->getUTCFromDateParams($start, $end);
66
67		$this->adminStats = new AdminStats($this->project, $start, $end);
68		$adminStatsRepo = new AdminStatsRepository();
69		$adminStatsRepo->setContainer($this->container);
70		$this->adminStats->setRepository($adminStatsRepo);
71
72		// For testing purposes.
73		return $this->adminStats;
74		}
75
76		/**
77		* Method for rendering the AdminStats Main Form.
78		* This method redirects if valid parameters are found, making it a
79		* valid form endpoint as well.
80		*
81		* @param Request $request Generated by Symfony
82		*
83		* @Route("/adminstats", name="adminstats")
84		* @Route("/adminstats/", name="AdminStatsSlash")
85		* @Route("/adminstats/index.php", name="AdminStatsIndexPhp")
86		*
87		* @return Route\|\Symfony\Component\HttpFoundation\Response
88		*/
89	View Code Duplication	public function indexAction(Request $request)
		0 ignored issues – show Duplication introduced 2017-10-13 05:14 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
90		{
91		$params = $this->parseQueryParams($request);
92
93		// Redirect if we have a project. $results may also include start and/or end date.
94		if (isset($params['project'])) {
95		return $this->redirectToRoute('AdminStatsResult', $params);
96		}
97
98		// Otherwise render form.
99		return $this->render('adminStats/index.html.twig', [
100		'xtPage' => 'adminstats',
101		'xtPageTitle' => 'tool-adminstats',
102		'xtSubtitle' => 'tool-adminstats-desc',
103		]);
104		}
105
106		/**
107		* Method for rendering the AdminStats Results
108		*
109		* @param Request $request The HTTP request.
110		* @param string $project Project to run the results against
111		* @param string $start Date to start on. Must parse by strtotime.
112		* @param string $end Date to end on. Must parse by strtotime.
113		*
114		* @Route(
115		* "/adminstats/{project}/{start}/{end}", name="AdminStatsResult",
116		* requirements={"start" = "\|\d{4}-\d{2}-\d{2}", "end" = "\|\d{4}-\d{2}-\d{2}"}
117		* )
118		*
119		* @return Route\|\Symfony\Component\HttpFoundation\Response
120		* @todo Move SQL to a model.
121		* @codeCoverageIgnore
122		*/
123		public function resultAction(Request $request, $project, $start = null, $end = null)
		0 ignored issues – show Unused Code introduced 2017-10-12 20:54 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
124		{
125		$ret = $this->setUpAdminStats($project, $start, $end);
126		if ($ret instanceof RedirectResponse) {
127		return $ret;
128		}
129
130		$this->adminStats->prepareStats();
131
132		// Render the result!
133		return $this->render('adminStats/result.html.twig', [
134		'xtPage' => 'adminstats',
135		'xtTitle' => $this->project->getDomain(),
136		'project' => $this->project,
137		'as' => $this->adminStats,
138		]);
139		}
140
141		/********************** API endpoints **********************/
142
143		/**
144		* Get users of the project that are capable of making 'admin actions',
145		* keyed by user name with a list of the relevant user groups as the values.
146		* @Route("/api/project/admins_groups/{project}", name="ProjectApiAdminsGroups")
147		* @param string $project Project domain or database name.
148		* @return Response
149		* @codeCoverageIgnore
150		*/
151		public function adminsGroupsApiAction($project)
152		{
153		$ret = $this->setUpAdminStats($project);
154		if ($ret instanceof RedirectResponse) {
155		return $ret;
156		}
157
158		return new JsonResponse(
159		$this->adminStats->getAdminsAndGroups(false),
160		Response::HTTP_OK
161		);
162		}
163
164		/**
165		* Get users of the project that are capable of making 'admin actions',
166		* along with various stats about which actions they took. Time period is limited
167		* to one month.
168		* @Route("/api/project/adminstats/{project}/{days}", name="ProjectApiAdminStats")
169		* @param string $project Project domain or database name.
170		* @param int $days Number of days from present to grab data for. Maximum 30.
171		* @return Response
172		* @codeCoverageIgnore
173		*/
174		public function adminStatsApiAction($project, $days = 30)
175		{
176		// Maximum 30 days.
177		$days = min((int) $days, 30);
178		$start = date('Y-m-d', strtotime("-$days days"));
179		$end = date('Y-m-d');
180
181		$ret = $this->setUpAdminStats($project, $start, $end);
182		if ($ret instanceof RedirectResponse) {
183		return $ret;
184		}
185
186		$this->adminStats->prepareStats(false);
187
188		$response = [
189		'project' => $this->project->getDomain(),
190		'start' => $this->adminStats->getStart(),
191		'end' => $this->adminStats->getEnd(),
192		'users' => $this->adminStats->getStats(false),
193		];
194
195		return new JsonResponse(
196		$response,
197		Response::HTTP_OK
198		);
199		}
200		}
201

x-tools / xtools

Push — master ( cd44b6...7febf5 )

AdminStatsController::adminStatsApiAction() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like