629849680

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/tattersoftware/codeigniter4-visits/commit/<a class=hub.com/tattersoftware/codeigniter4-visits/commit/<a class="double-link" href="https://git"><a class=hub.com/tattersoftware/codeigniter4-visits/commit/<a class="double-link" href="https://git"><a class=hub.com/tattersoftware/codeigniter4-visits/commit/<a class="double-link" href="https://git"><a class=hub.com/tattersoftware/codeigniter4-visits/commit/<a class="double-link" href="https://git"><a class=hub.com/tattersoftware/codeigniter4-visits/commit/ec4aa1873f076507e7aa470de28a6a4318a0f7d5">ec4aa1873">&lt;a href=&quot;https://github.com/tattersoftware/codeigniter4-visits/commit/</a><a class="double-link" href="https://github.com/tattersoftware/codeigniter4-visits/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/tattersoftware/codeigniter4-visits/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/tattersoftware/codeigniter4-visits/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/tattersoftware/codeigniter4-visits/commit/ec4aa1873f076507e7aa470de28a6a4318a0f7d5">ec4aa1873</a><a href="https://github.com/tattersoftware/codeigniter4-visits/commit/ec4aa1873f076507e7aa470de28a6a4318a0f7d5">&lt;a href=&quot;https://github.com/tattersoftware/codeigniter4-visits/commit/ec4aa1873f076507e7aa470de28a6a4318a0f7d5&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/tattersoftware/codeigniter4-visits/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/tattersoftware/codeigniter4-visits/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://git&amp;quot;&amp;gt;&amp;amp;lt;a class=&amp;lt;/a&amp;gt;hub.com/tattersoftware/codeigniter4-visits/commit/ec4aa1873f076507e7aa470de28a6a4318a0f7d5&amp;quot;&amp;gt;ec4aa1873&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/tattersoftware/codeigniter4-visits/commit/ec4aa1873f076507e7aa470de28a6a4318a0f7d5&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/tattersoftware/codeigniter4-visits/commit/ec4aa1873f076507e7aa470de28a6a43&amp;lt;/a&amp;gt;18a0f7d5&amp;quot;&amp;gt;&amp;amp</a>;quot;&amp;gt;Merge &amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/tattersoftware/codeigniter4-visits/commit/&amp;... (continued)

Pull Request Pull Request #3: Development Tools

Run Details

3 of 9 new or added lines in 3 files covered. (33.33%)

6 of 74 relevant lines covered (8.11%)

0.08 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

6.67

/src/Visits.php

<?php namespace Tatter\Visits;

/***
* Name: Visits
* Author: Matthew Gatner
* Contact: mgatner@tattersoftware.com
* Created: 2019-02-12
*
* Description:  Lightweight traffic tracking for CodeIgniter 4
*
* Requirements:
*     >= PHP 7.1
*     >= CodeIgniter 4.0
*    Preconfigured, autoloaded Database
*    CodeIgniter's URL helper (loaded automatically)
*    Visits table (run migrations)
*
* Configuration:
*     Use app/Config/Visits.php to override default behavior
*     Run migrations to update database tables:
*         > php spark migrate:latest -n "Tatter\Visits"
*
* @package CodeIgniter4-Visits
* @author  Matthew Gatner
* @link    https://github.com/tattersoftware/codeigniter4-visits
***/

use CodeIgniter\Config\BaseConfig;
use CodeIgniter\Config\Services;
use CodeIgniter\Database\ConnectionInterface;
use Tatter\Visits\Config\Visits as VisitsConfig;
use Tatter\Visits\Entities\Visit;
use Tatter\Visits\Models\VisitModel;
use Tatter\Visits\Exceptions\VisitsException;

/***
 * CLASS
 ***/
class Visits
{
        /**
         * Our configuration instance.
         *
         * @var VisitsConfig
         */
        protected $config;

        /**
         * The main database connection, needed to store records.
         *
         * @var ConnectionInterface
         */
        protected $db;

        /**
         * The active user session, for session data and tracking.
         *
         * @var \CodeIgniter\Session\Session
         */
        protected $session;

        // initiate library, check for existing session
        public function __construct(VisitsConfig $config, $db = null)
        {
                // ignore CLI requests
                if (is_cli())
                {
                        return;
                }

                // save configuration
                $this->config = $config;

                // initiate the Session library
                $this->session = Services::session();

                // If no db connection passed in, use the default database group.
                $this->db = db_connect($db);

                // validations
                $visits = new VisitModel();
                if (! $this->db->tableExists($visits->table))
                {
                        throw VisitsException::forMissingDatabaseTable($visits->table);
                }

                if (empty($this->config->trackingMethod))
                {
                        throw VisitsException::forNoTrackingMethod();
                }

                if (! is_numeric($this->config->resetMinutes))
                {
                        throw VisitsException::forInvalidResetMinutes();
                }
        }

        // add a new visit, or increase the view count on an existing one
        public function record()
        {
                // Ignore CLI requests
                if (is_cli())
                {
                        return;
                }

                // Check for ignored AJAX requests
                if (Services::request()->isAJAX() && $this->config->ignoreAjax)
                {
                        return;
                }

                $visits = new VisitModel();
                $visit  = new Visit();

                // start the object with parsed URL components (https://secure.php.net/manual/en/function.parse-url.php)
                $visit->fill(parse_url( current_url() ));

                // add session/server specifics
                $visit->session_id = $this->session->session_id;
                $visit->user_id    = $this->session->{$this->config->userSource} ?? null;
                $visit->user_agent = $_SERVER['HTTP_USER_AGENT'] ?? '';
                $visit->ip_address = $_SERVER['REMOTE_ADDR'] ?? null;

                // check for an existing similar record
                if ($similar = $visit->getSimilar($this->config->trackingMethod, $this->config->resetMinutes)):
                        // increment number of views and update
                        $similar->views++;
                        $visits->save($similar);
                        return $similar;
                endif;

                // create a new visit record
                $visits->save($visit);
                return $visit;
        }
}

1	<?php namespace Tatter\Visits;
2
3	/***
4	* Name: Visits
5	* Author: Matthew Gatner
6	* Contact: mgatner@tattersoftware.com
7	* Created: 2019-02-12
8	*
9	* Description: Lightweight traffic tracking for CodeIgniter 4
10	*
11	* Requirements:
12	* >= PHP 7.1
13	* >= CodeIgniter 4.0
14	* Preconfigured, autoloaded Database
15	* CodeIgniter's URL helper (loaded automatically)
16	* Visits table (run migrations)
17	*
18	* Configuration:
19	* Use app/Config/Visits.php to override default behavior
20	* Run migrations to update database tables:
21	* > php spark migrate:latest -n "Tatter\Visits"
22	*
23	* @package CodeIgniter4-Visits
24	* @author Matthew Gatner
25	* @link https://github.com/tattersoftware/codeigniter4-visits
26	***/
27
28	use CodeIgniter\Config\BaseConfig;
29	use CodeIgniter\Config\Services;
30	use CodeIgniter\Database\ConnectionInterface;
31	use Tatter\Visits\Config\Visits as VisitsConfig;
32	use Tatter\Visits\Entities\Visit;
33	use Tatter\Visits\Models\VisitModel;
34	use Tatter\Visits\Exceptions\VisitsException;
35
36	/***
37	* CLASS
38	***/
39	class Visits
40	{
41	/**
42	* Our configuration instance.
43	*
44	* @var VisitsConfig
45	*/
46	protected $config;
47
48	/**
49	* The main database connection, needed to store records.
50	*
51	* @var ConnectionInterface
52	*/
53	protected $db;
54
55	/**
56	* The active user session, for session data and tracking.
57	*
58	* @var \CodeIgniter\Session\Session
59	*/
60	protected $session;
61
62	// initiate library, check for existing session
63	public function __construct(VisitsConfig $config, $db = null)
64	{
65	// ignore CLI requests
66	if (is_cli())	1✔
67	{
68	return;	1✔
69	}
70
71	// save configuration
72	$this->config = $config;	×
73
74	// initiate the Session library
75	$this->session = Services::session();	×
76
77	// If no db connection passed in, use the default database group.
78	$this->db = db_connect($db);	×
79
80	// validations
81	$visits = new VisitModel();	×
82	if (! $this->db->tableExists($visits->table))	×
83	{
84	throw VisitsException::forMissingDatabaseTable($visits->table);	×
85	}
86
87	if (empty($this->config->trackingMethod))	×
88	{
89	throw VisitsException::forNoTrackingMethod();	×
90	}
91
92	if (! is_numeric($this->config->resetMinutes))	×
93	{
94	throw VisitsException::forInvalidResetMinutes();	×
95	}
96	}	×
97
98	// add a new visit, or increase the view count on an existing one
99	public function record()
100	{
101	// Ignore CLI requests
102	if (is_cli())	×
103	{
104	return;	×
105	}
106
107	// Check for ignored AJAX requests
108	if (Services::request()->isAJAX() && $this->config->ignoreAjax)	×
109	{
110	return;	×
111	}
112
113	$visits = new VisitModel();	×
NEW 114	$visit = new Visit();	×
115
116	// start the object with parsed URL components (https://secure.php.net/manual/en/function.parse-url.php)
117	$visit->fill(parse_url( current_url() ));	×
118
119	// add session/server specifics
120	$visit->session_id = $this->session->session_id;	×
NEW 121	$visit->user_id = $this->session->{$this->config->userSource} ?? null;	×
122	$visit->user_agent = $_SERVER['HTTP_USER_AGENT'] ?? '';	×
123	$visit->ip_address = $_SERVER['REMOTE_ADDR'] ?? null;	×
124
125	// check for an existing similar record
126	if ($similar = $visit->getSimilar($this->config->trackingMethod, $this->config->resetMinutes)):	×
127	// increment number of views and update
128	$similar->views++;	×
129	$visits->save($similar);	×
130	return $similar;	×
131	endif;
132
133	// create a new visit record
134	$visits->save($visit);	×
135	return $visit;	×
136	}
137	}

tattersoftware / codeigniter4-visits / 629849680

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous