Comodojo\Zip\Traits\CommentTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	23
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	setComment()	0	5	1
A	getComment()	0	3	1

<?php namespace Comodojo\Zip\Traits;

use \Comodojo\Zip\Interfaces\ZipInterface;

/**
 * Set/get the archive comment.
 *
 * @package     Comodojo Zip
 * @author      Marco Giovinazzi <marco.giovinazzi@comodojo.org>
 * @license     MIT
 *
 * LICENSE:
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

trait CommentTrait {

    /**
     * Set the comment for the current archive
     *
     * @return ZipInterface
     */
    public function setComment(string $comment): ZipInterface {

        $this->getArchive()->setArchiveComment($comment);

It seems like getArchive() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;

    }

    /**
     * Get the current zip archive comment
     *
     * @return string
     */
    public function getComment(): ?string {

        return $this->getArchive()->getArchiveComment();

    }

}