Ldap::add() - Code Metrics - Inspection of "kw_mapper - other storages uses getConnection" - alex-kalanis/kw_mapper - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 11fb63...ed1d12 )

by Petr

created 2023-03-31 04:29 UTC

Ldap::add() A

↳ Parent: Ldap

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	2
dl	0
loc	3
ccs	0
cts	3
cp	0
crap	2
rs	10

<?php

namespace kalanis\kw_mapper\Storage\Database\Raw;


use kalanis\kw_mapper\Interfaces\IPassConnection;
use kalanis\kw_mapper\MapperException;
use kalanis\kw_mapper\Storage\Database\ADatabase;
use kalanis\kw_mapper\Storage\Database\Dialects;
use kalanis\kw_mapper\Storage\Database\TConnection;


/**
 * Class Ldap
 * @package kalanis\kw_mapper\Storage\Database\Raw
 * Lightweight directory access protocol
 * @link https://www.php.net/manual/en/function.ldap-bind
 * @link https://www.geekshangout.com/php-example-get-data-active-directory-via-ldap/
 * @link https://github.com/etianen/django-python3-ldap/blob/master/django_python3_ldap/ldap.py
 * @link https://github.com/django-auth-ldap/django-auth-ldap/blob/master/django_auth_ldap/backend.py
 * @codeCoverageIgnore remote connection
 */
class Ldap extends ADatabase implements IPassConnection
{
    use TConnection;

    protected $extension = 'ldap';
    /** @var resource|null */
    protected $connection = null;

    public function languageDialect(): string
    {
        return Dialects\EmptyDialect::class;
    }

    public function disconnect(): void
    {
        if ($this->isConnected()) {
            ldap_unbind($this->connection);
            ldap_unbind(/** @scrutinizer ignore-type */ $this->connection);
        }
        $this->connection = null;
    }

    /**
     * @param bool $withBind
     * @throws MapperException
     */
    public function connect(bool $withBind = true): void
    {
        if (!$this->isConnected()) {
            $this->connection = $this->connectToServer();
            if ($withBind) {
                $this->bindUser($this->config->getUser(), $this->config->getPassword());
            }
        }
    }

    /**
     * @throws MapperException
     * @return resource
     */
    protected function connectToServer()
    {
        $connection = ldap_connect($this->config->getLocation());

        if (false === $connection) {
            throw new \RuntimeException('Ldap connection error.');
        }

        if ( false !== strpos($this->config->getLocation(), 'ldaps://' )) {
            if (!ldap_start_tls($connection)) {
                throw new MapperException('Cannot start TLS for secured connection!');
            }
        }
        // Go with LDAP version 3 if possible (needed for renaming and Novell schema fetching)
        ldap_set_option($connection, LDAP_OPT_PROTOCOL_VERSION, 3);
        // We need this for doing a LDAP search.
        ldap_set_option($connection, LDAP_OPT_REFERRALS, 0);

        return $connection;
    }

    /**
     * @param string $domain
     * @param array<string|int, int|string|float|null> $changed
     * @throws MapperException
     * @return bool
     */
    public function add(string $domain, array $changed): bool
    {
        return ldap_add($this->getConnection(), $domain, $changed);
        return ldap_add(/** @scrutinizer ignore-type */ $this->getConnection(), $domain, $changed);
    }

    /**
     * @param string $domain
     * @param array<string|int, int|string|float|null> $changed
     * @throws MapperException
     * @return bool
     */
    public function replace(string $domain, array $changed): bool
    {
        return ldap_mod_replace($this->getConnection(), $domain, $changed);
        return ldap_mod_replace(/** @scrutinizer ignore-type */ $this->getConnection(), $domain, $changed);
    }

    /**
     * @param string $domain
     * @throws MapperException
     * @return bool
     */
    public function delete(string $domain): bool
    {
        return ldap_delete($this->getConnection(), $domain);
        return ldap_delete(/** @scrutinizer ignore-type */ $this->getConnection(), $domain);
    }

    /**
     * @param string $domain
     * @param string $filter
     * @throws MapperException
     * @return array<string|int, string|int|float|array<string|int|float>>
     */
    public function search(string $domain, string $filter): array
    {
        $result = ldap_search($this->getConnection(), $domain, $filter);
        $result = ldap_search(/** @scrutinizer ignore-type */ $this->getConnection(), $domain, $filter);
        if (false === $result) {
            return [];
        }

        $items = ldap_get_entries($this->getConnection(), $result);
        $items = ldap_get_entries(/** @scrutinizer ignore-type */ $this->getConnection(), $result);
        if (false === $items) {
            return [];
        }

        return $items;
    }

    /**
     * @param string $domain
     * @param string $pass
     * @throws MapperException
     * @return bool
     */
    public function bindUser(string $domain, string $pass): bool
    {
        return ldap_bind($this->getConnection(), $domain, $pass);
        return ldap_bind(/** @scrutinizer ignore-type */ $this->getConnection(), $domain, $pass);
    }

    /**
     * @throws MapperException
     * @return string
     */
    public function getDomain(): string
    {
        if (!isset($this->attributes['domain'])) {
            throw new MapperException('The domain is not set!');
        }
        return strval($this->attributes['domain']);
    }
}


alex-kalanis / kw_mapper

Push — master ( 11fb63...ed1d12 )

Ldap::add() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like