Subreality\Dilmun\Nabu\LoggerHandler\File

Complexity

Total Complexity

17

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	__destruct()	0	4	1
A	getFileName()	0	4	1
A	getFilePath()	0	4	1
A	setFileName()	0	4	1
A	setFilePath()	0	5	1
A	clearFile()	0	10	2
A	close()	0	4	1
A	initialize()	0	18	3
A	write()	0	21	4

<?php

namespace Subreality\Dilmun\Nabu\LoggerHandler;

/**
 * Log file object implementing a standard HandlerInterface for log entry handlers.
 *
 * @author derek
 */
class File extends AbstractHandler
{
    private $file_name;
    private $file_path;

    /**
     * @var \SplFileObject
     */
    private $file_pointer;

    /**
     * Sets up the file name and path if optional parameters provided.
     *
     * @param string|null   $file_name [optional] The name of the file used for logging; file_path is not required if
     *                      file_name is fully-qualified.
     * @param string|null   $file_path [optional] The path of the file used for logging without the trailing directory
     *                          separator
     */
    public function __construct($file_name = null, $file_path = null)
    {
        $this->file_name = $file_name;

        //Trim any trailing directory separators from the path.
        if (isset($file_path)) {
            $this->setFilePath($file_path);
        }
    }

    /**
     * Clean-up
     */
    public function __destruct()
    {
        $this->close();
    }

    /**
     * @return string|null  The file_name set for the File instance
     */
    public function getFileName()
    {
        return $this->file_name;
    }

    /**
     * @return string|null  The file_path set for the File instance
     */
    public function getFilePath()
    {
        return $this->file_path;
    }

    /**
     * Sets the name of the file to be used for logging; setting file_path is not required if the specified file name
     * is fully-qualified.
     *
     * @param string $file_name The name of the file to be used for logging
     */
    public function setFileName($file_name)
    {
        $this->file_name = $file_name;
    }

    /**
     * Sets the path of the file to be used for logging; file path should not be set if the File's file name is
     * fully-qualified.
     *
     * @see File::setFileName()
     *
     * @param string $file_path The path of the file to be used for logging
     */
    public function setFilePath($file_path)
    {
        //Trip any trailing directory separators from the path.
        $this->file_path = rtrim($file_path, '\/');
    }

    /**
     * Truncates the File to zero bytes, effectively clearing the file's contents. Does not delete the file.
     *
     * @return bool Returns true if truncate succeeded; returns false on failure.
     */
    public function clearFile()
    {
        $cleared = false;

        if (isset($this->file_pointer)) {
            $cleared = $this->file_pointer->ftruncate(0);
        }

        return $cleared;
    }

    /**
     * Sets the File's file_pointer to null to clean up resource.
     */
    public function close()
    {
        $this->file_pointer = null;
    }

    /**
     * Initializes the File for writing via append. Initialization attempts to create an SplFileObject pointer using
     * the File's name and path properties.
     *
     * @see \SplFileObject
     *
     * @return bool Returns true on successful file pointer creation; returns false on failure.
     */
    public function initialize()
    {
        $full_file = "";

        if (isset($this->file_path)) {
            $full_file = $this->file_path . DIRECTORY_SEPARATOR;
        }

        $full_file .= $this->file_name;

        try {
            $this->file_pointer = new \SplFileObject($full_file, "a");

            return true;
        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * Writes the specified message to the File pointer. Requires initialization via File::initialize().
     *
     * @see File::initialize()
     *
     * @param string $message   Message to be written to the file.
     *
     * @return bool             Returns true on successful write; returns false on failure.
     */
    public function write($message)
    {
        $file_writable   = false;
        $message_written = false;

        if ($this->output_allowed) {
            if (isset($this->file_pointer)) {
                $file_writable = $this->file_pointer->flock(LOCK_EX);
            }

            if ($file_writable) {
                $now = date('Y-m-d H:i:s');
                $this->file_pointer->fwrite("$now : $message" . "\r\n");
                $this->file_pointer->flock(LOCK_UN);

                $message_written = true;
            }
        }

        return $message_written;
    }
}