Crss::getRSS() - Code Metrics - Inspection of "afdf" - heennkkee/rss - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1b7f83...68ea84 )

by Henrik

created 2016-03-13 19:56 UTC

Crss::getRSS() A

↳ Parent: Crss

Complexity

Conditions	3
Paths	4

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3.072

Importance

Changes	2
Bugs	0	Features	2

Metric	Value
c	2
b	0
f	2
dl	0
loc	14
ccs	8
cts	10
cp	0.8
rs	9.4285
cc	3
eloc	7
nc	4
nop	0
crap	3.072

<?php

namespace henaro\rss;

class Crss {

    private $table = 'RSSFeed';
    private $rssFile;
    private $valid = false;
    private $dbOptions = [];
    private $dbStructure;
    private $db;
    private $newsCount;
    private $feedDescription;
    private $sendHeader;
    /**
     * Initiates the class, takes parameters as input but should work with standard settings.
     * Connects to the DB and makes sure the table exists.
     * @param $params is the input to adjust standard settings. I recommend to change only the 'feedDescription' part.
     */
    public function __construct($params = [])
    {
        date_default_timezone_set('Europe/Stockholm');
        $options = [
            'rssFile' => REALPATH(__DIR__) . '/rsscache/rss.xml',
            'table' => $this->table,
            'newsCount' => 5,
            'sendHeader' => true,
            'db' => [
                'dsn' => 'sqlite:' . REALPATH(__DIR__) . '/src.sqlite',
                'username' => null,
                'password' => null,
                'driver_options' => null,
                'debug' => false
            ],
            'feedDescription' => [
                'title' => 'CRSS easy feed',
                'link' => 'http://www.github.com',
                'description' => 'Description of the amazing feed.'
            ]
        ];

        foreach ($params as $key => $value) {
            if (is_array($value)) {
                foreach ($value as $subKey => $subValue) {
                    $options[$key][$subKey] = $subValue;
                }
            } else {
                $options[$key] = $value;
            }
        }

        $this->rssFile = $options['rssFile'];
        $this->table = $options['table'];
        $this->dbOptions = $options['db'];
        $this->newsCount = $options['newsCount'];
        $this->feedDescription = $options['feedDescription'];
        $this->sendHeader = $options['sendHeader'];

        $this->dbStructure = 'CREATE TABLE IF NOT EXISTS ' . $this->table . ' (
            ID INTEGER PRIMARY KEY NOT NULL,
            TITLE CHAR(50) NOT NULL,
            LINK CHAR(50) NOT NULL,
            DESCRIPTION CHAR(255) NOT NULL,
            CREATED DATETIME
        )';

        $this->connect();
        $this->createDB();
    }

    /**
     * Function to clear the whole database from rss input
     *
     * @return void
     */
    public function clearRSS()
    {
        $stmt = $this->db->prepare("DELETE FROM " . $this->table);
        $stmt->execute();
    }

    /**
     * Internal function for connecting to the database
     *
     * @return void
     */
    private function connect()
    {
        try {
            $this->db = new \PDO(
                $this->dbOptions['dsn'],
                $this->dbOptions['username'],
                $this->dbOptions['password'],
                $this->dbOptions['driver_options']
            );

        } catch (\Exception $e) {
            //Change to true to debug database connection
            if ($this->dbOptions['debug']) {
                // For debug purpose, shows all connection details
                throw $e;
            } else {
                // Hide connection details.
                throw new \PDOException("Could not connect to database, hiding connection details.");
            }
        }
        $this->db->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_OBJ);
    }

    public function createDB() {
        $stmt = $this->db->prepare($this->dbStructure);
        $stmt->execute();
    }

    /**
     * Compares RSS file created timestamp and database timestamp to judge if new RSS file is needed
     *
     * Sets internal variable $this->valid to true/false depending if new file needs to be generate
     * @return void
     */
    private function checkValidity()
    {

        if (!is_writable($this->rssFile)) {
            $this->valid = false;
            return;
        }

        $stmt = $this->db->prepare('SELECT CREATED FROM ' . $this->table . ' ORDER BY CREATED DESC LIMIT 1');
        $stmt->execute();
        $res = $stmt->fetchAll();

        if (count($res) == 0) {
            $this->valid = false;
            return;
        }

        $latestInput = strtotime($res[0]->CREATED);

        $rssCreated = filemtime($this->rssFile);

        if ($latestInput > $rssCreated) {
            $this->valid = false;
        } else {
            $this->valid = true;
        }
    }

    /**
     * Creates a new RSS File with information from the database. Max amount of news is configured in the initiation.
     *
     * @return void
     */
    private function createRSS()
    {
        $file = fopen($this->rssFile, "w+");

        $stmt = $this->db->prepare('SELECT * FROM ' . $this->table . ' ORDER BY CREATED DESC LIMIT ?');
        $stmt->execute([$this->newsCount]);
        $res = $stmt->fetchAll();

        $xmlVersion = '<?xml version="1.0" encoding="UTF-8" ?>';

        $startString = <<<EOD
{$xmlVersion}
<rss version="2.0">
<channel>
    <title>{$this->feedDescription['title']}</title>
    <link>{$this->feedDescription['link']}</link>
    <description>{$this->feedDescription['description']}</description>
EOD;
        fwrite($file, $startString);

        foreach ($res as $post) {
            $date = date("D, d M y H:i:s O", strtotime($post->CREATED));
            $string = <<<EOD

    <item>
        <title>{$post->TITLE}</title>
        <link>{$post->LINK}</link>
        <description>{$post->DESCRIPTION}</description>
        <pubDate>{$date}</pubDate>
    </item>
EOD;
            fwrite($file, $string);
        }

        fwrite($file, '
</channel>
</rss>');
    }

    /**
     * Function that should be called to receive the RSS feed.
     * Checks if the latest RSS File is up to date, if not, generates a new one.
     * @return void
     */
    public function getRSS()
    {
        $this->checkValidity();

        if (!$this->valid) {
            $this->createRSS();
        }

        if ($this->sendHeader) {
            header('Content-type: application/rss+xml; charset=UTF-8');
        }
        
        readfile($this->rssFile);
    }

    /**
     * Inserts information to RSS database
     * @param $input should be an associative array with three pars TITLE, LINK, DESCRIPTION
     *
     * @return void
     */
    public function insertRSS($input = [])
    {
        $stmt = $this->db->prepare("INSERT INTO  " . $this->table . " (TITLE, LINK, DESCRIPTION, CREATED) VALUES (?, ?, ?, datetime('now', 'localtime'))");
        $stmt->execute([$input['TITLE'], $input['LINK'], $input['DESCRIPTION']]);
    }
}


1		<?php
2
3		namespace henaro\rss;
4
5		class Crss {
6
7		private $table = 'RSSFeed';
8		private $rssFile;
9		private $valid = false;
10		private $dbOptions = [];
11		private $dbStructure;
12		private $db;
13		private $newsCount;
14		private $feedDescription;
15		private $sendHeader;
16		/**
17		* Initiates the class, takes parameters as input but should work with standard settings.
18		* Connects to the DB and makes sure the table exists.
19		* @param $params is the input to adjust standard settings. I recommend to change only the 'feedDescription' part.
20		*/
21	3	public function __construct($params = [])
22		{
23	3	date_default_timezone_set('Europe/Stockholm');
24		$options = [
25	3	'rssFile' => REALPATH(__DIR__) . '/rsscache/rss.xml',
26	3	'table' => $this->table,
27	3	'newsCount' => 5,
28	3	'sendHeader' => true,
29		'db' => [
30	3	'dsn' => 'sqlite:' . REALPATH(__DIR__) . '/src.sqlite',
31	3	'username' => null,
32	3	'password' => null,
33	3	'driver_options' => null,
34		'debug' => false
35	3	],
36		'feedDescription' => [
37	3	'title' => 'CRSS easy feed',
38	3	'link' => 'http://www.github.com',
39		'description' => 'Description of the amazing feed.'
40	3	]
41	3	];
42
43	3	foreach ($params as $key => $value) {
44	3	if (is_array($value)) {
45	1	foreach ($value as $subKey => $subValue) {
46	1	$options[$key][$subKey] = $subValue;
47	1	}
48	1	} else {
49	2	$options[$key] = $value;
50		}
51	3	}
52
53	3	$this->rssFile = $options['rssFile'];
54	3	$this->table = $options['table'];
55	3	$this->dbOptions = $options['db'];
56	3	$this->newsCount = $options['newsCount'];
57	3	$this->feedDescription = $options['feedDescription'];
58	3	$this->sendHeader = $options['sendHeader'];
59
60	3	$this->dbStructure = 'CREATE TABLE IF NOT EXISTS ' . $this->table . ' (
61		ID INTEGER PRIMARY KEY NOT NULL,
62		TITLE CHAR(50) NOT NULL,
63		LINK CHAR(50) NOT NULL,
64		DESCRIPTION CHAR(255) NOT NULL,
65		CREATED DATETIME
66	3	)';
67
68	3	$this->connect();
69	2	$this->createDB();
70	2	}
71
72		/**
73		* Function to clear the whole database from rss input
74		*
75		* @return void
76		*/
77	1	public function clearRSS()
78		{
79	1	$stmt = $this->db->prepare("DELETE FROM " . $this->table);
80	1	$stmt->execute();
81	1	}
82
83		/**
84		* Internal function for connecting to the database
85		*
86		* @return void
87		*/
88	3	private function connect()
89		{
90		try {
91	3	$this->db = new \PDO(
92	3	$this->dbOptions['dsn'],
93	3	$this->dbOptions['username'],
94	3	$this->dbOptions['password'],
95	3	$this->dbOptions['driver_options']
96	3	);
97
98	3	} catch (\Exception $e) {
99		//Change to true to debug database connection
100	1	if ($this->dbOptions['debug']) {
101		// For debug purpose, shows all connection details
102	1	throw $e;
103		} else {
104		// Hide connection details.
105		throw new \PDOException("Could not connect to database, hiding connection details.");
106		}
107		}
108	2	$this->db->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_OBJ);
109	2	}
110
111	2	public function createDB() {
112	2	$stmt = $this->db->prepare($this->dbStructure);
113	2	$stmt->execute();
114	2	}
115
116		/**
117		* Compares RSS file created timestamp and database timestamp to judge if new RSS file is needed
118		*
119		* Sets internal variable $this->valid to true/false depending if new file needs to be generate
120		* @return void
121		*/
122	2	private function checkValidity()
123		{
124
125	2	if (!is_writable($this->rssFile)) {
126	1	$this->valid = false;
127	1	return;
128		}
129
130	1	$stmt = $this->db->prepare('SELECT CREATED FROM ' . $this->table . ' ORDER BY CREATED DESC LIMIT 1');
131	1	$stmt->execute();
132	1	$res = $stmt->fetchAll();
133
134	1	if (count($res) == 0) {
135		$this->valid = false;
136		return;
137		}
138
139	1	$latestInput = strtotime($res[0]->CREATED);
140
141	1	$rssCreated = filemtime($this->rssFile);
142
143	1	if ($latestInput > $rssCreated) {
144		$this->valid = false;
145		} else {
146	1	$this->valid = true;
147		}
148	1	}
149
150		/**
151		* Creates a new RSS File with information from the database. Max amount of news is configured in the initiation.
152		*
153		* @return void
154		*/
155	1	private function createRSS()
156		{
157	1	$file = fopen($this->rssFile, "w+");
158
159	1	$stmt = $this->db->prepare('SELECT * FROM ' . $this->table . ' ORDER BY CREATED DESC LIMIT ?');
160	1	$stmt->execute([$this->newsCount]);
161	1	$res = $stmt->fetchAll();
162
163	1	$xmlVersion = '<?xml version="1.0" encoding="UTF-8" ?>';
164
165		$startString = <<<EOD
166	1	{$xmlVersion}
167		<rss version="2.0">
168		<channel>
169	1	<title>{$this->feedDescription['title']}</title>
170	1	<link>{$this->feedDescription['link']}</link>
171	1	<description>{$this->feedDescription['description']}</description>
172	1	EOD;
173	1	fwrite($file, $startString);
174
175	1	foreach ($res as $post) {
176	1	$date = date("D, d M y H:i:s O", strtotime($post->CREATED));
177		$string = <<<EOD
178
179		<item>
180	1	<title>{$post->TITLE}</title>
181	1	<link>{$post->LINK}</link>
182	1	<description>{$post->DESCRIPTION}</description>
183	1	<pubDate>{$date}</pubDate>
184	1	</item>
185	1	EOD;
186	1	fwrite($file, $string);
187	1	}
188
189	1	fwrite($file, '
190		</channel>
191	1	</rss>');
192	1	}
193
194		/**
195		* Function that should be called to receive the RSS feed.
196		* Checks if the latest RSS File is up to date, if not, generates a new one.
197		* @return void
198		*/
199	2	public function getRSS()
200		{
201	2	$this->checkValidity();
202
203	2	if (!$this->valid) {
204	1	$this->createRSS();
205	1	}
206
207	2	if ($this->sendHeader) {
208		header('Content-type: application/rss+xml; charset=UTF-8');
209		}
210
211	2	readfile($this->rssFile);
212	2	}
213
214		/**
215		* Inserts information to RSS database
216		* @param $input should be an associative array with three pars TITLE, LINK, DESCRIPTION
217		*
218		* @return void
219		*/
220	1	public function insertRSS($input = [])
221		{
222	1	$stmt = $this->db->prepare("INSERT INTO " . $this->table . " (TITLE, LINK, DESCRIPTION, CREATED) VALUES (?, ?, ?, datetime('now', 'localtime'))");
223	1	$stmt->execute([$input['TITLE'], $input['LINK'], $input['DESCRIPTION']]);
224	1	}
225		}
226

heennkkee / rss

Push — master ( 1b7f83...68ea84 )

Crss::getRSS() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like