Magento: Create or Update CMS Page & Static Block, Core Configuration, Product and Category information via Upgrade Scripts.

Why are upgrade scripts helpful

Running the upgrade scripts will automatically update the database when deploying your site to staging and production servers by hitting the url. This can help you to avoid manual setup changes in admin panel when releasing sites to different servers. It also helps us to keep track of all the changes we trigger in admin panel.

To run upgrade script, you need to create a custom module. Download full module from our github

In your module you create a file data-install-0.1.0.php

Update System Configuration:


$installer = $this;
$installer->startSetup();  

$store = Mage::app()->getStore('default');      

$conf = new Mage_Core_Model_Config();
$address = 'Address Text Here';
$conf->saveConfig('general/store_information/address', $address, 'default', 0);

$installer->endSetup();

$installer = $this;

$installer->startSetup();

$store = Mage::app()->getStore('default');

$conf = new Mage_Core_Model_Config();

$address = 'Address Text Here';

$conf->saveConfig('general/store_information/address', $address, 'default', 0);

$installer->endSetup();

CMS Static Blocks create or upgrade:


$store = Mage::app()->getStore('default');         
$data = array(
    'title' => 'Header Banner',
    'identifier' => 'header-banner-id',
    'stores' => array(0), // Array with store ID's
    'content' => '<p>Some HTML content for banner</p>',
    'is_active' => 1
);

// Check if static block already exists, if yes then update content
$block = Mage::getModel('cms/block')->load($data['identifier']);
if ($block->isObjectNew()) {
    //Create static block
    Mage::getModel('cms/block')->setData($data)->save();
}else{
    //Update Content
    $block->setData('content', $data['content'])->save();
}

$store = Mage::app()->getStore('default');

$data = array(

'title' => 'Header Banner',

'identifier' => 'header-banner-id',

'stores' => array(0), // Array with store ID's

'content' => '<p>Some HTML content for banner</p>',

'is_active' => 1

);

// Check if static block already exists, if yes then update content

$block = Mage::getModel('cms/block')->load($data['identifier']);

if ($block->isObjectNew()) {

//Create static block

Mage::getModel('cms/block')->setData($data)->save();

}else{

//Update Content

$block->setData('content', $data['content'])->save();

}

CMS Page Create or Upgrade:


$store = Mage::app()->getStore('default');         
$page = Mage::getModel('cms/page');
$page->setStoreId($store->getId());
$page->load('home', 'identifier');

$content=<<<EOT
    <div>page content here</div>
EOT;

$cmsPage = Array(
    'title' => 'Home Title',
    'identifier' => 'home',
    'content' => $content,
    'is_active' => 1,
    'stores' => array($store->getId())
);
if ($page->getId()) {
    $page->setContent($cmsPage ['content']);
    $page->setTitle($cmsPage ['title']);
    $page->save();
} else {
    Mage::getModel('cms/page')->setData($cmsPage)->save();
}

$store = Mage::app()->getStore('default');

$page = Mage::getModel('cms/page');

$page->setStoreId($store->getId());

$page->load('home', 'identifier');

$content=<<<EOT

<div>page content here</div>

EOT;

$cmsPage = Array(

'title' => 'Home Title',

'identifier' => 'home',

'content' => $content,

'is_active' => 1,

'stores' => array($store->getId())

);

if ($page->getId()) {

$page->setContent($cmsPage ['content']);

$page->setTitle($cmsPage ['title']);

$page->save();

} else {

Mage::getModel('cms/page')->setData($cmsPage)->save();

}

Product Attributes Create or Upgrade:


$model =  new Mage_Catalog_Model_Resource_Setup();
$model->addAttribute(Mage_Catalog_Model_Product::ENTITY, 'my_custom_attribute_code', array(
    'group' => 'Prices',
    'type' => 'text',
    'attribute_set' =>  'Default', // Your custom Attribute set
    'backend' => '',
    'frontend' => '',
    'label' => 'My Custom Attribute',
    'input' => 'text',
    'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL,
    'visible' => true,
    'required' => false,
    'user_defined' => true,
    'default' => '1',
    'searchable' => false,
    'filterable' => true,
    'comparable' => false,
    'visible_on_front' => true,
    'visible_in_advanced_search' => true,
    'used_in_product_listing' => true,
    'unique' => false,
    'apply_to' => 'simple',  // Apply to simple product type
));

//Custom Attribute for dropdown
$model->addAttribute(Mage_Catalog_Model_Product::ENTITY, 'colors', array(
    'group' => 'General',
    'type' => 'text',
    'attribute_set' =>  'Default', // Your custom Attribute set
    'backend' => '',
    'frontend' => '',
    'label' => 'Colors',
    'input' => 'select',
    'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL,
    'visible' => true,
    'required' => false,
    'user_defined' => true,
    'default' => 0,
    'searchable' => false,
    'filterable' => true,
    'comparable' => true,
    'visible_on_front' => true,
    'visible_in_advanced_search' => true,
    'used_in_product_listing' => true,
    'unique' => false,
    'option' =>array (
        'values' =>
            array (
                0 => 'Red',
                1 => 'Black',
                2 => 'Green',
                3 => 'Grey',
                4 => 'White',
                5 => 'Yellow'
            )
    ),
));

//Enable wysiwyg  
$installer->addAttribute(Mage_Catalog_Model_Category::ENTITY, 'description2', array(
    'group' => 'General Information',
    'input' => 'textarea',
    'type' => 'text',
    'label' => 'Description2',
    'backend'       => '',
    'visible'       => true,    
    'required' => false,
    'wysiwyg_enabled' => true,
    'visible_on_front' => true,
    'is_html_allowed_on_front' => true,
    'default' => '',
    'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_STORE,
));

$installer->updateAttribute(Mage_Catalog_Model_Category::ENTITY, 'bottom_description', 'is_wysiwyg_enabled', 1);
$installer->updateAttribute(Mage_Catalog_Model_Category::ENTITY, 'bottom_description', 'is_html_allowed_on_front', 1);

$model = new Mage_Catalog_Model_Resource_Setup();

$model->addAttribute(Mage_Catalog_Model_Product::ENTITY, 'my_custom_attribute_code', array(

'group' => 'Prices',

'type' => 'text',

'attribute_set' => 'Default', // Your custom Attribute set

'backend' => '',

'frontend' => '',

'label' => 'My Custom Attribute',

'input' => 'text',

'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL,

'visible' => true,

'required' => false,

'user_defined' => true,

'default' => '1',

'searchable' => false,

'filterable' => true,

'comparable' => false,

'visible_on_front' => true,

'visible_in_advanced_search' => true,

'used_in_product_listing' => true,

'unique' => false,

'apply_to' => 'simple', // Apply to simple product type

));

//Custom Attribute for dropdown

$model->addAttribute(Mage_Catalog_Model_Product::ENTITY, 'colors', array(

'group' => 'General',

'type' => 'text',

'attribute_set' => 'Default', // Your custom Attribute set

'backend' => '',

'frontend' => '',

'label' => 'Colors',

'input' => 'select',

'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL,

'visible' => true,

'required' => false,

'user_defined' => true,

'default' => 0,

'searchable' => false,

'filterable' => true,

'comparable' => true,

'visible_on_front' => true,

'visible_in_advanced_search' => true,

'used_in_product_listing' => true,

'unique' => false,

'option' =>array (

'values' =>

array (

0 => 'Red',

1 => 'Black',

2 => 'Green',

3 => 'Grey',

4 => 'White',

5 => 'Yellow'

)

));

//Enable wysiwyg

$installer->addAttribute(Mage_Catalog_Model_Category::ENTITY, 'description2', array(

'group' => 'General Information',

'input' => 'textarea',

'type' => 'text',

'label' => 'Description2',

'backend' => '',

'visible' => true,

'required' => false,

'wysiwyg_enabled' => true,

'visible_on_front' => true,

'is_html_allowed_on_front' => true,

'default' => '',

'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_STORE,

));

$installer->updateAttribute(Mage_Catalog_Model_Category::ENTITY, 'bottom_description', 'is_wysiwyg_enabled', 1);

$installer->updateAttribute(Mage_Catalog_Model_Category::ENTITY, 'bottom_description', 'is_html_allowed_on_front', 1);

Category Upgrade:


Mage::app()->getStore()->setId(0);
$category = Mage::getModel('catalog/category')->load($category_id); // enter category id
$category->setDescription('Sample Category description'); // Update category description
$category->setIsAnchor(1); // set category "Is Anchor" yes
$category->save();

Mage::app()->getStore()->setId(0);

$category = Mage::getModel('catalog/category')->load($category_id); // enter category id

$category->setDescription('Sample Category description'); // Update category description

$category->setIsAnchor(1); // set category "Is Anchor" yes

$category->save();

Update All Category and Run Indexing:


$storeIds = Mage::getModel('core/store')->getCollection()->getAllIds();
$category = Mage::getModel('catalog/category');
$tree = $category->getTreeModel();
$tree->load();
$ids = $tree->getCollection()->getAllIds();
asort($ids);
$categories = array();
$storeId = 0;
$resource = Mage::getResourceModel('catalog/category');
if ($ids) {
    foreach ($ids as $id) {
        $cat = $category->load($id);
        if ($cat->getId() && $cat->getLevel() > 1) {
            $cat->setData('is_anchor', 1);
            //$cat->save();
            $resource->saveAttribute($cat, 'is_anchor');
            unset($cat);
        }
    }
}
$process = Mage::getSingleton('index/indexer')->getProcessByCode('catalog_category_flat');
$process->reindexEverything();

$storeIds = Mage::getModel('core/store')->getCollection()->getAllIds();

$category = Mage::getModel('catalog/category');

$tree = $category->getTreeModel();

$tree->load();

$ids = $tree->getCollection()->getAllIds();

asort($ids);

$categories = array();

$storeId = 0;

$resource = Mage::getResourceModel('catalog/category');

if ($ids) {

foreach ($ids as $id) {

$cat = $category->load($id);

if ($cat->getId() && $cat->getLevel() > 1) {

$cat->setData('is_anchor', 1);

//$cat->save();

$resource->saveAttribute($cat, 'is_anchor');

unset($cat);

}

$process = Mage::getSingleton('index/indexer')->getProcessByCode('catalog_category_flat');

$process->reindexEverything();

Product Upgrade:


Mage::app()->getStore()->setId(0);
$descriptions = <<<EOT
<p>Product description here</p>
EOT;

$product_id = 344;
$product = Mage::getModel('catalog/product')->load($product_id);
$product->setDescription($descriptions);
$product->save();

Mage::app()->getStore()->setId(0);

$descriptions = <<<EOT

<p>Product description here</p>

EOT;

$product_id = 344;

$product = Mage::getModel('catalog/product')->load($product_id);

$product->setDescription($descriptions);

$product->save();

Email Template Upgrade:


$template_code = "Email - Header";
$templateText = <<<EOT
Template Content here
EOT;

$emailTemplate = Mage::getModel('core/email_template');
$emailTemplate->loadByCode($template_code);
if ($emailTemplate->getTemplateId()) {
    $emailTemplate->setTemplateText($templateText);
    $emailTemplate->save();
}

$template_code = "Email - Header";

$templateText = <<<EOT

Template Content here

EOT;

$emailTemplate = Mage::getModel('core/email_template');

$emailTemplate->loadByCode($template_code);

if ($emailTemplate->getTemplateId()) {

$emailTemplate->setTemplateText($templateText);

$emailTemplate->save();

}

Drop table:


$command = "DROP TABLE IF EXISTS `custome_table`;";
$installer->run($command);

$command = "DROP TABLE IF EXISTS `custome_table`;";

$installer->run($command);

2 thoughts on “Magento: Create or Update CMS Page & Static Block, Core Configuration, Product and Category information via Upgrade Scripts.”

Salim says:

November 28, 2016 at 10:59 am

It is really a nice and useful piece of info. I’m satisfied that you simply shared this helpful information with us. Thanks for sharing.

KMH Russell says:

November 28, 2016 at 11:56 am

Very nice article! Please keep contributing to the Magenton knowledge-base arena. Thank you

Why are upgrade scripts helpful

CMS Page Create or Upgrade:

Product Attributes Create or Upgrade:

Category Upgrade:

Update All Category and Run Indexing:

Product Upgrade:

Email Template Upgrade:

Drop table:

2 thoughts on “Magento: Create or Update CMS Page & Static Block, Core Configuration, Product and Category information via Upgrade Scripts.”

Leave a Reply Cancel reply