StockTakeHandler

This class contains the functions to perform the following:

- Insert Stock Take(s)
api
package simPROAPI
subpackage Inventory
author Nathan Muir
version 2011-07-18
todo May want to add retrieve functions for stock takes so they can be approved
todo May want to add update functions to alter the stock levels manually (if someone wanted a stock-gadget?)
todo complete function prototypes for this object

 Methods

StockTakeHandler

Complete(int $CompanyID, int $StockTakeID) : bool
StaticNot Implemented

Parameters

$CompanyID

int

the company id

$StockTakeID

int

marks a stock-take as complete/ approved

Returns

bool

StockTakeInsertComplete

Insert(int $CompanyID, bool $Complete, array $StockTakeDetails) : int
StaticNot Implemented
<?php
$StockTakeDetails = array(
   "DateIssued"=>"Y-m-d",
   "storageid"=>0,
   "Items"=>
           array(
               array(
                   "stockid"=>0,
                   "Quantity"=>0,
                   "Type"=>"add|subtract|total"
               )
               array(
                   "stockid"=>0,
                   "Quantity"=>0,
                   "Type"=>"add|subtract|total"
               )
           )

   );
?>
used_by \StockTakeHandler::InsertIncomplete()

Parameters

$CompanyID

int

the company id

$Complete

bool

whether or not the stock-take is complete

$StockTakeDetails

array

an associative array of stocktake information.

Returns

int

StockTakeInsertComplete

InsertComplete(int $CompanyID, array $StockTakeDetails) : int
StaticNot Implemented
<?php
$StockTakeDetails = array(
   "DateIssued"=>"Y-m-d",
   "storageid"=>0,
   "Items"=>
           array(
               array(
                   "stockid"=>0,
                   "Quantity"=>0,
                   "Type"=>"add|subtract|total"
               )
               array(
                   "stockid"=>0,
                   "Quantity"=>0,
                   "Type"=>"add|subtract|total"
               )
           )

   );
?>
uses \StockTakeHandler:Insert()

Parameters

$CompanyID

int

the company id

$StockTakeDetails

array

an associative array of stocktake information.

Returns

int

StockTakeInsertIncomplete

InsertIncomplete(int $CompanyID, array $StockTakeDetails) : int
StaticNot Implemented
<?php
$StockTakeDetails = array(
   "DateIssued"=>"Y-m-d",
   "storageid"=>0,
   "Items"=>
           array(
               array(
                   "stockid"=>0,
                   "Quantity"=>0,
                   "Type"=>"add|subtract|total"
               )
               array(
                   "stockid"=>0,
                   "Quantity"=>0,
                   "Type"=>"add|subtract|total"
               )
           )

   );
?>
uses \StockTakeHandler::Insert()

Parameters

$CompanyID

int

the company id

$StockTakeDetails

array

an associative array of stocktake information.

Returns

int