| Property | Type | Description | |
|---|---|---|---|
| $_params | |||
| $_stock | array | Variable holding the items in the inventory. |
| Method | Description | |
|---|---|---|
| __construct ( $params = [] ) | ||
| add ( array $stock ) : Sesha_Entity_Stock | This will add a new item to the inventory. | |
| addCategory ( array $info ) : integer | Adds a new category for classifying inventory. | |
| addProperty ( array $info ) : Sesha_Entity_Property | Adds a new property to the storage backend. | |
| categoryExists ( string $category ) : boolean | Determines if a category exists in the storage backend. | |
| clearPropertiesForCategory ( integer $category_id ) : integer | Removes all properties for a specified category. | |
| clearPropertiesForStock ( integer $stock_id, array $categories = [] ) : integer | Removes categories from a particular stock item. | |
| delete ( integer $stock_id ) : boolean | Removes a stock entry from the backend. Also removes all related category and property information. | |
| deleteCategory ( integer $category_id ) : integer | Deletes a category. | |
| deleteProperty ( integer $property_id ) : integer | Deletes a property from the storage backend. | |
| fetch ( integer $stock_id ) : Sesha_Entity_Stock | This function retrieves a single stock item from the backend. | |
| findStock ( $filters = [] ) : array | Inventory search | |
| getCategories ( integer $stock_id = null, array $category_ids = null ) : array | This function returns all the categories matching an id or category list. | |
| getCategory ( integer | array $category_id ) : Sesha_Entity_Category | This will return the category found matching a specific id. | |
| getProperties ( array $property_ids = [] ) : array | This will find all the available properties matching a specified IDs. | |
| getPropertiesForCategories ( array $categories = [] ) : mixed | This will return a set of properties for a set of specified categories. | |
| getPropertiesForStock ( integer $stock_id ) : array | Returns a set of properties for a particular stock ID number. | |
| getProperty ( integer $property_id ) : mixed | Finds the first matching property for a specified property ID. | |
| getValuesForStock ( integer $stock_id ) : array | Returns a set of Value Objects for a particular stock ID number. | |
| modify ( $stock_id, array $stock ) : boolean | This function will modify a pre-existing stock entry with new values. | |
| setPropertiesForCategory ( integer $category_id, array $properties = [] ) | Updates a category with a set of properties. | |
| updateCategoriesForStock ( integer $stock_id, array $categories = [] ) | Updates the set of categories for a specified stock item. | |
| updateCategory ( array $info ) : integer | Updates the attributes stored by a category. | |
| updatePropertiesForStock ( integer $stock_id, array $properties = [] ) | Updates the set of properties for a particular stock item. | |
| updateProperty ( array $info ) : Sesha_Inventory_Property | Updates a property with new attributes. |
| abstract public addCategory ( array $info ) : integer | ||
| $info | array | The new category's attributes. |
| return | integer | The ID of the new of the category on success |
| abstract public addProperty ( array $info ) : Sesha_Entity_Property | ||
| $info | array | Array with new property values. |
| return | Sesha_Entity_Property | |
| abstract public categoryExists ( string $category ) : boolean | ||
| $category | string | The string representation of the category to find. |
| return | boolean | True on success; false otherwise. |
| abstract public clearPropertiesForCategory ( integer $category_id ) : integer | ||
| $category_id | integer | The numeric ID of the category to update. |
| return | integer | The number of deleted properties |
| abstract public deleteCategory ( integer $category_id ) : integer | ||
| $category_id | integer | The numeric ID of the category to delete. Also accepts Sesha_Entity_Category |
| return | integer | The number of categories deleted |
| abstract public deleteProperty ( integer $property_id ) : integer | ||
| $property_id | integer | The numeric ID of the property to delete. Also accepts a Sesha_Inventory_Property object |
| return | integer | Number of objects deleted. |
| abstract public getCategories ( integer $stock_id = null, array $category_ids = null ) : array | ||
| $stock_id | integer | The stock ID of categories to fetch. Overrides category_ids |
| $category_ids | array | The numeric IDs of the categories to find. If both $stock_id and $category_ids are null, all categories are returned |
| return | array | The list of matching categories |
| abstract public getCategory ( integer | array $category_id ) : Sesha_Entity_Category | ||
| $category_id | integer | array | The integer ID or key => value hash of the category to find. |
| return | Sesha_Entity_Category | The category on success |
| abstract public getProperties ( array $property_ids = [] ) : array | ||
| $property_ids | array | The numeric ID of properties to find. Matches all properties when null. |
| return | array | matching properties on success |
| abstract public getPropertiesForCategories ( array $categories = [] ) : mixed | ||
| $categories | array | The set of categories to fetch properties. |
| return | mixed | An array of properties on success |
| abstract public getPropertiesForStock ( integer $stock_id ) : array | ||
| $stock_id | integer | The numeric ID of the stock to find the properties for. |
| return | array | of Sesha_Inventory_Property objects |
| abstract public getProperty ( integer $property_id ) : mixed | ||
| $property_id | integer | The numeric ID of properties to find. |
| return | mixed | The specified property on success |
| abstract public getValuesForStock ( integer $stock_id ) : array | ||
| $stock_id | integer | The numeric ID of the stock to find the properties for. You can also pass a Sesha_Entity_Stock item |
| return | array | the list of Sesha_Entity_Value objects |
| abstract public setPropertiesForCategory ( integer $category_id, array $properties = [] ) | ||
| $category_id | integer | The numeric ID of the category to update. |
| $properties | array | An array of property ID's to add. |
| abstract public updateCategoriesForStock ( integer $stock_id, array $categories = [] ) | ||
| $stock_id | integer | The numeric stock ID to update. |
| $categories | array | The array of categories to change. |
| abstract public updateCategory ( array $info ) : integer | ||
| $info | array | Updated category attributes. |
| return | integer | Number of objects updated. |
| abstract public updatePropertiesForStock ( integer $stock_id, array $properties = [] ) | ||
| $stock_id | integer | The numeric ID of the stock to update. |
| $properties | array | The hash of properties to update. |
| abstract public updateProperty ( array $info ) : Sesha_Inventory_Property | ||
| $info | array | Array with updated property values. |
| return | Sesha_Inventory_Property | The changed Sesha_Inventory_Property object. |
| protected array $_stock | ||
| return | array | |