AppUtils\RequestHelper_Boundaries

Complexity

Total Complexity

11

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	createBoundary()	0	3	1
A	__construct()	0	3	1
A	addVariable()	0	6	1
A	addBoundary()	0	6	1
A	render()	0	13	2
A	getContentLength()	0	3	1
A	addContent()	0	8	1
A	addFile()	0	9	1
A	getMimeBoundary()	0	3	1
A	getEOL()	0	3	1

<?php
/**
 * File containing the {@link RequestHelper_Boundaries} class.
 * @package Application Utils
 * @subpackage RequestHelper
 * @see RequestHelper_Boundaries
 */

declare(strict_types=1);

namespace AppUtils;

/**
 * Container for the collection of boundaries that will be 
 * sent in the request.
 *
 * @package Application Utils
 * @subpackage RequestHelper
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class RequestHelper_Boundaries
{
   /**
    * @var RequestHelper
    */
    protected $helper;

   /**
    * @var RequestHelper_Boundaries_Boundary[]
    */
    protected $boundaries = array();
    
   /**
    * @var integer
    */
    protected $contentLength = 0;
    
    public function __construct(RequestHelper $helper)
    {
        $this->helper = $helper;
    }
    
    public function getMimeBoundary() : string
    {
        return $this->helper->getMimeBoundary();
    }
    
    public function getEOL() : string
    {
        return $this->helper->getEOL();
    }
    
   /**
    * Retrieves the total content length of all boundaries.
    * @return int
    */
    public function getContentLength() : int
    {
        return $this->contentLength;
    }
    
   /**
    * Adds a file to be sent with the request.
    *
    * @param string $varName The variable name to send the file in
    * @param string $fileName The name of the file as it should be received at the destination
    * @param string $content The raw content of the file
    * @param string $contentType The content type, use the constants to specify this
    * @param string $encoding The encoding of the file, use the constants to specify this
    */
    public function addFile(string $varName, string $fileName, string $content, string $contentType = RequestHelper::FILETYPE_TEXT, string $encoding = RequestHelper::ENCODING_UTF8) : RequestHelper_Boundaries
    {
        $boundary = $this->createBoundary(chunk_split(base64_encode($content)))
        ->setName($varName)
        ->setFileName(basename($fileName))
        ->setContentType($contentType)
        ->setContentEncding($encoding);

The method setContentEncding() does not exist on AppUtils\RequestHelper_Boundaries_Boundary. Did you maybe mean setContentEncoding()?

        
        $this->addBoundary($boundary);

In this branch, the function will implicitly return null which is incompatible with the type-hinted return AppUtils\RequestHelper_Boundaries. Consider adding a return statement or allowing null as return value.

    }
    
   /**
    * Adds arbitrary content.
    *
    * @param string $varName
    * @param string $content
    * @param string $contentType
    */
    public function addContent(string $varName, string $content, string $contentType) : RequestHelper_Boundaries
    {
        $boundary = $this->createBoundary($content)
        ->setName($varName)
        ->setContentType($contentType)
        ->setContentEncoding(RequestHelper::ENCODING_UTF8);
        
        return $this->addBoundary($boundary);
    }
    
   /**
    * Adds a variable to be sent with the request. If it
    * already exists, its value is overwritten.
    *
    * @param string $name
    * @param string $value
    */
    public function addVariable(string $name, string $value) : RequestHelper_Boundaries
    {
        $boundary = $this->createBoundary($value)
        ->setName($name);
        
        return $this->addBoundary($boundary);
    }
    
    protected function addBoundary(RequestHelper_Boundaries_Boundary $boundary) : RequestHelper_Boundaries
    {
        $this->boundaries[] = $boundary;
        $this->contentLength += $boundary->getContentLength();
        
        return $this;
    }
    
    public function render() : string
    {
        $result = '';
        
        foreach($this->boundaries as $boundary)
        {
            $result .= $boundary->render();
        }
        
        $result .= "--" . $this->getMimeBoundary() . "--" . 
        $this->getEOL() . $this->getEOL(); // always finish with two eol's!!
        
        return $result;
    }
    
    protected function createBoundary(string $content) : RequestHelper_Boundaries_Boundary
    {
        return new RequestHelper_Boundaries_Boundary($this, $content);
    }
}