smalot / magento-bundle
A Symfony2 wrapper for the Magento Soap Client API
Installs: 5 426
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 5
Forks: 9
Open Issues: 0
Requires
- php: >=5.3.0
- smalot/magento-client: *
- symfony/symfony: ^2.5|^3.0
This package is not auto-updated.
Last update: 2024-11-05 02:58:41 UTC
README
This project is a bridge between Symfony 2 and Magento-Client API which allow to call easily the Magento Soap v1 API.
Allows :
- wrappers for each call
- dependencies injections
- event listeners
- debug toolbar integration
- and ... code completion
Requirements
- Symfony >= 2.1
- PHP >= 5.3
- smalot/magento-client
Installation
Add the following lines to your composer.json:
{ "require": { "smalot/magento-bundle": "*" } }
And run php composer.phar update smalot/magento-bundle
Then, register the bundle in your kernel:
# app/AppKernel.php # ... class AppKernel extends Kernel { public function registerBundles() { $bundles = array( # ... new Smalot\MagentoBundle\MagentoBundle(), ); return $bundles; } }
Configuration
You need to setup at least one connection in the connections
pool and specify it with the default_connection
property.
The mandatory properties are: url
, api_user
and api_key
.
# app/config/config.yml # Sample configuration magento: # Refers to the default connection in the connection pool default_connection: default # Example: default # List all available connections connections: # Prototype default: url: http://domain.tld/magento/ api_user: username api_key: 0123456789AZ # Enable logging system logging: %kernel.debug% # Refers to the logger service logger: ~ # Refers to the dispatcher service dispatcher: ~
Details
Service(s) provided:
- magento
Events thrown in security context:
- \Smalot\MagentoBundle\MagentoEvents::PRE_LOGIN
- \Smalot\MagentoBundle\MagentoEvents::POST_LOGIN
- \Smalot\MagentoBundle\MagentoEvents::PRE_LOGOUT
- \Smalot\MagentoBundle\MagentoEvents::POST_LOGOUT
Events thrown in transport context:
- \Smalot\MagentoBundle\MagentoEvents::PRE_SINGLE_CALL
- \Smalot\MagentoBundle\MagentoEvents::POST_SINGLE_CALL
- \Smalot\MagentoBundle\MagentoEvents::PRE_MULTI_CALL
- \Smalot\MagentoBundle\MagentoEvents::POST_MULTI_CALL
Sample codes
Using the default
connection:
class MagentoController extends Controller { /** * @Route("/", name="magento_index") */ public function indexAction(Request $request) { // Retrieve default connection. $magento = $this->get('magento')->getManager(); if ($magento->ping()) { // Call any module's class. $categoryManager = new \Smalot\Magento\Catalog\Category($magento); $tree = $categoryManager->getTree()->execute(); } else { $tree = array(); } $magento->logout(); return new Response('<html><body><pre>' . var_export($tree, true) . '</pre></body></html>'); } }
The connection can be specified manually if needed:
$magento = $this->get('magento')->getManager('second_connection_name');