PHPetroleum\Pipe

Complexity

Total Complexity

6

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	create()	0	13	2
A	open()	0	9	1
A	write()	0	10	1
A	read()	0	6	1

<?php

namespace PHPetroleum;

class Pipe
{
    private $name;
    private $pipe;
    private $size;

    /**
     * @param string $name
     * @param int $size
     *
     * @return void

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

     */
    public function __construct($name, $size = 8)
    {
        $this->name = $name;
        $this->size = $size;
    }

    /**
     * Create the file if needed
     *
     * @return Pipe

Should the return type not be Pipe|null?

     */
    public function create(){
        if (!is_file($this->name)) {

            return;
        }

        posix_mkfifo(
            $this->name,
            0777
        );

        return $this;
    }

    /**
     * Open the file with the given mode
     *
     * @param string $mode
     *
     * @return resource
     */
    public function open($mode)
    {
        $this->create();

        return $this->pipe = fopen(
            $this->name,
            $mode
        );
    }

    /**
     * Write the content into the file
     *
     *
     * @param string $string
     * @return Pipe
     */
    public function write($string){
        $string = (string)$string;
        $length = strlen($string);

        $this->open('w');
        fwrite($this->pipe, str_pad($length, $this->size, "0", STR_PAD_LEFT));

The string literal 0 does not require double quotes, as per coding-style, please use single quotes.

        fwrite($this->pipe, $string);

        return $this;
    }

    /**
     * Wait for file content. Return the content
     *
     * @return string
     */
    public function read(){
        $this->open('r');
        $length = fread($this->pipe, $this->size);

        return fread($this->pipe, intval($length));
    }
}