Bpost\BpostApiClient\Bpost\Order\Box\IBox

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
	setOptions()	0	1	?
	getOptions()	0	1	?
	addOption()	0	1	?
	setProduct()	0	1	?
	getProduct()	0	1	?
	getPossibleProductValues()	0	1	?
	toXML()	0	1	?
	createFromXML()	0	1	?

<?php

namespace Bpost\BpostApiClient\Bpost\Order\Box;

/**
 * Interface IBox
 * @package Bpost\BpostApiClient\Bpost\Order\Box
 */
interface IBox
{

    /**
     * @param array $options
     */
    public function setOptions($options);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * @return array
     */
    public function getOptions();

    /**
     * @param \Bpost\BpostApiClient\Bpost\Order\Box\Option\Option $option
     */
    public function addOption(Option\Option $option);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * @param string $product
     */
    public function setProduct($product);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * @return string
     */
    public function getProduct();

    /**
     * @remark should be implemented by the child class
     * @return array
     */
    public static function getPossibleProductValues();

    /**
     * Return the object as an array for usage in the XML
     * @param  \DomDocument $document
     * @param  string $prefix

Should the type for parameter $prefix not be string|null?

     * @return \DomElement
     */
    public function toXML(\DOMDocument $document, $prefix = null);

    /**
     * @param  \SimpleXMLElement $xml
     * @return self
     */
    public static function createFromXML(\SimpleXMLElement $xml);
}