Api::getApiKey()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
eloc 3
dl 0
loc 5
ccs 0
cts 5
cp 0
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
crap 2
1
<?php
2
namespace ApacheSolrForTypo3\Solr;
3
4
/***************************************************************
5
 *  Copyright notice
6
 *
7
 *  (c) 2012-2015 Ingo Renner <[email protected]>
8
 *  All rights reserved
9
 *
10
 *  This script is part of the TYPO3 project. The TYPO3 project is
11
 *  free software; you can redistribute it and/or modify
12
 *  it under the terms of the GNU General Public License as published by
13
 *  the Free Software Foundation; either version 3 of the License, or
14
 *  (at your option) any later version.
15
 *
16
 *  The GNU General Public License can be found at
17
 *  http://www.gnu.org/copyleft/gpl.html.
18
 *
19
 *  This script is distributed in the hope that it will be useful,
20
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
21
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22
 *  GNU General Public License for more details.
23
 *
24
 *  This copyright notice MUST APPEAR in all copies of the script!
25
 ***************************************************************/
26
27
/**
28
 * Remote API related methods
29
 *
30
 * @author Ingo Renner <[email protected]>
31
 */
32
class Api
33
{
34
35
    /**
36
     * Checks whether a string is a valid API key.
37
     *
38
     * @param string $apiKey API key to check for validity
39
     * @return bool TRUE if the API key is valid, FALSE otherwise
40
     */
41
    public static function isValidApiKey($apiKey)
42
    {
43
        return ($apiKey === self::getApiKey());
44
    }
45
46
    /**
47
     * Generates the API key for the REST API
48
     *
49
     * @return string API key for this installation
50
     */
51
    public static function getApiKey()
52
    {
53
        return sha1(
54
            $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] .
55
            'tx_solr_api'
56
        );
57
    }
58
}
59