Adapt Your Add-ons and Themes to CS-Cart 4.3.2¶

New Functions¶

1. A polyfill for PHP 5.5 array_column function:

   fn_array_column($array, $column_key, $index_key = null)
   

2. Return runtime company_id in any mode:

   fn_get_runtime_company_id()
   

3. Clear the content of the output buffers:

   fn_clear_ob()
   

4. Return the list of supported image formats to be used as setting variants:

   fn_get_supported_image_format_variants()
   

5. The Tygh\Tools\ImageHelper class was added:

   • Calculate the size for a bounding box of text written in given font:

     ImageHelper::calculateTextSize($string, FontInterface $font)
     

   • Calculate the coordinates of the top left corner of the layer that should be positioned on canvas using the given vertical and horizontal positions:

     ImageHelper::positionLayerOnCanvas(BoxInterface $canvas_size, BoxInterface $layer_size, $horizontal_position, $vertical_position, BoxInterface $padding = null)
     

   • Return the image formats supported by the current image manipulation driver. The only formats checked are jpg, png and gif:

     ImageHelper::getSupportedFormats()
     

6. Register custom error handlers:

   fn_init_error_handler()
   

7. Register image manipulation library object in the Application container:

   fn_init_imagine()
   

Changed Functions¶

1. fn_create_seo_name()—the $params parameter was added:

   • (bool) $params['use_generated_paths_cache']—determines whether to cache fn_get_seo_parent_path() calls

   • // old:
     function fn_create_seo_name($object_id, $object_type, $object_name, $index = 0, $dispatch = '', $company_id = '', $lang_code = CART_LANGUAGE, $create_redirect = false, $area = AREA)
     
     // new:
     function fn_create_seo_name($object_id, $object_type, $object_name, $index = 0, $dispatch = '', $company_id = '', $lang_code = CART_LANGUAGE, $create_redirect = false, $area = AREA, $params = array())
     

2. fn_get_seo_parent_path()—the $use_caching parameter was added. It indicates whether to cache results of path_function calls:

   // old:
   function fn_get_seo_parent_path($object_id, $object_type, $company_id = 0)
   
   // new:
   function fn_get_seo_parent_path($object_id, $object_type, $company_id = 0, $use_caching = true)
   

3. fn_generate_seo_url_from_schema()—the $company_id parameter was added:

   // old:
   function fn_generate_seo_url_from_schema($redirect_data, $full = true, $query_string = array())
   
   // new:
   function fn_generate_seo_url_from_schema($redirect_data, $full = true, $query_string = array(), $company_id = null)
   

4. fn_exim_parse_data()—the $is_option parameter was added:

   // old:
   function fn_exim_parse_data($data, $variants_delimiter = ',', $features_delimiter = '///')
   
   // new:
   function fn_exim_parse_data($data, $variants_delimiter = ',', $features_delimiter = '///', $is_option = false)
   

5. fn_settings_actions_general_secure_storefront()—renamed to fn_settings_actions_security_secure_storefront().

6. fn_settings_actions_general_secure_admin()—renamed to fn_settings_actions_security_secure_admin().

Deprecated Functions¶

Deprecated functions still work, but will be removed in the next major release (CS-Cart 5.x):

1. fn_create_image_from_file()
2. fn_check_gd_formats()—use fn_get_supported_image_format_variants() instead
3. fn_parse_rgb()—use Imagine\Image\Palette\RGB class instead

IoC Сontainer¶

Earlier the Registry class stored objects. It also used to store cache and other runtime-data.

// before
$smarty = Registry::get('view');

// now
$smarty = Tygh::$app['view'];

The main difference between the Application container and the Registry class is the lazy object initialization in Application. Objects stored in a container are called services. In most cases they are components of a larger system and have their own area of responsibility, such as database connection, sending e-mail messages, etc.

// register an object in a container using an anonymous factory function
Tygh::$app['foo'] = function($app) {
    return new Tygh\Foo();
};

Tygh::$app['bar'] = function($app) {
    return new Tygh\Bar($app['foo']);
};

// no object was created by this moment, they will be created on demand

// Application will return the anonymous factory function call result.
// Besides, the Tygh\Bar class constructor will get the result of calling another factory function.
$bar_instance = Tygh::$app['bar'];

// the line above equals the following code:
// $foo_instance = new Tygh\Foo();
// $bar_instance = new Tygh\Bar($foo_instance);

// if getting service from a container again, the same object is returned (a new one is not created).
var_dump($bar_instance === Tygh::$app['bar']); // true

// if we want a NEW object to be returned EACH TIME we get a service,
// we should wrap the anonymous factory function like this when initializing service:
Tygh::$app['cool_service'] = Tygh::$app->factory(function($app) {
   return new Tygh\CoolService();
});

// these are different objects
$a = Tygh::$app['cool_service'];
$b = Tygh::$app['cool_service'];
$c = Tygh::$app['cool_service'];

// apart from the mentioned methods it is possible to simply put an object to a container,
// it is the behaviour Registry provided
Tygh::$app['my_object'] = new Tygh\MyClass();