<?php
/**
* @brief Shipments API
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
* @package Invision Community
* @subpackage Nexus
* @since 10 Dec 2015
*/
namespace IPS\nexus\api;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* @brief Shipments API
*/
class _shipments extends \IPS\Api\Controller
{
/**
* GET /nexus/shipments
* Get list of shipments
*
* @note For requests using an OAuth Access Token for a particular member, only the members own shipments will be included
* @apiparam string statuses Comma-delimited list of statuses - if provided, only transactions with those statuses are returned - see order object for status keys
* @apiparam string methods Comma-delimited list of shipping method IDs - if provided, only shipments from those methods are returned
* @apiparam string sortBy What to sort by. Can be 'date', 'shipped_date' or do not specify for ID
* @apiparam string sortDir Sort direction. Can be 'asc' or 'desc' - defaults to 'asc'
* @apiparam int page Page number
* @apiparam int perPage Number of results per page - defaults to 25
* @return \IPS\Api\PaginatedResponse<IPS\nexus\Shipping\Order>
*/
public function GETindex()
{
/* Where clause */
$where = array();
/* Statuses */
if ( isset( \IPS\Request::i()->statuses ) )
{
$where[] = array( \IPS\Db::i()->in( 'o_status', array_filter( explode( ',', \IPS\Request::i()->statuses ) ) ) );
}
/* Methods */
if ( isset( \IPS\Request::i()->methods ) )
{
$where[] = array( \IPS\Db::i()->in( 'o_method', array_filter( explode( ',', \IPS\Request::i()->methods ) ) ) );
}
/* Permission */
if ( $this->member )
{
$where[] = array( \IPS\Db::i()->in( 'o_invoice', iterator_to_array( \IPS\Db::i()->select( 'i_id', 'nexus_invoices', array( 'i_member=?', $this->member->member_id ) ) ) ) );
}
/* Sort */
if ( isset( \IPS\Request::i()->sortBy ) and in_array( \IPS\Request::i()->sortBy, array( 'date', 'shipped_date' ) ) )
{
$sortBy = 'o_' . \IPS\Request::i()->sortBy;
}
else
{
$sortBy = 'o_id';
}
$sortDir = ( isset( \IPS\Request::i()->sortDir ) and in_array( mb_strtolower( \IPS\Request::i()->sortDir ), array( 'asc', 'desc' ) ) ) ? \IPS\Request::i()->sortDir : 'asc';
/* Return */
return new \IPS\Api\PaginatedResponse(
200,
\IPS\Db::i()->select( '*', 'nexus_ship_orders', $where, "{$sortBy} {$sortDir}" ),
isset( \IPS\Request::i()->page ) ? \IPS\Request::i()->page : 1,
'IPS\nexus\Shipping\Order',
\IPS\Db::i()->select( 'COUNT(*)', 'nexus_ship_orders', $where )->first(),
$this->member,
isset( \IPS\Request::i()->perPage ) ? \IPS\Request::i()->perPage : NULL
);
}
/**
* GET /nexus/shipments/{id}
* Get information about a specific shipment
*
* @param int $id ID Number
* @throws 2X307/1 INVALID_ID The shipment ID does not exist or the authorized user does not have permission to view it
* @return \IPS\nexus\Shipping\Order
*/
public function GETitem( $id )
{
try
{
$shipment = \IPS\nexus\Shipping\Order::load( $id );
if ( $this->member and !$shipment->invoice->canView( $this->member ) )
{
throw new \OutOfRangeException;
}
return new \IPS\Api\Response( 200, $shipment->apiOutput( $this->member ) );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2X308/1', 404 );
}
}
}