ClassGeneration\WriterInterface

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
	__construct()	0	1	?
	setPhpClass()	0	1	?
	getPhpClass()	0	1	?
	setPath()	0	1	?
	getPath()	0	1	?
	setFileName()	0	1	?
	getFileName()	0	1	?
	write()	0	1	?

<?php

/*
 * This file is part of the ClassGeneration package.
 *
 * (c) Antonio Spinelli <tonicospinelli@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ClassGeneration;

/**
 * Class WriterInterface
 * @author Antonio Spinelli <tonicospinelli@gmail.com>
 */
interface WriterInterface
{

    /**
     * Class to write a file from Class Object.
     *
     * @param PhpClassInterface|array $class
     *
     * @return WriterInterface

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($class = array());

    /**
     * @param PhpClassInterface $class
     *
     * @return WriterInterface
     */
    public function setPhpClass(PhpClassInterface $class);

    /**
     * @return PhpClassInterface
     */
    public function getPhpClass();

    /**
     * @param string $path
     *
     * @return WriterInterface
     */
    public function setPath($path);

    /**
     * @return string
     */
    public function getPath();

    /**
     * @param $fileName
     *
     * @return WriterInterface
     */
    public function setFileName($fileName);

    /**
     * @return string
     */
    public function getFileName();

    /**
     * Writes the class on file.
     * @return void
     */
    public function write();
}