ZBateson\MailMimeParser\Message\Part\MessagePart

Complexity

Total Complexity

19

Size/Duplication

Total Lines	238
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	3
A	__destruct()	0	12	3
A	getMessageObjectId()	0	4	1
A	hasContent()	0	7	2
	isTextPart()	0	1	?
	getContentType()	0	1	?
	getCharset()	0	1	?
	getContentDisposition()	0	1	?
	getContentTransferEncoding()	0	1	?
A	getFilename()	0	4	1
	isMime()	0	1	?
A	getHandle()	0	7	2
A	getContentResourceHandle()	0	20	4
A	getContent()	0	9	2
A	getParent()	0	4	1

<?php
/**
 * This file is part of the ZBateson\MailMimeParser project.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD
 */
namespace ZBateson\MailMimeParser\Message\Part;

/**
 * Represents a single part of a message.
 *
 * A MessagePart object may have any number of child parts, or may be a child
 * itself with its own parent or parents.
 *
 * The content of the part can be read from its PartStream resource handle,
 * accessible via MimePart::getContentResourceHanlde.
 *
 * @author Zaahid Bateson
 */
abstract class MessagePart
{
    /**
     * @var \ZBateson\MailMimeParser\Message\Part\MimePart parent part
     */
    protected $parent;

    /**
     * @var resource a resource handle containing this part's headers, content
     *      and children
     */
    protected $handle;
    
    /**
     * @var resource a resource handle to this part's content
     */
    protected $contentHandle;
    
    /**
     * @var PartStreamFilterManager manages attached filters to $contentHandle
     */
    protected $partStreamFilterManager;
    
    /**
     * @var string a unique ID representing the message this part belongs to.
     */
    protected $messageObjectId;

    /**
     * Sets up class dependencies.
     * 
     * @param string $messageObjectId
     * @param PartBuilder $partBuilder
     * @param PartStreamFilterManager $partStreamFilterManager
     */
    public function __construct(
        $messageObjectId,
        PartBuilder $partBuilder,
        PartStreamFilterManager $partStreamFilterManager
    ) {
        $this->messageObjectId = $messageObjectId;
        $partFilename = $partBuilder->getStreamPartFilename($messageObjectId);
        $contentFilename = $partBuilder->getStreamContentFilename($messageObjectId);
        $this->partStreamFilterManager = $partStreamFilterManager;
        if ($partFilename !== null) {
            $this->handle = fopen($partFilename, 'r');
        }
        if ($contentFilename !== null) {
            $this->contentHandle = fopen($contentFilename, 'r');
        }
    }

    /**
     * Closes the attached resource handles.
     */
    public function __destruct()
    {
        // stream_filter_append may be cleaned up by PHP, but for large files
        // and many emails may be more efficient to fully clean up
        $this->partStreamFilterManager->reset();
        if (is_resource($this->handle)) {
            fclose($this->handle);
        }
        if (is_resource($this->contentHandle)) {
            fclose($this->contentHandle);
        }
    }
    
    /**
     * Returns the unique object ID registered with the PartStreamRegistry
     * service object for the message this part belongs to.
     * 
     * @return string
     * @see \ZBateson\MailMimeParser\SimpleDi::registerStreamExtensions
     * @see \ZBateson\MailMimeParser\Stream\PartStream::stream_open
     */
    public function getMessageObjectId()
    {
        return $this->messageObjectId;
    }

    /**
     * Returns true if there's a content stream associated with the part.
     *
     * @return boolean
     */
    public function hasContent()
    {
        if ($this->contentHandle !== null) {
            return true;
        }
        return false;
    }

    /**
     * Returns true if this part's mime type is text/plain, text/html or has a
     * text/* and has a defined 'charset' attribute.
     * 
     * @return bool
     */
    public abstract function isTextPart();

The abstract declaration must precede the visibility declaration

    
    /**
     * Returns the mime type of the content.
     * 
     * @return string
     */
    public abstract function getContentType();

The abstract declaration must precede the visibility declaration

    
    /**
     * Returns the charset of the content, or null if not applicable/defined.
     * 
     * @return string
     */
    public abstract function getCharset();

The abstract declaration must precede the visibility declaration

    
    /**
     * Returns the content's disposition.
     * 
     * @return string
     */
    public abstract function getContentDisposition();

The abstract declaration must precede the visibility declaration

    
    /**
     * Returns the content-transfer-encoding used for this part.
     * 
     * @return string
     */
    public abstract function getContentTransferEncoding();

The abstract declaration must precede the visibility declaration

    
    /**
     * Returns a filename for the part if one is defined, or null otherwise.
     * 
     * @return string
     */
    public function getFilename()
    {
        return null;
    }
    
    /**
     * Returns true if the current part is a mime part.
     * 
     * @return bool
     */
    public abstract function isMime();

The abstract declaration must precede the visibility declaration

    
    /**
     * Returns a resource stream handle allowing a user to read the original
     * stream (including headers and child parts) that was used to create the
     * current part.
     * 
     * Note that 'rewind()' is called on the resource prior to returning it,
     * which may affect other read operations if multiple calls to 'getHandle'
     * are used.
     * 
     * The resource stream is handled by MessagePart and is closed by the
     * destructor.
     * 
     * @return resource the resource handle or null if not set
     */
    public function getHandle()
    {
        if (is_resource($this->handle)) {
            rewind($this->handle);
        }
        return $this->handle;
    }
    
    /**
     * Returns the resource stream handle for the part's content or null if not
     * set.  rewind() is called on the stream before returning it.
     *
     * The resource is automatically closed by MimePart's destructor and should
     * not be closed otherwise.
     *
     * The returned resource handle is a stream with decoding filters appended
     * to it.  The attached filters are determined by the passed
     * $transferEncoding and $charset headers, or by looking at the part's
     * Content-Transfer-Encoding and Content-Type headers if not passed.  The
     * following encodings are currently supported:
     *
     * - Quoted-Printable
     * - Base64
     * - X-UUEncode
     *
     * In addition a ZBateson\MailMimeParser\Stream\CharsetStreamFilter is
     * attached for text parts to convert text in the stream to UTF-8.
     *
     * @return resource
     */
    public function getContentResourceHandle($transferEncoding = '', $charset = '')
    {
        if (is_resource($this->contentHandle)) {
            rewind($this->contentHandle);
            $tr = $transferEncoding;
            $ch = $charset;
            if ($tr === '') {
                $tr = $this->getContentTransferEncoding();
            }
            if ($ch === '') {
                $ch = $this->getCharset();
            }
            $this->partStreamFilterManager->attachContentStreamFilters(
                $this->contentHandle,
                $tr,
                $ch
            );
        }
        return $this->contentHandle;
    }

    /**
     * Shortcut to reading stream content and assigning it to a string.  Returns
     * null if the part doesn't have a content stream.
     *
     * @return string
     */
    public function getContent()
    {
        if ($this->hasContent()) {
            $text = stream_get_contents($this->getContentResourceHandle());
            rewind($this->contentHandle);
            return $text;
        }
        return null;
    }

    /**
     * Returns this part's parent.
     *
     * @return \ZBateson\MailMimeParser\Message\Part\MimePart
     */
    public function getParent()
    {
        return $this->parent;
    }
}