Bedd\BabelNet\Client

Complexity

Total Complexity

20

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	exec()	0	21	2
B	getParamsByArguments()	0	21	9
A	getVersion()	0	5	2
A	getSynsetIds()	0	4	1
A	getSynsetById()	0	4	1
A	getSynsets()	0	8	2
A	getSenses()	0	4	1
A	getEdges()	0	4	1

<?php
namespace Bedd\BabelNet;

/**
 * Client for the BabelNet HTTP Api
 * 
 * @see http://babelnet.org/guide
 */
class Client
{
    /**
     * API Key
     * 
     * @var string
     */
    private $api_key = '';
    
    /**
     * Base URL
     * 
     * @var string
     */
    private $base_url = 'https://babelnet.io/v4/';
    
    /**
     * @var array
     */
    private $defaultParams = [];
    
    /**
     * Constructor
     * 
     * @param string $api_key
     * @param array $defaultParams
     */
    public function __construct($api_key, array $defaultParams = [])
    {
        $this->api_key = $api_key;
        $this->defaultParams = $defaultParams;
    }

    /**
     * Executes an api call
     * @param string $service
     * @param array $params
     * @throws \Exception
     * @return mixed
     */
    private function exec($service, $params = array())
    {
        //add key
        $params['key'] = $this->api_key;
        //make request
        $url = $this->base_url.$service.'?'.http_build_query($params);
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, false);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($ch, CURLOPT_ENCODING, 'gzip');
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        $response = json_decode(curl_exec($ch), true);
        $info = curl_getinfo($ch);
        if ($info['http_code'] !== 200) {
            throw new \Exception($response['message'], $info['http_code']);
        }
        curl_close($ch);
        return $response;
    }
    
    /**
     * Returns a param list from a method-reflection and his params
     * 
     * @param string $method
     * @param array $args
     * @return array
     */
    private function getParamsByArguments($method, $args)
    {
        $params = [];
        $m = new \ReflectionMethod($method);
        foreach ($m->getParameters() as $param) {
            $value = isset($args[$param->getPosition()]) ? $args[$param->getPosition()] : null;
            $name = $param->getName();

Consider using $param->name. There is an issue with getName() and APC-enabled PHP versions.

            if ($value === null && $param->isOptional()) {
                if ($param->isDefaultValueAvailable() && ($new_value = $param->getDefaultValue()) !== null) {
                    $value = $new_value;
                } else if (isset($this->defaultParams[$name])) {
                    $value = $this->defaultParams[$name];
                }
            }
            if ($value === null) {
                continue;
            }
            $params[$name] = $value;
        }
        return $params;
    }
    
    /**
     * @see http://babelnet.org/guide#RetrieveBabelNetversion
     * @throws \Exception
     * @return string
     */
    public function getVersion()
    {
        $res = $this->exec('getVersion');
        return isset($res['version']) ? $res['version'] : false;
    }
    
    /**
     * @see http://babelnet.org/guide#RetrievetheIDsoftheBabelsynsets(concepts)denotedbyagivenword
     * @param string $word
     * @param string $lang
     * @param string $filterLangs
     * @param string $pos
     * @param string $source
     * @param string $normalizer
     * @throws \Exception
     * @return string[]
     */
    public function getSynsetIds($word, $lang = null, $filterLangs = null, $pos = null, $source = null, $normalizer = null)

The parameter $word is not used and could be removed.

The parameter $lang is not used and could be removed.

The parameter $filterLangs is not used and could be removed.

The parameter $pos is not used and could be removed.

The parameter $source is not used and could be removed.

The parameter $normalizer is not used and could be removed.

    {
        return array_column($this->exec('getSynsetIds', $this->getParamsByArguments(__METHOD__, func_get_args())), 'id');
    }
    
    /**
     * @see http://babelnet.org/guide#Retrievetheinformationofagivensynset
     * @param string $id
     * @param string $filterLangs
     * @throws \Exception
     * @return array
     */
    public function getSynsetById($id, $filterLangs = null)

The parameter $id is not used and could be removed.

The parameter $filterLangs is not used and could be removed.

    {
        return $this->exec('getSynset', $this->getParamsByArguments(__METHOD__, func_get_args()));
    }
    
    /**
     * @see http://babelnet.org/guide#RetrievetheIDsoftheBabelsynsets(concepts)denotedbyagivenword
     * @param string $word
     * @param string $lang
     * @param string $filterLangs
     * @param string $pos
     * @param string $source
     * @param string $normalizer
     * @throws \Exception
     * @return array
     */
    public function getSynsets($word, $lang = null, $filterLangs = null, $pos = null, $source = null, $normalizer = null)
    {
        $synsets = [];
        foreach ($this->getSynsetIds($word, $lang, $filterLangs, $pos, $source, $normalizer) as $synset_id) {
            $synsets[] = $this->getSynsetById($synset_id, $filterLangs);
        }
        return $synsets;
    }
    
    /**
     * @see http://babelnet.org/guide#Retrievethesensesofagivenword
     * @param string $word
     * @param string $lang
     * @param string $filterLangs
     * @param string $pos
     * @param string $source
     * @param string $normalizer
     * @throws \Exception
     * @return array
     */
    public function getSenses($word, $lang = null, $filterLangs = null, $pos = null, $source = null, $normalizer = null)

The parameter $word is not used and could be removed.

The parameter $lang is not used and could be removed.

The parameter $filterLangs is not used and could be removed.

The parameter $pos is not used and could be removed.

The parameter $source is not used and could be removed.

The parameter $normalizer is not used and could be removed.

    {
        return $this->exec('getSenses', $this->getParamsByArguments(__METHOD__, func_get_args()));
    }
    
    /**
     * @see http://babelnet.org/guide#RetrieveedgesofagivenBabelNetsynset6
     * @param string $id
     * @throws \Exception
     * @return array
     */
    public function getEdges($id)

The parameter $id is not used and could be removed.

    {
        return $this->exec('getEdges', $this->getParamsByArguments(__METHOD__, func_get_args()));
    }
}