Wallogit.com
2017 © Pedro Peláez
Easily integrate Force.com Toolkit for PHP 5.3 into your symfony 2.1 project
CodemitteForceToolkitBundle is a Symfony 2 bundle to integrate Force.com Toolkit for PHP 5.3 into your Symfony 2 project. Simply enable the bundle, configure SOAP access to your salesforce organisation and start working., (*1)
THIS BUNDLE AND IT'S LIBRARY DEPENDENCIES ARE STILL SUBJECT OF HEAVY DEVELOPMENT AND SHOULD NOT BE CONSIDERED STABLE! DONT USE IT IN PRODUCTION UNTIL YOU REALLY NOW WHAT YOU'RE DOING (though i don't in every circumstances.), (*2)
This bundle is part of a multi-tenant self service portal application currently developed by the company i work for and will recieve updates/backports from time-to-time, but there is no "official release schedule"., (*3)
In the meanwhile, some other, rather popular libraries arised, perhaps you want to take a look at these ones:, (*4)
Add the following line to your composer.json file into the "require"-section:, (*5)
require {
[...]
"codemitte/ForceToolkitBundle" : "dev-master"
[...]
}
After that run the composer update command:, (*6)
$ php ./composer.phar update
If you face problems, refer to the official composer documentation. Remark the required whitelist entry when using .phar-files with a php executable that has ext/suhosin enabled!, (*7)
Enable the freshly downloaded bundle in your Kernel PHP file (usually located in app/AppKernel.php):, (*8)
class AppKernel extends Kernel
{
public function registerBundles()
{
return array(
[...]
new \Codemitte\Bundle\ForceToolkitBundle\CodemitteForceToolkitBundle()
);
}
}
Clear all caches, (*9)
vendor/codemitte/codemitte-force-toolkit-bundle/Codemitte/Bundle/ForceToolkit/{repository root, the dir where the .git directory resides}
Add the classpaths of the bundle and all dependencies to your autoload.php file. The mapping is, (*10)
'Codemitte\\Bundle\\ForceToolkitBundle' => 'path/to/cloned/repository/'
for instance:, (*11)
'Codemitte\\Bundle\\ForceToolkitBundle' => 'vendor/codemitte/codemitte-force-toolkit-bundle', 'Codemitte\\ForceToolkit' => 'vendor/codemitte/codemitte-force-toolkit', 'Codemitte\\Soap' => 'vendor/codemitte/codemitte-soap', 'Codemitte\\Common' => 'vendor/codemitte/codemitte-common'
Enable the freshly downloaded bundle to your Kernel PHP file (usually to find in app/AppKernel.php):, (*12)
class AppKernel extends Kernel
{
public function registerBundles()
{
return array(
[...]
new \Codemitte\Bundle\ForceToolkitBundle\CodemitteForceToolkitBundle()
);
}
}
Clear all caches, (*13)
The bundle provides a Configuration class which defines the schema of all config keys you may use in your config.yml (xml|php) files, as usual. The full schema is:, (*14)
app/config/config.yml, (*15)
codemitte_force_toolkit:
soap_api_client:
classname: "Codemitte\\ForceToolkit\\Soap\\Client\\PartnerClient"
connection_ttl: 28800
service_location: ~
wsdl_location: "%kernel.root_dir%/config/wsdl/prod/partner.wsdl.xml"
api_users:
default: { username: "user1@myorg.tld", password: "********" }
locales:
en: { username: "user1@myorg.co.uk", password: "********" }
de: { username: "user1@myorg.de", password: "********" }
de_AT: { username: "user1@myorg.at", password: "********" }
metadata:
cache_service_id: "codemitte_forcetk.metadata.file_cache"
cache_location: "%kernel.root_dir%/cache/forcetk"
cache_ttl: -1
A minimal configuration may look like this:, (*16)
app/config/config.yml, (*17)
codemitte_force_toolkit:
soap_api_client:
wsdl_location: "%kernel.root_dir%/config/wsdl/prod/partner.wsdl.xml"
api_users:
default: { username: "user1@myorg.co.uk", password: "********" }
locales:
en: { username: "user1@myorg.co.uk", password: "********" }
metadata:
cache_service_id: "codemitte_forcetk.metadata.array_cache"
For using the Force.com symfony form types in your twig templates, consider enabling the following global form template extension:, (*18)
twig:
form:
resources:
- 'CodemitteForceToolkitBundle:Form:fields.html.twig'
src/AcmeBundle/Controller/DefaultController.php, (*19)
/** @var $client Codemitte\ForceToolkit\Soap\Client\PartnerClient */
$client = $this->get('codemitte_forcetk.client');
/** @var $response Codemitte\Soap\Mapping\GenericResult */
$response = $client->query('SELECT Id, Name FROM Account LIMIT 10');
foreach($response['result']['records'] AS $account)
{
print_r($account);
}
$response is Instanceof \Codemitte\Soap\Mapping\GenericResult. You may access each property by array notation, object notation of method notation:, (*20)
$response['result']
$response->result
$response->get('result')
$response->get('result')->get('records'); is instanceof Codemitte\Soap\Mapping\GenericResultCollection which adds methods for easy traversal., (*21)
foreach($response['result']['records'] AS $account)
{
print_r($account);
}
(Please refer to the client interface (Codemitte\ForceToolkit\Soap\Client\APIInterface) for a list of all available service call methods.), (*22)
$client->query() is a low-level API method for fireing SOQL queries against the platform. A more convinient way is to utilize the QueryBuilder:, (*23)
src/AcmeBundle/Controller/AccountController.php, (*24)
public function accountShowAction($id)
{
/** @var $queryBuilder Codemitte\ForceToolkit\Soql\Builder\QueryBuilder */
$queryBuilder = $this->get('codemitte_forcetk.query_builder');
/** @var $account Codemitte\Soap\Mapping\GenericResult */
$account = $queryBuilder->prepareStatement('SELECT Id, Name FROM Account WHERE Id = :id')->bind(array(
'id' => $id
))->fetchOne();
if(null === $account)
{
throw new NotFoundHttpException(sprintf('The account with Id "%s" could not be found', $id));
}
return $this->render('AcmeBundle:Account:show.html.twig', array(
'account' => $account
);
}
Analogously, the account list view:, (*25)
src/AcmeBundle/Controller/AccountController.php, (*26)
public function accountListAction($limit = 20, $offset = 0, $orderBy = 'Name')
{
/** @var $queryBuilder Codemitte\ForceToolkit\Soql\Builder\QueryBuilder */
$queryBuilder = $this->get('codemitte_forcetk.query_builder');
// MAXIMUM OFFSET IS 2000!!!
/** @var $accounts Codemitte\Soap\Mapping\GenericResultCollection */
$accounts = $queryBuilder->prepareStatement('SELECT Id, Name FROM Account')->orderBy($orderBy)->limit($limit)->offset($offset)->fetch();
return $this->render('AcmeBundle:Account:list.html.twig', array(
'accounts' => $accounts
);
}
Basic query to select a collection of sobjects:, (*27)
$queryBuilder
->select('Id, AccountNumber, Email')
->from('Account')
->fetch()
;
Basic query to select a single sobject instance:, (*28)
$queryBuilder
->select('Id, AccountNumber, Name')
->from('Account')
->where('Id = :id', array('id' => $id))
->fetchOne();
;
Query with compound WHERE clause (useful for building filters, for instance):, (*29)
$builder
->select('Id, AccountNumber, Name')
->from('Account')
->where(
$builder
->whereExpr()
->xpr('Id', '=', ':id')
->andXpr
(
$builder
->whereExpr()
->xpr('Name', '=', "'Supercompany'")
->orXpr('AccountNumber', '=', "'12345'")
),
array('id' => $id)
)
->getSoql();
This query should result in an output like:, (*30)
SELECT Id, AccountNumber, Name FROM Account WHERE Id = 'xxxxxxxxxxxxxxxxxx' AND (Name = 'Supercompany' OR AccountNumber = '12345')
Please refer to the query builder interface for further information., (*31)
You may register salesforce types as usual, but instead of using the standard symfony 2 form types, you can utilize special Force.com types. These types take only a few mandatory parameters, namely, (*32)
Other well-known options like "required", "choices", etc. are also available, because each Force.com form type extend standard symfony 2 types!, (*33)
NOTE: For using the force_tk widgets you have to enable a global custom form template in your config.yml twig section:, (*34)
twig:
form:
resources:
- 'CodemitteForceToolkitBundle:Form:fields.html.twig'
Example for building a Force.com enabled form type:, (*35)
src/AcmeBundle/Type/AccountEditType.php, (*36)
<?php
namespace AcmeBundle\Type\EditAccountType;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
/**
* Contact type for rendering a registration form.
*/
class EditAccountType extends AbstractType
{
/**
* @param \Symfony\Component\Form\FormBuilderInterface $builder
* @param array $options
* @return void
*/
public function buildForm(FormBuilderInterface $builder, array $options)
{
parent::buildForm($builder, $options);
$builder->add('billingCountry', 'forcetk_picklist', array(
'sobject_type' => 'Account',
'fieldname' => 'AccountSource',
'recordtype_id' => $options['accountRecordTypeId']
));
}
/**
* Returns the name of this type.
*
* @return string The name of this type
*/
function getName()
{
return 'edit_account';
}
public function setDefaultOptions(OptionsResolverInterface $resolver)
{
parent::setDefaultOptions($resolver);
$resolver
->setRequired(array('accountRecordTypeId'))
->setAllowedTypes(array('accountRecordTypeId' => array('null', 'string')))
->setDefaults(array(
'data_class' => 'Codemitte\Bundle\UserBundle\Validator\EditAccountValidator',
'accountRecordTypeId' => null
));
}
}
For Force.com form types, the bundle comes with some built-in validators you may use in your validation models. For example, consider this account represenation:, (*37)
<?php
namespace Codemitte\Bundle\UserBundle\Validator;
use
Symfony\Component\Validator\Constraints AS Assert,
Codemitte\ForceToolkit\Validator\Constraints AS AssertForce
;
class EditAccountValidator
{
/**
* @var string
* @Assert\NotBlank
* @AssertForce\Picklist(sObjectType="Account", fieldname="AccountSource")
*/
public $billingCountry;
[...]
There is yet no full documentation about Force.com validators + form types available, so please refer to the validator's sourcecode and/or services.xml of the bundle (Resources/config/services.xml), there you will find the full list of available form types including their aliases (the alias is the token which enables the "short address" in form builders, namely for instance "forcetk_picklist", "forcetk_date" and so on., (*38)
Easily integrate Force.com Toolkit for PHP 5.3 into your symfony 2.1 project
MIT
salesforce force.com
Easily integrate Force.com Toolkit for PHP 5.3 into your symfony 2.1 project
MIT
salesforce force.com