ConfigToken\FileClient\FileClientInterface

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
	getServerType()	0	1	?
	getClassName()	0	1	?
	hasConnectionSettings()	0	1	?
	getConnectionSettings()	0	1	?
	getFileLocationHash()	0	1	?
	readFile()	0	1	?

<?php

namespace ConfigToken\FileClient;


use ConfigToken\ConnectionSettings\ConnectionSettingsInterface;

/**
 * File client interface.
 * @package ConfigToken\FileServer
 */
interface FileClientInterface
{
    /**
     * Get the file server type identifier corresponding to the client's implementation.
     *
     * @return string
     */
    public static function getServerType();

    /**
     * Get the implementation class name.
     *
     * @return string
     */
    public static function getClassName();

    /**
     * Check if the connection settings have been set.
     *
     * @return boolean
     */
    public function hasConnectionSettings();

    /**
     * Get the connection settings.
     *
     * @return ConnectionSettingsInterface
     */
    public function getConnectionSettings();

    /**
     * Obtain an unique identifier for the given file name based on the connection settings.
     *
     * @param string $file
     * @return string
     */
    public function getFileLocationHash($file);

    /**
     * Return the file content type and content.
     *
     * @param string $fileName
     * @throws \Exception
     * @return array(string, string) [$contentType, $content]

The doc-type array(string, could not be parsed: Expected "|" or "end of type", but got "(" at position 5. (view supported doc-types)

     */
    public function readFile($fileName);
}