herroffizier\yii2dumpling\dumpers\DumperInterface

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
	__construct()	0	1	?
	dump()	0	1	?
	restore()	0	1	?

<?php
/**
 * Yii2 Dumpling.
 *
 * This file contains dumper interface.
 *
 * @author  Alexei Korotin <herr.offizier@gmail.com>
 */

namespace herroffizier\yii2dumpling\dumpers;

/**
 * Dumper interface.
 *
 * All dumpers must implement this interface.
 */
interface DumperInterface
{
    /**
     * Constructor.
     *
     * If username or password are not supported, nulls should be passed.
     *
     * @param array       $dsn
     * @param string|null $username
     * @param string|null $password
     */
    public function __construct(array $dsn, $username, $password);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Dump database to given file.
     *
     * Aliases in file name should not be used as they should be resolved earlier.
     *
     * @param string $file
     */
    public function dump($file);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Restore database from given file.
     *
     * Aliases in file name should not be used as they should be resolved earlier.
     *
     * @param string $file
     */
    public function restore($file);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}