ParserInterface::getColumnNames()
last analyzed

Size

Total Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 1
c 0
b 0
f 0
1
<?php
2
3
namespace Linio\Component\SpreadsheetParser\Parser;
4
5
interface ParserInterface
6
{
7
    /**
8
     * @param string $filePath
9
     * @param array $options
10
     */
11
    public function __construct($filePath, array $options = []);
0 ignored issues
show
Documentation introduced by
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.

For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a @return doc comment to communicate to implementors of these methods what they are expected to return.

Loading history...
12
13
    /**
14
     * @return bool
15
     */
16
    public function open();
0 ignored issues
show
Coding Style introduced by
function open() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
17
18
    /**
19
     * @return array
20
     */
21
    public function getColumnNames();
22
23
    /**
24
     * @param int $numRows
25
     *
26
     * @return array
27
     */
28
    public function getData($numRows = 0);
29
30
    /**
31
     * @return bool
32
     */
33
    public function close();
0 ignored issues
show
Coding Style introduced by
function close() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
34
}
35