gggeek / db-3v4l

app/src/Service/DatabaseConfigurationManager.php

<?php

Missing file doc comment

namespace Db3v4l\Service;

class DatabaseConfigurationManager

Missing doc comment for class DatabaseConfigurationManager

{
    protected $instanceList = [];

    /**

Missing short description in doc comment

     * @param string[][] $instanceList key: instance name, values: connection specification
     */
    public function __construct(array $instanceList)
    {
        $this->instanceList = $instanceList;
    }

    /**

Missing short description in doc comment

     * @param string|string[] $includeFilter accepts 'glob' wildcards. Empty = include all

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string|string[] $excludeFilter accepts 'glob' wildcards. Empty = exclude none. NB: exclude match wins over include match

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string[]

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function listInstances($includeFilter = [], $excludeFilter = [])
    {
        if (!is_array($includeFilter)) {
            $includeFilter = [$includeFilter];
        }
        if (!is_array($excludeFilter)) {
            $excludeFilter = [$excludeFilter];
        }

        $names = [];
        foreach(array_keys($this->instanceList) as $name) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            if (empty($includeFilter)) {
                $include = true;
            } else {
                $include = false;
                foreach($includeFilter as $filter) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                    if (fnmatch($filter, $name)) {
                        $include = true;
                        break;
                    }
                }
            }

            if ($include && !empty($excludeFilter)) {
                foreach($excludeFilter as $filter) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                    if (fnmatch($filter, $name)) {
                        $include = false;
                        break;
                    }
                }
            }

            if ($include) {
                $names[] = $name;
            }
        }
        return $names;
    }

    /**

Missing short description in doc comment

     * @param string $instanceName

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string[]

Tag @return cannot be grouped with parameter tags in a doc comment

     * @throws \OutOfBoundsException

Tag @throws cannot be grouped with parameter tags in a doc comment

     */
    public function getInstanceConfiguration($instanceName)
    {
        if (isset($this->instanceList[$instanceName])) {
            return $this->instanceList[$instanceName];
        }

        throw new \OutOfBoundsException("Unknown database instance '$instanceName'");
    }

    /**

Missing short description in doc comment

     * @param string[] $instanceNames

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string[][]

Tag @return cannot be grouped with parameter tags in a doc comment

     * @throws \OutOfBoundsException

Tag @throws cannot be grouped with parameter tags in a doc comment

     */
    public function getInstancesConfiguration(array $instanceNames)
    {
        $instancesDefinitions = [];
        foreach($instanceNames as $instanceName)

Expected "foreach (...) {\n"; found "foreach(...)\n {\n"

        {
            $instancesDefinitions[$instanceName] = $this->getInstanceConfiguration($instanceName);
        }
        return $instancesDefinitions;
    }
}