Comodojo\Zip\Traits\CommentTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	24
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

2 Methods

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

<?php

namespace Comodojo\Zip\Traits;

use \Comodojo\Zip\Interfaces\ZipInterface;
use \ZipArchive;

/**
 * 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
{

    abstract public function getArchive(): ?ZipArchive;

    /**
     * Set the comment for the current archive
     *
     * @return ZipInterface
     */
    public function setComment(string $comment): ZipInterface
    {
        $this->getArchive()->setArchiveComment($comment);
        return $this;
    }

    /**
     * Get the current zip archive comment
     *
     * @return string
     */
    public function getComment(): ?string
    {
        return $this->getArchive()->getArchiveComment();
    }
}