hanneskod\classtools\Iterator\SplFileInfo

Complexity

Total Complexity

35

Size/Duplication

Total Lines	309
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getReader()	0	12	3
A	getRelativePath()	0	4	1
A	getRelativePathname()	0	4	1
A	getContents()	0	4	1
A	getATime()	0	4	1
A	getBasename()	0	4	1
A	getCTime()	0	4	1
A	getExtension()	0	4	1
A	getFileInfo()	0	4	1
A	getFilename()	0	4	1
A	getGroup()	0	4	1
A	getInode()	0	4	1
A	getLinkTarget()	0	4	1
A	getMTime()	0	4	1
A	getOwner()	0	4	1
A	getPath()	0	4	1
A	getPathInfo()	0	4	1
A	getPathname()	0	4	1
A	getPerms()	0	4	1
A	getRealPath()	0	4	1
A	getSize()	0	4	1
A	getType()	0	4	1
A	isDir()	0	4	1
A	isExecutable()	0	4	1
A	isFile()	0	4	1
A	isLink()	0	4	1
A	isReadable()	0	4	1
A	isWritable()	0	4	1
A	openFile()	0	4	1
A	setFileClass()	0	4	1
A	setInfoClass()	0	4	1
A	__tostring()	0	4	1

<?php
/**
 * This program is free software. It comes without any warranty, to
 * the extent permitted by applicable law. You can redistribute it
 * and/or modify it under the terms of the Do What The Fuck You Want
 * To Public License, Version 2, as published by Sam Hocevar. See
 * http://www.wtfpl.net/ for more details.
 */

declare(strict_types = 1);

namespace hanneskod\classtools\Iterator;

use Symfony\Component\Finder\SplFileInfo as FinderSplFileInfo;
use hanneskod\classtools\Transformer\Reader;
use hanneskod\classtools\Exception\ReaderException;

/**
 * Decorates \Symfony\Component\Finder\SplFileInfo to support the creation of Readers
 *
 * @author Hannes Forsgård <hannes.forsgard@fripost.org>
 */
class SplFileInfo extends FinderSplFileInfo
{
    /**
     * @var FinderSplFileInfo
     */
    private $decorated;

    /**
     * @var Reader
     */
    private $reader;

    /**
     * Load decorated object
     */
    public function __construct(FinderSplFileInfo $decorated)
    {
        $this->decorated = $decorated;
    }

    /**
     * Get reader for the contents of this file
     *
     * @throws ReaderException If file contains syntax errors
     */
    public function getReader(): Reader
    {
        if (!isset($this->reader)) {
            try {
                $this->reader = new Reader((string)$this->getContents());
            } catch (ReaderException $exception) {
                throw new ReaderException($exception->getMessage() . ' in ' . $this->getPathname());
            }
        }

        return $this->reader;
    }

    /**
     * Returns the relative path
     */
    public function getRelativePath(): string
    {
        return $this->decorated->getRelativePath();
    }

    /**
     * Returns the relative path name
     */
    public function getRelativePathname(): string
    {
        return $this->decorated->getRelativePathname();
    }

    /**
     * Returns the contents of the file
     *
     * @return string
     */
    public function getContents()
    {
        return (string)$this->decorated->getContents();
    }

    /**
     * Gets the last access time for the file
     */
    public function getATime(): int
    {
        return $this->decorated->getATime();
    }

    /**
     * Returns the base name of the file, directory, or link without path info
     */
    public function getBasename($suffix = ''): string
    {
        return $this->decorated->getBasename($suffix);
    }

    /**
     * Returns the inode change time for the file
     */
    public function getCTime(): int
    {
        return $this->decorated->getCTime();
    }

    /**
     * Retrieves the file extension
     */
    public function getExtension(): string
    {
        return $this->decorated->getExtension();
    }

    /**
     * Gets an SplFileInfo object for the referenced file
     *
     * @param string $class_name
     */
    public function getFileInfo($class_name = ''): \SplFileInfo
    {
        return $this->decorated->getFileInfo($class_name);
    }

    /**
     * Gets the filename without any path information
     */
    public function getFilename(): string
    {
        return $this->decorated->getFilename();
    }

    /**
     * Gets the file group
     */
    public function getGroup(): int
    {
        return $this->decorated->getGroup();
    }

    /**
     * Gets the inode number for the filesystem object
     */
    public function getInode(): int
    {
        return $this->decorated->getInode();
    }

    /**
     * Gets the target of a filesystem link
     */
    public function getLinkTarget(): sring
    {
        return $this->decorated->getLinkTarget();
    }

    /**
     * Returns the time when the contents of the file were changed
     */
    public function getMTime(): int
    {
        return $this->decorated->getMTime();
    }

    /**
     * Gets the file owner
     */
    public function getOwner(): int
    {
        return $this->decorated->getOwner();
    }

    /**
     * Returns the path to the file, omitting the filename and any trailing slash
     */
    public function getPath(): string
    {
        return $this->decorated->getPath();
    }

    /**
     * Gets an SplFileInfo object for the parent of the current file
     *
     * @param  string $class_name
     */
    public function getPathInfo($class_name = ''): \SplFileInfo
    {
        return $this->decorated->getPathInfo($class_name);
    }

    /**
     * Returns the path to the file
     *
     * @return string
     */
    public function getPathname()
    {
        return $this->decorated->getPathname();
    }

    /**
     * Gets the file permissions for the file
     */
    public function getPerms(): int
    {
        return $this->decorated->getPerms();
    }

    /**
     * Expands all symbolic links and resolves relative references
     *
     * @return string
     */
    public function getRealPath()
    {
        return $this->decorated->getRealPath();
    }

    /**
     * Returns the filesize in bytes for the file referenced
     */
    public function getSize(): int
    {
        return $this->decorated->getSize();
    }

    /**
     * Returns the type of the file referenced
     */
    public function getType(): string
    {
        return $this->decorated->getType();
    }

    /**
     * This method can be used to determine if the file is a directory
     */
    public function isDir(): bool
    {
        return $this->decorated->isDir();
    }

    /**
     * Checks if the file is executable
     */
    public function isExecutable(): bool
    {
        return $this->decorated->isExecutable();
    }

    /**
     * Checks if the file referenced exists and is a regular file
     */
    public function isFile(): bool
    {
        return $this->decorated->isFile();
    }

    /**
     * Check if the file referenced is a link
     */
    public function isLink(): bool
    {
        return $this->decorated->isLink();
    }

    /**
     * Check if the file is readable
     */
    public function isReadable(): bool
    {
        return $this->decorated->isReadable();
    }

    /**
     * Check if the file is writable
     */
    public function isWritable(): bool
    {
        return $this->decorated->isWritable();
    }

    /**
     * Creates an SplFileObject object of the file
     *
     * @param  string   $open_mode
     * @param  boolean  $use_include_path
     * @param  resource $context
     * @return \SplFileObject
     */
    public function openFile($open_mode = "r", $use_include_path = false, $context = null)
    {
        return $this->decorated->openFile($open_mode, $use_include_path, $context);
    }

    /**
     * Set the class name which will be used to open files when openFile() is called
     *
     * @param  string $class_name
     * @return void
     */
    public function setFileClass($class_name = '')
    {
        $this->decorated->setFileClass($class_name);
    }

    /**
     * Set the class name which will be used when getFileInfo and getPathInfo are called
     *
     * @param  string $class_name
     * @return void
     */
    public function setInfoClass($class_name = '')
    {
        $this->decorated->setInfoClass($class_name);
    }

    /**
     * This method will return the file name of the referenced file
     *
     * @return string
     */
    public function __tostring()
    {
        return (string)$this->decorated;
    }
}