PHP Class Sesha_Driver_Rdo, horde

Required values for $params:

     'db'       The Horde_Db adapter

Copyright 2003-2016 Horde LLC (http://www.horde.org/)
Based on the original Sql driver
Copyright 2004-2007 Andrew Coleman 

See the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.horde.org/licenses/gpl.

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                                    
    
        Author:
        
            Bo Daley                            ([email protected])
                    
    
                                    
    
        Author:
        
            Andrew Coleman                            ([email protected])
                    
    
                                    
    
        Author:
        
            Ralf Lang                            ([email protected])
                    
    
                            
            


            
            Inheritance:
            
                                                    extends Sesha_Driver                                
        
    
            
                Datei anzeigen            

            
                Open project: horde/horde            

            
            
                            Protected Properties

    
        Property
        Type
        Description
        
    
            
    $_db
    DB
    Handle for the database connection.
    
    




            
    $_mappers
    Horde_Rdo_Factory
    The mapper factory
    
    




    

            
            
                            Public Methods

    
        Method
        Description
        
    
            
    
        __construct ( array $params = [] )    
    
        This is the basic constructor for the Rdo driver.    
    
            
    
    


            
    
        add ( array $stock ) : Sesha_Entity_Stock    
    
        This will add a new item to the inventory.    
    
            
    
    


            
    
        addCategory ( array $info ) : Sesha_Entity_Category    
    
        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 database. 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 database.    
    
            
    
    


            
    
        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.    
    
            
    
    


    
            
            
            
                                        Method Details
                                    
            
            
                
                    __construct()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            This is the basic constructor for the Rdo driver.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  __construct ( array $params = [] )                    
                
                                                        
                        
                                                            $params                                                    
                        array
                        Hash containing the connection parameters.
                    
                                                            
        
    
                                    
            
            
                
                    add()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            This will add a new item to the inventory.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  add ( array $stock ) : Sesha_Entity_Stock                    
                
                                                        
                        
                                                            $stock                                                    
                        array
                        A hash of values for the stock item.
                    
                                                                    
                        return
                        Sesha_Entity_Stock
                        The newly added item or false.
                    
                            
        
    
                                    
            
            
                
                    addCategory()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Adds a new category for classifying inventory.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  addCategory ( array $info ) : Sesha_Entity_Category                    
                
                                                        
                        
                                                            $info                                                    
                        array
                        The new category's attributes.
                    
                                                                    
                        return
                        Sesha_Entity_Category
                        The category on success
                    
                            
        
    
                                    
            
            
                
                    addProperty()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Adds a new property to the storage backend.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  addProperty ( array $info ) : Sesha_Entity_Property                    
                
                                                        
                        
                                                            $info                                                    
                        array
                        Array with new property values.
                    
                                                                    
                        return
                        Sesha_Entity_Property
                        
                    
                            
        
    
                                    
            
            
                
                    categoryExists()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Determines if a category exists in the storage backend.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  categoryExists ( string $category ) : boolean                    
                
                                                        
                        
                                                            $category                                                    
                        string
                        The string representation of the category to
find.
                    
                                                                    
                        return
                        boolean
                        True on success; false otherwise.
                    
                            
        
    
                                    
            
            
                
                    clearPropertiesForCategory()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Removes all properties for a specified category.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  clearPropertiesForCategory ( integer $category_id ) : integer                    
                
                                                        
                        
                                                            $category_id                                                    
                        integer
                        The numeric ID of the category to update.
                    
                                                                    
                        return
                        integer
                        The number of deleted properties
                    
                            
        
    
                                    
            
            
                
                    clearPropertiesForStock()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Removes categories from a particular stock item.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  clearPropertiesForStock ( integer $stock_id, array $categories = [] ) : integer                    
                
                                                        
                        
                                                            $stock_id                                                    
                        integer
                        The numeric ID of the stock item to update.
                    
                                                                        
                        
                                                            $categories                                                    
                        array
                        The array of categories to remove.
                    
                                                                    
                        return
                        integer
                        the number of categories removed
                    
                            
        
    
                                    
            
            
                
                    delete()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Removes a stock entry from the database. Also removes all related
category and property information.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  delete ( integer $stock_id ) : boolean                    
                
                                                        
                        
                                                            $stock_id                                                    
                        integer
                        The ID of the item to delete.
                    
                                                                    
                        return
                        boolean
                        True on success
                    
                            
        
    
                                    
            
            
                
                    deleteCategory()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Deletes a category.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        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
                    
                            
        
    
                                    
            
            
                
                    deleteProperty()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Deletes a property from the storage backend.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        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.
                    
                            
        
    
                                    
            
            
                
                    fetch()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            This function retrieves a single stock item from the database.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  fetch ( integer $stock_id ) : Sesha_Entity_Stock                    
                
                                                        
                        
                                                            $stock_id                                                    
                        integer
                        The numeric ID of the stock item to fetch.
                    
                                                                    
                        return
                        Sesha_Entity_Stock
                        a stock item
                    
                            
        
    
                                    
            
            
                
                    findStock()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Inventory search        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  findStock ( $filters = [] ) : array                    
                
                                                                                        
                        return
                        array
                        List of Stock items
                    
                            
        
    
                                    
            
            
                
                    getCategories()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            This function returns all the categories matching an id or category list.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        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
                    
                            
        
    
                                    
            
            
                
                    getCategory()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            This will return the category found matching a specific id.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        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
                    
                            
        
    
                                    
            
            
                
                    getProperties()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            This will find all the available properties matching a specified IDs.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        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
                    
                            
        
    
                                    
            
            
                
                    getPropertiesForCategories()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            This will return a set of properties for a set of specified categories.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  getPropertiesForCategories ( array $categories = [] ) : mixed                    
                
                                                        
                        
                                                            $categories                                                    
                        array
                        The set of categories to fetch properties.
                    
                                                                    
                        return
                        mixed
                        An array of properties on success
                    
                            
        
    
                                    
            
            
                
                    getPropertiesForStock()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Returns a set of properties for a particular stock ID number.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        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
                    
                            
        
    
                                    
            
            
                
                    getProperty()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Finds the first matching property for a specified property ID.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  getProperty ( integer $property_id ) : mixed                    
                
                                                        
                        
                                                            $property_id                                                    
                        integer
                        The numeric ID of properties to find.
                    
                                                                    
                        return
                        mixed
                        The specified property on success
                    
                            
        
    
                                    
            
            
                
                    getValuesForStock()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Returns a set of Value Objects for a particular stock ID number.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        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
                    
                            
        
    
                                    
            
            
                
                    modify()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            This function will modify a pre-existing stock entry with new values.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  modify ( $stock_id, array $stock ) : boolean                    
                
                                                                                            
                        
                                                            $stock                                                    
                        array
                        The hash of values for the inventory item.
                    
                                                                    
                        return
                        boolean
                        True on success.
                    
                            
        
    
                                    
            
            
                
                    setPropertiesForCategory()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Updates a category with a set of properties.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        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.
                    
                                                            
        
    
                                    
            
            
                
                    updateCategoriesForStock()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Updates the set of categories for a specified stock item.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  updateCategoriesForStock ( integer $stock_id, array $categories = [] )                    
                
                                                        
                        
                                                            $stock_id                                                    
                        integer
                        The numeric stock ID to update.
                    
                                                                        
                        
                                                            $categories                                                    
                        array
                        The array of categories to change.
                    
                                                            
        
    
                                    
            
            
                
                    updateCategory()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Updates the attributes stored by a category.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  updateCategory ( array $info ) : integer                    
                
                                                        
                        
                                                            $info                                                    
                        array
                        Updated category attributes.
                    
                                                                    
                        return
                        integer
                        Number of objects updated.
                    
                            
        
    
                                    
            
            
                
                    updatePropertiesForStock()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Updates the set of properties for a particular stock item.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        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.
                    
                                                            
        
    
                                    
            
            
                
                    updateProperty()
                    public                     method
                
            
            
                    
    
            
        
    
    
        
            Updates a property with new attributes.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            


    
        
            
                
                    
                        public  updateProperty ( array $info ) : Sesha_Inventory_Property                    
                
                                                        
                        
                                                            $info                                                    
                        array
                        Array with updated property values.
                    
                                                                    
                        return
                        Sesha_Inventory_Property
                        The changed Sesha_Inventory_Property object.
                    
                            
        
    
                                                        Property Details

                                    
    
        
            $_db                protected_oe property
            
        
        
            
    


        
    
    
        
            Handle for the database connection.        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            

    
        
            
                
                
                    
                        protected  DB $_db                    
                
                                    
                        return
                        DB
                        
                    
                            
        
    

                                    
    
        
            $_mappers                protected_oe property
            
        
        
            
    


        
    
    
        
            The mapper factory        
    
    

    
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
                    
                            
            

    
        
            
                
                
                    
                        protected  Horde_Rdo_Factory $_mappers                    
                
                                    
                        return
                        Horde_Rdo_Factory

Property	Type	Description
$_db	DB	Handle for the database connection.
$_mappers	Horde_Rdo_Factory	The mapper factory

Method	Description
__construct ( array $params = [] )	This is the basic constructor for the Rdo driver.
add ( array $stock ) : Sesha_Entity_Stock	This will add a new item to the inventory.
addCategory ( array $info ) : Sesha_Entity_Category	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 database. 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 database.
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.

public __construct ( array $params = [] )
$params	array	Hash containing the connection parameters.

public add ( array $stock ) : Sesha_Entity_Stock
$stock	array	A hash of values for the stock item.
return	Sesha_Entity_Stock	The newly added item or false.

public addCategory ( array $info ) : Sesha_Entity_Category
$info	array	The new category's attributes.
return	Sesha_Entity_Category	The category on success

public addProperty ( array $info ) : Sesha_Entity_Property
$info	array	Array with new property values.
return	Sesha_Entity_Property

public categoryExists ( string $category ) : boolean
$category	string	The string representation of the category to find.
return	boolean	True on success; false otherwise.

public clearPropertiesForCategory ( integer $category_id ) : integer
$category_id	integer	The numeric ID of the category to update.
return	integer	The number of deleted properties

public clearPropertiesForStock ( integer $stock_id, array $categories = [] ) : integer
$stock_id	integer	The numeric ID of the stock item to update.
$categories	array	The array of categories to remove.
return	integer	the number of categories removed

public delete ( integer $stock_id ) : boolean
$stock_id	integer	The ID of the item to delete.
return	boolean	True on success

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

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.

public fetch ( integer $stock_id ) : Sesha_Entity_Stock
$stock_id	integer	The numeric ID of the stock item to fetch.
return	Sesha_Entity_Stock	a stock item

public findStock ( $filters = [] ) : array
return	array	List of Stock items

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

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

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

public getPropertiesForCategories ( array $categories = [] ) : mixed
$categories	array	The set of categories to fetch properties.
return	mixed	An array of properties on success

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

public getProperty ( integer $property_id ) : mixed
$property_id	integer	The numeric ID of properties to find.
return	mixed	The specified property on success

PHP Class Sesha_Driver_Rdo, horde

Protected Properties

Public Methods

Method Details

__construct() public method

add() public method

addCategory() public method

addProperty() public method

categoryExists() public method

clearPropertiesForCategory() public method

clearPropertiesForStock() public method

delete() public method

deleteCategory() public method

deleteProperty() public method

fetch() public method

findStock() public method

getCategories() public method

getCategory() public method

getProperties() public method

getPropertiesForCategories() public method

getPropertiesForStock() public method

getProperty() public method

getValuesForStock() public method

modify() public method

setPropertiesForCategory() public method

updateCategoriesForStock() public method

updateCategory() public method

updatePropertiesForStock() public method

updateProperty() public method

Property Details

$_db protected_oe property

$_mappers protected_oe property

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

public modify ( $stock_id, array $stock ) : boolean
$stock	array	The hash of values for the inventory item.
return	boolean	True on success.

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.

public updateCategoriesForStock ( integer $stock_id, array $categories = [] )
$stock_id	integer	The numeric stock ID to update.
$categories	array	The array of categories to change.

public updateCategory ( array $info ) : integer
$info	array	Updated category attributes.
return	integer	Number of objects updated.

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.

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 Horde_Rdo_Factory $_mappers
return	Horde_Rdo_Factory