speckcommerce / SpeckCatalog

src/SpeckCatalog/Model/Spec/Relational.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
     protected $parent;
 
     /**
-     * @return parent
+     * @return AbstractModel
      */
     public function getParent()
     {

src/SpeckCatalog/Service/FormService.php

Doc Comments +8 added lines

@@ -10,6 +10,10 @@ 
 {
     protected $serviceLocator;
 
+    /**
+     * @param string $name
+     * @param \SpeckCatalog\Model\Product $model
+     */
     public function getForm($name = null, $model = null, $data = null)
     {
         $form = $this->formFromServiceManager($name);
@@ -38,6 +42,10 @@ 
         return $this->getServiceLocator()->get($filterName);
     }
 
+    /**
+     * @param string $name
+     * @param \SpeckCatalog\Model\Product $model
+     */
     public function getKeyFields($name, $model = null, $parentKeyFields = false)
     {
         $form = $this->formFromServiceManager($name);

src/SpeckCatalog/Service/FormServiceAwareInterface.php

Doc Comments +1 added lines

@@ -15,6 +15,7 @@
      * Set formService.
      *
      * @param formService the value to set.
+     * @return \SpeckCatalog\View\Helper\Form
      */
     public function setFormService($formService);
 }

src/SpeckCatalog/Service/Option.php

Doc Comments +7 added lines, -1 removed lines

@@ -34,6 +34,9 @@ 
         return $options;
     }
 
+    /**
+     * @param integer $productId
+     */
     public function getBuildersByProductId($productId)
     {
         $choices = $this->getEntityMapper()->getBuildersByProductId($productId);
@@ -130,6 +133,9 @@ 
         return true; //choice was found, and then deleted successfully
     }
 
+    /**
+     * @param integer $optionId
+     */
     public function sortChoices($optionId, array $order = array())
     {
         return $this->getEntityMapper()->sortChoices($optionId, $order);
@@ -189,7 +195,7 @@ 
     }
 
     /**
-     * @param $productService
+     * @param Product $productService
      * @return self
      */
     public function setProductService($productService)

src/SpeckCatalog/Service/Product.php

Doc Comments +7 added lines

@@ -196,6 +196,7 @@ 
     /**
      * store new sort order for product options
      * $order is array of position => optionId
+     * @param integer $productId
      */
     public function sortOptions($productId, array $order)
     {
@@ -241,6 +242,9 @@ 
         return $this->getEntityMapper()->removeSpec($productId, $specId);
     }
 
+    /**
+     * @param \SpeckCatalog\Model\Product $dataOrModel
+     */
     public function insert($dataOrModel)
     {
         $vars = array(
@@ -264,6 +268,9 @@ 
         //
     }
 
+    /**
+     * @param integer $categoryId
+     */
     public function getByCategoryId($categoryId)
     {
         return $this->getEntityMapper()->getByCategoryId($categoryId);

Spacing +2 added lines, -2 removed lines

@@ -185,8 +185,8 @@
 
     public function addOption($productOrId, $optionOrId)
     {
-        $productId = ( is_int($productOrId) ? $productOrId : $productOrId->getProductId() );
-        $optionId  = ( is_int($optionOrId)  ? $optionOrId  : $optionOrId->getOptionId() );
+        $productId = (is_int($productOrId) ? $productOrId : $productOrId->getProductId());
+        $optionId  = (is_int($optionOrId) ? $optionOrId : $optionOrId->getOptionId());
 
         $this->getEntityMapper()->addOption($productId, $optionId);
 

src/SpeckCatalog/Service/ProductUom.php

Doc Comments +3 added lines

@@ -11,6 +11,9 @@
     protected $uomService;
     protected $productService;
 
+    /**
+     * @param integer $productId
+     */
     public function getByProductId($productId, $populate = false, $recursive = false)
     {
         $productUoms = $this->getEntityMapper()->getByProductId($productId);

src/SpeckCatalog/Service/Spec.php

Doc Comments +6 added lines

@@ -15,11 +15,17 @@
         return $spec;
     }
 
+    /**
+     * @param integer $productId
+     */
     public function getByProductId($productId)
     {
         return $this->getEntityMapper()->getByProductId($productId);
     }
 
+    /**
+     * @param \SpeckCatalog\Model\Spec $spec
+     */
     public function insert($spec)
     {
         $id = parent::insert($spec);

src/SpeckCatalog/View/Helper/UomToCart.php

Doc Comments +3 added lines

@@ -262,6 +262,9 @@
         return $this;
     }
 
+    /**
+     * @param string $name
+     */
     public function getService($name)
     {
         if (!array_key_exists($name, $this->services)) {

Spacing +3 added lines, -3 removed lines

@@ -92,12 +92,12 @@ 
         //data needed to represent a uom to be displayed
         $data = array(
             'enabled'    => false,
-            'key'        => $uom->getUomCode().$uom->getQuantity(),
+            'key'        => $uom->getUomCode() . $uom->getQuantity(),
             'price'      => 'N/A',
             'name'       => $uom->getUom()->getName(),
             'code'       => $uom->getUomCode(),
             'quantity'   => $uom->getQuantity(),
-            'uom_string' => $uom->getUomCode().$uom->getQuantity(),
+            'uom_string' => $uom->getUomCode() . $uom->getQuantity(),
         );
         if ($enabled) {
             $data['enabled'] = true;
@@ -170,7 +170,7 @@ 
     public function renderMany($uoms, $uomString = null, $quantity = 1)
     {
         foreach ($uoms as $uom) {
-            $key= $uom['key'];
+            $key = $uom['key'];
             $options[$key] = array(
                 'value' => $key,
                 'label' => $this->getDisplayName($uom, true),

test/SpeckCatalogTest/Mapper/TestAsset/AbstractTestCase.php

Doc Comments +21 added lines

@@ -39,6 +39,9 @@ 
         return (int) $result->getGeneratedValue();
     }
 
+    /**
+     * @param integer $parentOptionId
+     */
     public function insertChoice($parentOptionId)
     {
         $mapper = $this->getTestMapper();
@@ -48,6 +51,11 @@ 
         return (int) $result->getGeneratedValue();
     }
 
+    /**
+     * @param integer $productId
+     * @param string $uomCode
+     * @param integer $quantity
+     */
     public function insertProductUom($productId, $uomCode, $quantity)
     {
         $productUom = array(
@@ -61,6 +69,12 @@ 
         $mapper->insert($productUom, 'catalog_product_uom');
     }
 
+    /**
+     * @param integer $productId
+     * @param string $uomCode
+     * @param integer $quantity
+     * @param integer $distributorId
+     */
     public function insertAvailability($productId, $uomCode, $quantity, $distributorId)
     {
         $availability = array(
@@ -74,6 +88,9 @@ 
         $mapper->insert($availability, 'catalog_availability');
     }
 
+    /**
+     * @param string $parentType
+     */
     public function insertImage($parentType, $parentId = 1)
     {
         $mapper = $this->getTestMapper();
@@ -108,6 +125,10 @@ 
         return (int) $result->getGeneratedValue();
     }
 
+    /**
+     * @param string $uomCode
+     * @param string $name
+     */
     public function insertUom($uomCode, $name)
     {
         $uom = array('uom_code' => $uomCode, 'name' => $name);