FileClientInterface::readFile() - Code Metrics - liutec/cfgtokenlib - Measure and Improve Code Quality continuously with Scrutinizer

FileClientInterface::readFile()
last analyzed 2017-01-27 09:34 UTC

↳ Parent: FileClientInterface

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
c	0
b	0
f	0

<?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]

     */
    public function readFile($fileName);
}

1			<?php
2
3			namespace ConfigToken\FileClient;
4
5
6			use ConfigToken\ConnectionSettings\ConnectionSettingsInterface;
7
8			/**
9			* File client interface.
10			* @package ConfigToken\FileServer
11			*/
12			interface FileClientInterface
13			{
14			/**
15			* Get the file server type identifier corresponding to the client's implementation.
16			*
17			* @return string
18			*/
19			public static function getServerType();
20
21			/**
22			* Get the implementation class name.
23			*
24			* @return string
25			*/
26			public static function getClassName();
27
28			/**
29			* Check if the connection settings have been set.
30			*
31			* @return boolean
32			*/
33			public function hasConnectionSettings();
34
35			/**
36			* Get the connection settings.
37			*
38			* @return ConnectionSettingsInterface
39			*/
40			public function getConnectionSettings();
41
42			/**
43			* Obtain an unique identifier for the given file name based on the connection settings.
44			*
45			* @param string $file
46			* @return string
47			*/
48			public function getFileLocationHash($file);
49
50			/**
51			* Return the file content type and content.
52			*
53			* @param string $fileName
54			* @throws \Exception
55			* @return array(string, string) [$contentType, $content]
			0 ignored issues – show Documentation introduced 2016-01-04 14:20 UTC by Report Bug Copy Issue Report The doc-type `array(string,` could not be parsed: Expected "\|" or "end of type", but got "(" at position 5. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
56			*/
57			public function readFile($fileName);
58			}

liutec / cfgtokenlib

FileClientInterface::readFile() last analyzed 2017-01-27 09:34 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FileClientInterface::readFile()
last analyzed 2017-01-27 09:34 UTC