1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Catalog
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: /**
 28:  * Catalog product attribute set api
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Catalog
 32:  * @author     Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Catalog_Model_Product_Attribute_Set_Api extends Mage_Api_Model_Resource_Abstract
 35: {
 36:     /**
 37:      * Retrieve attribute set list
 38:      *
 39:      * @return array
 40:      */
 41:     public function items()
 42:     {
 43:         $entityType = Mage::getModel('catalog/product')->getResource()->getEntityType();
 44:         $collection = Mage::getResourceModel('eav/entity_attribute_set_collection')
 45:             ->setEntityTypeFilter($entityType->getId());
 46: 
 47:         $result = array();
 48:         foreach ($collection as $attributeSet) {
 49:             $result[] = array(
 50:                 'set_id' => $attributeSet->getId(),
 51:                 'name'   => $attributeSet->getAttributeSetName()
 52:             );
 53: 
 54:         }
 55: 
 56:         return $result;
 57:     }
 58: 
 59:     /**
 60:      * Create new attribute set based on another set
 61:      *
 62:      * @param string $attributeSetName
 63:      * @param string $skeletonSetId
 64:      * @return integer
 65:      */
 66:     public function create($attributeSetName, $skeletonSetId)
 67:     {
 68:         // check if set with requested $skeletonSetId exists
 69:         if (!Mage::getModel('eav/entity_attribute_set')->load($skeletonSetId)->getId()){
 70:             $this->_fault('invalid_skeleton_set_id');
 71:         }
 72:         // get catalog product entity type id
 73:         $entityTypeId = Mage::getModel('catalog/product')->getResource()->getTypeId();
 74:         /** @var $attributeSet Mage_Eav_Model_Entity_Attribute_Set */
 75:         $attributeSet = Mage::getModel('eav/entity_attribute_set')
 76:                 ->setEntityTypeId($entityTypeId)
 77:                 ->setAttributeSetName($attributeSetName);
 78:         try {
 79:             // check if name is valid
 80:             $attributeSet->validate();
 81:             // copy parameters to new set from skeleton set
 82:             $attributeSet->save();
 83:             $attributeSet->initFromSkeleton($skeletonSetId)->save();
 84:         } catch (Mage_Eav_Exception $e) {
 85:             $this->_fault('invalid_data', $e->getMessage());
 86:         } catch (Exception $e) {
 87:             $this->_fault('create_attribute_set_error', $e->getMessage());
 88:         }
 89:         return (int)$attributeSet->getId();
 90:     }
 91: 
 92:     /**
 93:      * Remove attribute set
 94:      *
 95:      * @param string $attributeSetId
 96:      * @param bool $forceProductsRemove
 97:      * @return bool
 98:      */
 99:     public function remove($attributeSetId, $forceProductsRemove = false)
100:     {
101:         // if attribute set has related goods and $forceProductsRemove is not set throw exception
102:         if (!$forceProductsRemove) {
103:             /** @var $catalogProductsCollection Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection */
104:             $catalogProductsCollection = Mage::getModel('catalog/product')->getCollection()
105:                     ->addFieldToFilter('attribute_set_id', $attributeSetId);
106:             if (count($catalogProductsCollection)) {
107:                 $this->_fault('attribute_set_has_related_products');
108:             }
109:         }
110:         $attributeSet = Mage::getModel('eav/entity_attribute_set')->load($attributeSetId);
111:         // check if set with requested id exists
112:         if (!$attributeSet->getId()){
113:             $this->_fault('invalid_attribute_set_id');
114:         }
115:         try {
116:             $attributeSet->delete();
117:         } catch (Exception $e) {
118:             $this->_fault('remove_attribute_set_error', $e->getMessage());
119:         }
120:         return true;
121:     }
122: 
123:     /**
124:      * Add attribute to attribute set
125:      *
126:      * @param string $attributeId
127:      * @param string $attributeSetId
128:      * @param string|null $attributeGroupId
129:      * @param string $sortOrder
130:      * @return bool
131:      */
132:     public function attributeAdd($attributeId, $attributeSetId, $attributeGroupId = null, $sortOrder = '0')
133:     {
134:         // check if attribute with requested id exists
135:         /** @var $attribute Mage_Eav_Model_Entity_Attribute */
136:         $attribute = Mage::getModel('eav/entity_attribute')->load($attributeId);
137:         if (!$attribute->getId()) {
138:             $this->_fault('invalid_attribute_id');
139:         }
140:         // check if attribute set with requested id exists
141:         /** @var $attributeSet Mage_Eav_Model_Entity_Attribute_Set */
142:         $attributeSet = Mage::getModel('eav/entity_attribute_set')->load($attributeSetId);
143:         if (!$attributeSet->getId()) {
144:             $this->_fault('invalid_attribute_set_id');
145:         }
146:         if (!empty($attributeGroupId)) {
147:             // check if attribute group with requested id exists
148:             if (!Mage::getModel('eav/entity_attribute_group')->load($attributeGroupId)->getId()) {
149:                 $this->_fault('invalid_attribute_group_id');
150:             }
151:         } else {
152:             // define default attribute group id for current attribute set
153:             $attributeGroupId = $attributeSet->getDefaultGroupId();
154:         }
155:         $attribute->setAttributeSetId($attributeSet->getId())->loadEntityAttributeIdBySet();
156:         if ($attribute->getEntityAttributeId()) {
157:             $this->_fault('attribute_is_already_in_set');
158:         }
159:         try {
160:            $attribute->setEntityTypeId($attributeSet->getEntityTypeId())
161:                     ->setAttributeSetId($attributeSetId)
162:                     ->setAttributeGroupId($attributeGroupId)
163:                     ->setSortOrder($sortOrder)
164:                     ->save();
165:         } catch (Exception $e) {
166:             $this->_fault('add_attribute_error', $e->getMessage());
167:         }
168:         return true;
169:     }
170: 
171:     /**
172:      * Remove attribute from attribute set
173:      *
174:      * @param string $attributeId
175:      * @param string $attributeSetId
176:      * @return bool
177:      */
178:     public function attributeRemove($attributeId, $attributeSetId)
179:     {
180:         // check if attribute with requested id exists
181:         /** @var $attribute Mage_Eav_Model_Entity_Attribute */
182:         $attribute = Mage::getModel('eav/entity_attribute')->load($attributeId);
183:         if (!$attribute->getId()) {
184:             $this->_fault('invalid_attribute_id');
185:         }
186:         // check if attribute set with requested id exists
187:         /** @var $attributeSet Mage_Eav_Model_Entity_Attribute_Set */
188:         $attributeSet = Mage::getModel('eav/entity_attribute_set')->load($attributeSetId);
189:         if (!$attributeSet->getId()) {
190:             $this->_fault('invalid_attribute_set_id');
191:         }
192:         // check if attribute is in set
193:         $attribute->setAttributeSetId($attributeSet->getId())->loadEntityAttributeIdBySet();
194:         if (!$attribute->getEntityAttributeId()) {
195:             $this->_fault('attribute_is_not_in_set');
196:         }
197:         try {
198:             // delete record from eav_entity_attribute
199:             // using entity_attribute_id loaded by loadEntityAttributeIdBySet()
200:             $attribute->deleteEntity();
201:         } catch (Exception $e) {
202:             $this->_fault('remove_attribute_error', $e->getMessage());
203:         }
204: 
205:         return true;
206:     }
207: 
208:     /**
209:      * Create group within existing attribute set
210:      *
211:      * @param  string|int $attributeSetId
212:      * @param  string $groupName
213:      * @return int
214:      */
215:     public function groupAdd($attributeSetId, $groupName)
216:     {
217:         /** @var $group Mage_Eav_Model_Entity_Attribute_Group */
218:         $group = Mage::getModel('eav/entity_attribute_group');
219:         $group->setAttributeSetId($attributeSetId)
220:                 ->setAttributeGroupName(
221:                     Mage::helper('catalog')->stripTags($groupName)
222:                 );
223:         if ($group->itemExists()) {
224:             $this->_fault('group_already_exists');
225:         }
226:         try {
227:             $group->save();
228:         } catch (Exception $e) {
229:             $this->_fault('group_add_error', $e->getMessage());
230:         }
231:         return (int)$group->getId();
232:     }
233: 
234:     /**
235:      * Rename existing group
236:      *
237:      * @param string|int $groupId
238:      * @param string $groupName
239:      * @return boolean
240:      */
241:     public function groupRename($groupId, $groupName)
242:     {
243:         $model = Mage::getModel('eav/entity_attribute_group')->load($groupId);
244: 
245:         if (!$model->getAttributeGroupName()) {
246:             $this->_fault('invalid_attribute_group_id');
247:         }
248: 
249:         $model->setAttributeGroupName(
250:                 Mage::helper('catalog')->stripTags($groupName)
251:         );
252:         try {
253:             $model->save();
254:         } catch (Exception $e) {
255:             $this->_fault('group_rename_error', $e->getMessage());
256:         }
257:         return true;
258:     }
259: 
260:     /**
261:         * Remove group from existing attribute set
262:         *
263:         * @param  string|int $attributeGroupId
264:         * @return bool
265:         */
266:        public function groupRemove($attributeGroupId)
267:        {
268:            /** @var $group Mage_Catalog_Model_Product_Attribute_Group */
269:            $group = Mage::getModel('catalog/product_attribute_group')->load($attributeGroupId);
270:            if (!$group->getId()) {
271:                $this->_fault('invalid_attribute_group_id');
272:            }
273:            if ($group->hasConfigurableAttributes()) {
274:                $this->_fault('group_has_configurable_attributes');
275:            }
276:            if ($group->hasSystemAttributes()) {
277:                $this->_fault('group_has_system_attributes');
278:            }
279:            try {
280:                $group->delete();
281:            } catch (Exception $e) {
282:                $this->_fault('group_remove_error', $e->getMessage());
283:            }
284:            return true;
285:        }
286: 
287: } // Class Mage_Catalog_Model_Product_Attribute_Set_Api End
288: