php-bitpay-client/src/Bitpay/ItemInterface.php
2014-09-19 15:25:40 -04:00

70 lines
2.0 KiB
PHP

<?php
/**
* The MIT License (MIT)
*
* Copyright (c) 2014 BitPay, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
namespace Bitpay;
/**
* Item that was sold
*
* @package Bitpay
*/
interface ItemInterface
{
/**
* Used to display an item SKU code or part number to the buyer. Maximum string
* length is 100 characters.
*
* @return string
*/
public function getCode();
/**
* Used to display an item description to the buyer. Maximum string length is 100
* characters.
*
* @return string
*/
public function getDescription();
/**
* @return string
*/
public function getPrice();
/**
* @return string
*/
public function getQuantity();
/**
* default value: false
* ● true: Indicates a physical item will be shipped (or picked up)
* ● false: Indicates that nothing is to be shipped for this order
*
* @return boolean
*/
public function isPhysical();
}