VirtualFileSystem\Factory

Complexity

Total Complexity

10

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	3
A	getRoot()	0	4	1
A	updateMetadata()	0	7	1
A	updateFileTimes()	0	9	1
A	updateOwnership()	0	7	1
A	getDir()	0	4	1
A	getFile()	0	4	1
A	getLink()	0	4	1

<?php
/*
 * This file is part of the php-vfs package.
 *
 * (c) Michael Donat <michael.donat@me.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace VirtualFileSystem;

use VirtualFileSystem\Structure\Directory;
use VirtualFileSystem\Structure\File;
use VirtualFileSystem\Structure\Link;
use VirtualFileSystem\Structure\Node;
use VirtualFileSystem\Structure\Root;

/**
 * Factory class to encapsulate object creation.
 *
 * @author Michael Donat <michael.donat@me.com>
 * @package php-vfs
 */
class Factory
{
    protected $userid;
    protected $groupid;

    /**
     * Class constructor. Sets user/group to current system user/group.
     *
     * On non POSIX systems both attributes will be set to 0
     *
     */
    public function __construct()
    {
        $this->userid = function_exists('posix_getuid') ? posix_getuid() : 0;
        $this->groupid = function_exists('posix_getgid') ? posix_getgid() : 0;
    }

    /**
     * Creates Root object.
     *
     * @return Root
     */
    public function getRoot()
    {
        return $this->updateMetadata(new Root());
    }

    /**
     * Updates time and ownership of a node
     *
     * @param Node $node
     *
     * @return Node
     */
    public function updateMetadata(Node $node)
    {
        $this->updateFileTimes($node);
        $this->updateOwnership($node);

        return $node;
    }

    /**
     * Update file a/c/m times
     *
     * @param  Node $node
     * @return Node
     */
    public function updateFileTimes(Node $node)
    {
        $time = time();
        $node->setAccessTime($time);
        $node->setModificationTime($time);
        $node->setChangeTime($time);

        return $node;
    }

    /**
     * Sets default (current) uid/gui on object.
     *
     * @param Node $node
     *
     * @return Node
     */
    protected function updateOwnership(Node $node)
    {
        $node->chown($this->userid);
        $node->chgrp($this->groupid);

        return $node;
    }

    /**
     * Creates Directory object.
     *
     * @param string $basename
     *
     * @return Directory
     */
    public function getDir($basename)
    {
        return $this->updateMetadata(new Directory($basename));
    }

    /**
     * Creates File object.
     *
     * @param string $basename
     *
     * @return File
     */
    public function getFile($basename)
    {
        return $this->updateMetadata(new File($basename));
    }

    /**
     * Creates Link object.
     *
     * @param string         $basename
     * @param Structure\Node $destination
     *
     * @return Link
     */
    public function getLink($basename, Node $destination)
    {
        return $this->updateMetadata(new Link($basename, $destination));
    }
}