WriterInterface::getPhpClass()
last analyzed

Size

Total Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 1
1
<?php
2
3
/*
4
 * This file is part of the ClassGeneration package.
5
 *
6
 * (c) Antonio Spinelli <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace ClassGeneration;
13
14
/**
15
 * Class WriterInterface
16
 * @author Antonio Spinelli <[email protected]>
17
 */
18
interface WriterInterface
19
{
20
21
    /**
22
     * Class to write a file from Class Object.
23
     *
24
     * @param PhpClassInterface|array $class
25
     *
26
     * @return WriterInterface
0 ignored issues
show
Comprehensibility Best Practice introduced by
Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

Adding a @return annotation to a constructor is not recommended, since a constructor does not have a meaningful return value.

Please refer to the PHP core documentation on constructors.

Loading history...
27
     */
28
    public function __construct($class = array());
29
30
    /**
31
     * @param PhpClassInterface $class
32
     *
33
     * @return WriterInterface
34
     */
35
    public function setPhpClass(PhpClassInterface $class);
36
37
    /**
38
     * @return PhpClassInterface
39
     */
40
    public function getPhpClass();
41
42
    /**
43
     * @param string $path
44
     *
45
     * @return WriterInterface
46
     */
47
    public function setPath($path);
48
49
    /**
50
     * @return string
51
     */
52
    public function getPath();
53
54
    /**
55
     * @param $fileName
56
     *
57
     * @return WriterInterface
58
     */
59
    public function setFileName($fileName);
60
61
    /**
62
     * @return string
63
     */
64
    public function getFileName();
65
66
    /**
67
     * Writes the class on file.
68
     * @return void
69
     */
70
    public function write();
71
}
72