ConnectionResolver.php

TLDR

This file defines the ConnectionResolver class, which is used to manage database connections in the Illuminate\Database namespace.

Methods

__construct(array $connections = [])

This method creates a new instance of the ConnectionResolver class. It accepts an optional array of connections as a parameter and adds them to the resolver.

connection(string|null $name = null): ConnectionInterface

This method retrieves a database connection instance. If a name is provided, it returns the corresponding connection. If no name is provided, it returns the default connection.

addConnection(string $name, ConnectionInterface $connection): void

This method adds a connection to the resolver. It takes a connection name and a ConnectionInterface instance as parameters.

hasConnection(string $name): bool

This method checks if a connection with the specified name has been registered. It returns true if the connection exists, otherwise false.

getDefaultConnection(): string

This method returns the name of the default connection.

setDefaultConnection(string $name): void

This method sets the default connection name.

<?php

namespace Illuminate\Database;

class ConnectionResolver implements ConnectionResolverInterface
{
    /**
     * All of the registered connections.
     *
     * @var \Illuminate\Database\ConnectionInterface[]
     */
    protected $connections = [];

    /**
     * The default connection name.
     *
     * @var string
     */
    protected $default;

    /**
     * Create a new connection resolver instance.
     *
     * @param  array<string, \Illuminate\Database\ConnectionInterface>  $connections
     * @return void
     */
    public function __construct(array $connections = [])
    {
        foreach ($connections as $name => $connection) {
            $this->addConnection($name, $connection);
        }
    }

    /**
     * Get a database connection instance.
     *
     * @param  string|null  $name
     * @return \Illuminate\Database\ConnectionInterface
     */
    public function connection($name = null)
    {
        if (is_null($name)) {
            $name = $this->getDefaultConnection();
        }

        return $this->connections[$name];
    }

    /**
     * Add a connection to the resolver.
     *
     * @param  string  $name
     * @param  \Illuminate\Database\ConnectionInterface  $connection
     * @return void
     */
    public function addConnection($name, ConnectionInterface $connection)
    {
        $this->connections[$name] = $connection;
    }

    /**
     * Check if a connection has been registered.
     *
     * @param  string  $name
     * @return bool
     */
    public function hasConnection($name)
    {
        return isset($this->connections[$name]);
    }

    /**
     * Get the default connection name.
     *
     * @return string
     */
    public function getDefaultConnection()
    {
        return $this->default;
    }

    /**
     * Set the default connection name.
     *
     * @param  string  $name
     * @return void
     */
    public function setDefaultConnection($name)
    {
        $this->default = $name;
    }
}