Add module vardef entity and data providers

Signed-off-by: Dillon-Brown <dillon.brown@salesagility.com>
This commit is contained in:
Dillon-Brown 2020-05-11 15:58:50 +01:00
parent 5d6aa45391
commit 76744d36b7
5 changed files with 774 additions and 0 deletions

View file

@ -0,0 +1,44 @@
<?php
namespace SuiteCRM\Core\Legacy;
use App\Entity\FieldDefinition;
use Exception;
use SugarView;
/**
* Class FieldDefinitionsHandler
* @package SuiteCRM\Core\Legacy
*/
class FieldDefinitionsHandler extends LegacyHandler implements FieldDefinitionsProviderInterface
{
public const HANDLER_KEY = 'field-definitions';
/**
* @inheritDoc
*/
public function getHandlerKey(): string
{
return self::HANDLER_KEY;
}
/**
* @param string $moduleName
* @return FieldDefinition
* @throws Exception
*/
public function getVardef(string $moduleName): FieldDefinition
{
$this->init();
$this->startLegacyApp();
$sugarView = new SugarView();
$vardefs = new FieldDefinition();
$vardefs->setId($moduleName);
$vardefs->setVardef($sugarView->getVardefsData($moduleName));
$this->close();
return $vardefs;
}
}

View file

@ -0,0 +1,17 @@
<?php
namespace SuiteCRM\Core\Legacy;
use App\Entity\FieldDefinition;
interface FieldDefinitionsProviderInterface
{
/**
* Get all exposed user preferences
* @param string $moduleName
* @return FieldDefinition
*/
public function getVardef(string $moduleName): FieldDefinition;
}

View file

@ -0,0 +1,59 @@
<?php
namespace App\DataProvider;
use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
use App\Entity\FieldDefinition;
use Exception;
use SuiteCRM\Core\Legacy\FieldDefinitionsHandler;
/**
* Class FieldDefinitionItemDataProvider
* @package App\DataProvider
*/
class FieldDefinitionItemDataProvider implements ItemDataProviderInterface, RestrictedDataProviderInterface
{
/**
* @var FieldDefinitionsHandler
*/
protected $vardefHandler;
/**
* FieldDefinitionItemDataProvider constructor.
* @param FieldDefinitionsHandler $vardefHandler
*/
public function __construct(FieldDefinitionsHandler $vardefHandler)
{
$this->vardefHandler = $vardefHandler;
}
/**
* Define supported resources
* @param string $resourceClass
* @param string|null $operationName
* @param array $context
* @return bool
*/
public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
{
return FieldDefinition::class === $resourceClass;
}
/**
* @param string $resourceClass
* @param array|int|string $id
* @param string|null $operationName
* @param array $context
* @return FieldDefinition|null
* @throws Exception
*/
public function getItem(
string $resourceClass,
$id,
string $operationName = null,
array $context = []
): ?FieldDefinition {
return $this->vardefHandler->getVardef($id);
}
}

View file

@ -0,0 +1,89 @@
<?php
namespace App\Entity;
use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
/**
* @ApiResource(
* routePrefix="/vardef",
* itemOperations={
* "get"
* },
* graphql={
* "item_query",
* }
* )
*/
class FieldDefinition
{
/**
* The module
*
* @var string
*
* @ApiProperty(
* identifier=true,
* attributes={
* "openapi_context"={
* "type"="string",
* "description"="The module vardef.",
* "example"="Accounts"
* }
* },
*
* )
*/
protected $id;
/**
* Module vardef metadata
*
* @var array
*
* @ApiProperty(
* attributes={
* "openapi_context"={
* "type"="array",
* "description"="The module metadata",
* },
* }
* )
*/
public $vardef;
/**
* @return string
*/
public function getId(): string
{
return $this->id;
}
/**
* @param string $id
*/
public function setId($id): void
{
$this->id = $id;
}
/**
* Get vardef metadata
* @return array
*/
public function getVardef(): ?array
{
return $this->vardef;
}
/**
* Set vardef metadata
* @param array $vardef
*/
public function setVardef(array $vardef): void
{
$this->vardef = $vardef;
}
}

View file

@ -0,0 +1,565 @@
<?php
declare(strict_types=1);
use App\Entity\FieldDefinition;
use Codeception\Test\Unit;
use SuiteCRM\Core\Legacy\FieldDefinitionsHandler;
use SuiteCRM\Core\Legacy\LegacyScopeState;
final class FieldDefinitionHandlerTest extends Unit
{
/**
* @var FieldDefinitionsHandler
*/
private $fieldDefinitionsHandler;
/**
* @var FieldDefinition
*/
protected $fieldDefinition;
/**
* @throws Exception
*/
protected function _before(): void
{
$projectDir = codecept_root_dir();
$legacyDir = $projectDir . '/legacy';
$legacySessionName = 'LEGACYSESSID';
$defaultSessionName = 'PHPSESSID';
$legacyScope = new LegacyScopeState();
$this->fieldDefinitionsHandler = new FieldDefinitionsHandler($projectDir, $legacyDir, $legacySessionName,
$defaultSessionName, $legacyScope);
}
public function testGetUserVardef(): void
{
$this->fieldDefinition = $this->fieldDefinitionsHandler->getVardef('Accounts');
$output = $this->fieldDefinition->vardef;
$expected = $dictionary['Account'] = [
'table' => 'accounts',
'audited' => true,
'unified_search' => true,
'full_text_search' => true,
'unified_search_default_enabled' => true,
'duplicate_merge' => true,
'comment' => 'Accounts are organizations or entities that are the target of selling, support, and marketing activities, or have already purchased products or services',
'fields' => [
'parent_id' => [
'name' => 'parent_id',
'vname' => 'LBL_PARENT_ACCOUNT_ID',
'type' => 'id',
'required' => false,
'reportable' => false,
'audited' => true,
'comment' => 'Account ID of the parent of this account',
],
'sic_code' => [
'name' => 'sic_code',
'vname' => 'LBL_SIC_CODE',
'type' => 'varchar',
'len' => 10,
'comment' => 'SIC code of the account',
],
'parent_name' => [
'name' => 'parent_name',
'rname' => 'name',
'id_name' => 'parent_id',
'vname' => 'LBL_MEMBER_OF',
'type' => 'relate',
'isnull' => 'true',
'module' => 'Accounts',
'table' => 'accounts',
'massupdate' => false,
'source' => 'non-db',
'len' => 36,
'link' => 'member_of',
'unified_search' => true,
'importable' => 'true',
],
'members' => [
'name' => 'members',
'type' => 'link',
'relationship' => 'member_accounts',
'module' => 'Accounts',
'bean_name' => 'Account',
'source' => 'non-db',
'vname' => 'LBL_MEMBERS',
],
'member_of' => [
'name' => 'member_of',
'type' => 'link',
'relationship' => 'member_accounts',
'module' => 'Accounts',
'bean_name' => 'Account',
'link_type' => 'one',
'source' => 'non-db',
'vname' => 'LBL_MEMBER_OF',
'side' => 'right',
],
'email_opt_out' => [
'name' => 'email_opt_out',
'vname' => 'LBL_EMAIL_OPT_OUT',
'source' => 'non-db',
'type' => 'bool',
'massupdate' => false,
'studio' => 'false',
],
'invalid_email' => [
'name' => 'invalid_email',
'vname' => 'LBL_INVALID_EMAIL',
'source' => 'non-db',
'type' => 'bool',
'massupdate' => false,
'studio' => 'false',
],
'cases' => [
'name' => 'cases',
'type' => 'link',
'relationship' => 'account_cases',
'module' => 'Cases',
'bean_name' => 'aCase',
'source' => 'non-db',
'vname' => 'LBL_CASES',
],
//bug 42902
'email' => [
'name' => 'email',
'type' => 'email',
'query_type' => 'default',
'source' => 'non-db',
'operator' => 'subquery',
'subquery' => 'SELECT eabr.bean_id FROM email_addr_bean_rel eabr JOIN email_addresses ea ON (ea.id = eabr.email_address_id) WHERE eabr.deleted=0 AND ea.email_address LIKE',
'db_field' => [
'id',
],
'vname' => 'LBL_ANY_EMAIL',
'studio' => ['visible' => false, 'searchview' => true],
'importable' => false,
],
'tasks' => [
'name' => 'tasks',
'type' => 'link',
'relationship' => 'account_tasks',
'module' => 'Tasks',
'bean_name' => 'Task',
'source' => 'non-db',
'vname' => 'LBL_TASKS',
],
'notes' => [
'name' => 'notes',
'type' => 'link',
'relationship' => 'account_notes',
'module' => 'Notes',
'bean_name' => 'Note',
'source' => 'non-db',
'vname' => 'LBL_NOTES',
],
'meetings' => [
'name' => 'meetings',
'type' => 'link',
'relationship' => 'account_meetings',
'module' => 'Meetings',
'bean_name' => 'Meeting',
'source' => 'non-db',
'vname' => 'LBL_MEETINGS',
],
'calls' => [
'name' => 'calls',
'type' => 'link',
'relationship' => 'account_calls',
'module' => 'Calls',
'bean_name' => 'Call',
'source' => 'non-db',
'vname' => 'LBL_CALLS',
],
'emails' => [
'name' => 'emails',
'type' => 'link',
'relationship' => 'emails_accounts_rel', /* reldef in emails */
'module' => 'Emails',
'bean_name' => 'Email',
'source' => 'non-db',
'vname' => 'LBL_EMAILS',
'studio' => ['formula' => false],
],
'documents' => [
'name' => 'documents',
'type' => 'link',
'relationship' => 'documents_accounts',
'source' => 'non-db',
'vname' => 'LBL_DOCUMENTS_SUBPANEL_TITLE',
],
'bugs' => [
'name' => 'bugs',
'type' => 'link',
'relationship' => 'accounts_bugs',
'module' => 'Bugs',
'bean_name' => 'Bug',
'source' => 'non-db',
'vname' => 'LBL_BUGS',
],
'contacts' => [
'name' => 'contacts',
'type' => 'link',
'relationship' => 'accounts_contacts',
'module' => 'Contacts',
'bean_name' => 'Contact',
'source' => 'non-db',
'vname' => 'LBL_CONTACTS',
],
'email_addresses' => [
'name' => 'email_addresses',
'type' => 'link',
'relationship' => 'accounts_email_addresses',
'source' => 'non-db',
'vname' => 'LBL_EMAIL_ADDRESSES',
'reportable' => false,
'unified_search' => true,
'rel_fields' => ['primary_address' => ['type' => 'bool']],
'studio' => ['formula' => false],
],
'email_addresses_primary' => [
'name' => 'email_addresses_primary',
'type' => 'link',
'relationship' => 'accounts_email_addresses_primary',
'source' => 'non-db',
'vname' => 'LBL_EMAIL_ADDRESS_PRIMARY',
'duplicate_merge' => 'disabled',
'studio' => ['formula' => false],
],
'opportunities' => [
'name' => 'opportunities',
'type' => 'link',
'relationship' => 'accounts_opportunities',
'module' => 'Opportunities',
'bean_name' => 'Opportunity',
'source' => 'non-db',
'vname' => 'LBL_OPPORTUNITY',
],
'project' => [
'name' => 'project',
'type' => 'link',
'relationship' => 'projects_accounts',
'module' => 'Project',
'bean_name' => 'Project',
'source' => 'non-db',
'vname' => 'LBL_PROJECTS',
],
'leads' => [
'name' => 'leads',
'type' => 'link',
'relationship' => 'account_leads',
'module' => 'Leads',
'bean_name' => 'Lead',
'source' => 'non-db',
'vname' => 'LBL_LEADS',
],
'campaigns' => [
'name' => 'campaigns',
'type' => 'link',
'relationship' => 'account_campaign_log',
'module' => 'CampaignLog',
'bean_name' => 'CampaignLog',
'source' => 'non-db',
'vname' => 'LBL_CAMPAIGNLOG',
'studio' => ['formula' => false],
],
'campaign_accounts' => [
'name' => 'campaign_accounts',
'type' => 'link',
'vname' => 'LBL_CAMPAIGNS',
'relationship' => 'campaign_accounts',
'source' => 'non-db',
],
'created_by_link' => [
'name' => 'created_by_link',
'type' => 'link',
'relationship' => 'accounts_created_by',
'vname' => 'LBL_CREATED_BY_USER',
'link_type' => 'one',
'module' => 'Users',
'bean_name' => 'User',
'source' => 'non-db',
],
'modified_user_link' => [
'name' => 'modified_user_link',
'type' => 'link',
'relationship' => 'accounts_modified_user',
'vname' => 'LBL_MODIFIED_BY_USER',
'link_type' => 'one',
'module' => 'Users',
'bean_name' => 'User',
'source' => 'non-db',
],
'assigned_user_link' => [
'name' => 'assigned_user_link',
'type' => 'link',
'relationship' => 'accounts_assigned_user',
'vname' => 'LBL_ASSIGNED_TO_USER',
'link_type' => 'one',
'module' => 'Users',
'bean_name' => 'User',
'source' => 'non-db',
'duplicate_merge' => 'enabled',
'rname' => 'user_name',
'id_name' => 'assigned_user_id',
'table' => 'users',
],
'campaign_id' => [
'name' => 'campaign_id',
'comment' => 'Campaign that generated Account',
'vname' => 'LBL_CAMPAIGN_ID',
'rname' => 'id',
'id_name' => 'campaign_id',
'type' => 'id',
'table' => 'campaigns',
'isnull' => 'true',
'module' => 'Campaigns',
'reportable' => false,
'massupdate' => false,
'duplicate_merge' => 'disabled',
],
'campaign_name' => [
'name' => 'campaign_name',
'rname' => 'name',
'vname' => 'LBL_CAMPAIGN',
'type' => 'relate',
'reportable' => false,
'source' => 'non-db',
'table' => 'campaigns',
'id_name' => 'campaign_id',
'link' => 'campaign_accounts',
'module' => 'Campaigns',
'duplicate_merge' => 'disabled',
'comment' => 'The first campaign name for Account (Meta-data only)',
],
'prospect_lists' => [
'name' => 'prospect_lists',
'type' => 'link',
'relationship' => 'prospect_list_accounts',
'module' => 'ProspectLists',
'source' => 'non-db',
'vname' => 'LBL_PROSPECT_LIST',
],
'aos_quotes' => [
'name' => 'aos_quotes',
'vname' => 'LBL_AOS_QUOTES',
'type' => 'link',
'relationship' => 'account_aos_quotes',
'module' => 'AOS_Quotes',
'bean_name' => 'AOS_Quotes',
'source' => 'non-db',
],
'aos_invoices' => [
'name' => 'aos_invoices',
'vname' => 'LBL_AOS_INVOICES',
'type' => 'link',
'relationship' => 'account_aos_invoices',
'module' => 'AOS_Invoices',
'bean_name' => 'AOS_Invoices',
'source' => 'non-db',
],
'aos_contracts' => [
'name' => 'aos_contracts',
'vname' => 'LBL_AOS_CONTRACTS',
'type' => 'link',
'relationship' => 'account_aos_contracts',
'module' => 'AOS_Contracts',
'bean_name' => 'AOS_Contracts',
'source' => 'non-db',
],
],
'indices' => [
['name' => 'idx_accnt_id_del', 'type' => 'index', 'fields' => ['id', 'deleted']],
['name' => 'idx_accnt_name_del', 'type' => 'index', 'fields' => ['name', 'deleted']],
[
'name' => 'idx_accnt_assigned_del',
'type' => 'index',
'fields' => ['deleted', 'assigned_user_id']
],
['name' => 'idx_accnt_parent_id', 'type' => 'index', 'fields' => ['parent_id']],
]
,
'relationships' => [
'member_accounts' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'Accounts',
'rhs_table' => 'accounts',
'rhs_key' => 'parent_id',
'relationship_type' => 'one-to-many'
]
,
'account_cases' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'Cases',
'rhs_table' => 'cases',
'rhs_key' => 'account_id',
'relationship_type' => 'one-to-many'
],
'account_tasks' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'Tasks',
'rhs_table' => 'tasks',
'rhs_key' => 'parent_id',
'relationship_type' => 'one-to-many',
'relationship_role_column' => 'parent_type',
'relationship_role_column_value' => 'Accounts'
],
'account_notes' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'Notes',
'rhs_table' => 'notes',
'rhs_key' => 'parent_id',
'relationship_type' => 'one-to-many',
'relationship_role_column' => 'parent_type',
'relationship_role_column_value' => 'Accounts'
],
'account_meetings' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'Meetings',
'rhs_table' => 'meetings',
'rhs_key' => 'parent_id',
'relationship_type' => 'one-to-many',
'relationship_role_column' => 'parent_type',
'relationship_role_column_value' => 'Accounts'
],
'account_calls' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'Calls',
'rhs_table' => 'calls',
'rhs_key' => 'parent_id',
'relationship_type' => 'one-to-many',
'relationship_role_column' => 'parent_type',
'relationship_role_column_value' => 'Accounts'
],
'account_emails' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'Emails',
'rhs_table' => 'emails',
'rhs_key' => 'parent_id',
'relationship_type' => 'one-to-many',
'relationship_role_column' => 'parent_type',
'relationship_role_column_value' => 'Accounts'
],
'account_leads' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'Leads',
'rhs_table' => 'leads',
'rhs_key' => 'account_id',
'relationship_type' => 'one-to-many'
],
'accounts_assigned_user' => [
'lhs_module' => 'Users',
'lhs_table' => 'users',
'lhs_key' => 'id',
'rhs_module' => 'Accounts',
'rhs_table' => 'accounts',
'rhs_key' => 'assigned_user_id',
'relationship_type' => 'one-to-many'
],
'accounts_modified_user' => [
'lhs_module' => 'Users',
'lhs_table' => 'users',
'lhs_key' => 'id',
'rhs_module' => 'Accounts',
'rhs_table' => 'accounts',
'rhs_key' => 'modified_user_id',
'relationship_type' => 'one-to-many'
],
'accounts_created_by' => [
'lhs_module' => 'Users',
'lhs_table' => 'users',
'lhs_key' => 'id',
'rhs_module' => 'Accounts',
'rhs_table' => 'accounts',
'rhs_key' => 'created_by',
'relationship_type' => 'one-to-many'
],
'account_campaign_log' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'CampaignLog',
'rhs_table' => 'campaign_log',
'rhs_key' => 'target_id',
'relationship_type' => 'one-to-many',
'relationship_role_column' => 'target_type',
'relationship_role_column_value' => 'Accounts'
],
'account_aos_quotes' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'AOS_Quotes',
'rhs_table' => 'aos_quotes',
'rhs_key' => 'billing_account_id',
'relationship_type' => 'one-to-many',
],
'account_aos_invoices' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'AOS_Invoices',
'rhs_table' => 'aos_invoices',
'rhs_key' => 'billing_account_id',
'relationship_type' => 'one-to-many',
],
'account_aos_contracts' => [
'lhs_module' => 'Accounts',
'lhs_table' => 'accounts',
'lhs_key' => 'id',
'rhs_module' => 'AOS_Contracts',
'rhs_table' => 'aos_contracts',
'rhs_key' => 'contract_account_id',
'relationship_type' => 'one-to-many',
],
],
//This enables optimistic locking for Saves From EditView
'optimistic_locking' => true,
];
static::assertSame(
$expected,
$output
);
}
}