SalesforceContactLog

Complexity

Total Complexity

10

Size/Duplication

Total Lines	228
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	create_contact_log()	0	14	1
A	confirmContactLog()	0	27	4
A	getCMSFields()	0	54	1
A	serializedToHTML()	0	5	1
A	canDelete()	0	3	1
A	canCreate()	0	3	1
A	canEdit()	0	3	1

<?php

use SForce\Wsdl\SaveResult;

class SalesforceContactLog extends DataObject
{

    /**
     * create contact log
     * @param  string $type
     * @param  array $fieldsSent
     * @param  array $filters
     *
     * @return SalesforceContactLog
     */
    public static function create_contact_log($type, array $fieldsSent, array $filters) : SalesforceContactLog

The parameter $filters is not used and could be removed.

    {
        $fieldsSent = serialize($fieldsSent);
        $filters = serialize($fieldsSent);
        $obj = SalesforceContactLog::create(
            [
                'Type' => $type,
                'FieldsSent' => $fieldsSent,
                'Filters' => $filters,
            ]
        );
        $id = $obj->write();

        return SalesforceContactLog::get()->byID($id);

The expression return SalesforceContactLog::get()->byID($id) returns the type DataObject which includes types incompatible with the type-hinted return SalesforceContactLog.

    }

    /**
     * returns true if the contact update was successful
     * @param  mixed $response
     *
     * @return bool
     */
    public function confirmContactLog($response) : bool
    {
        $id = '';
        $errors = '';
        $hasError = false;
        if(is_array($response)) {
            $response = $response[0];
        }
        if($response instanceof \SForce\Wsdl\SaveResult) {
            $id = $response->getId();
            $errors = serialize($response->getErrors());
            if($response->getSuccess()) {
                $hasError = false;
            } else {
                $hasError = true;
            }
        } else {
            $errors = 'Unexpected response: '.serialize($response);
            // print_r($response);
            user_error('unexptected response');
        }
        $this->SalesforceIdentifier = $id;

The property SalesforceIdentifier does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->Errors = $errors;

The property Errors does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->HasError = $hasError;

The property HasError does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->write();

        return $this->HasError;
    }

    /**
     * Singular name for CMS
     * @var string
     */
    private static $singular_name = 'Sales Force Contact Log';

The private property $singular_name is not used, and could be removed.

    /**
     * Plural name for CMS
     * @var string
     */
    private static $plural_name = 'Sales Force Contact Log Entries';

The private property $plural_name is not used, and could be removed.

    /**
     * SS4 prep!
     * @var string
     */
    private static $table_name = 'SalesforceContactLog';

The private property $table_name is not used, and could be removed.

    private static $db = [

The private property $db is not used, and could be removed.

        'SalesforceIdentifier' => 'Varchar(40)',
        'Type' => 'Enum("Created,Updated")',
        'Executed' => 'Boolean',
        'FieldsSent' => 'Text',
        'Filters' => 'Text',
        'HasError' => 'Boolean',
        'Errors' => 'Text',
    ];


    private static $default_sort = [

The private property $default_sort is not used, and could be removed.

        'ID' => 'DESC'
    ];

    /**
     * Defines a default list of filters for the search context
     * @var array
     */
    private static $searchable_fields = [

The private property $searchable_fields is not used, and could be removed.

        'Type' => 'ExactMatchFilter',
        'Executed' => 'ExactMatchFilter',
        'HasError' => 'ExactMatchFilter',
        'SalesforceIdentifier' => 'PartialMatchField',
        'FieldsSent' => 'PartialMatchField',
        'Filters' => 'PartialMatchField',
        'Errors' => 'PartialMatchField',
    ];

    /**
     * Defines summary fields commonly used in table columns
     * as a quick overview of the data for this dataobject
     * @var array
     */
    private static $summary_fields = [

The private property $summary_fields is not used, and could be removed.

        'Created.Nice' => 'Created',
        'SalesforceIdentifier' => 'SF ID',
        'Type' => 'Type',
        'Executed.Nice' => 'Executed',
        'Type' => 'Type',
        'HasError.Nice' => 'Errors',
        'Errors' => 'Errors',
    ];

    private static $indexes = [

The private property $indexes is not used, and could be removed.

        'SalesforceIdentifier' => true
    ];

    /**
     * CMS Fields
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeFieldsFromTab(
            'Root.Main',
            [
                'FieldsSent',
                'Filters',
                'HasError',
                'Executed',
            ]
        );
        $fields->addFieldsToTab(
            'Root.Main',
            [
                ReadonlyField::create(
                    'Created',
                    'Created',
                    DBField::create_field('SS_DateTime', $this->Created)->Nice()
                ),
                ReadonlyField::create(
                    'SalesforceIdentifier',
                    'Sales Force Identifier'
                ),
                LiteralField::create(
                    'FieldsSentNice',
                    '<h2>Fields Sent</h2>'.$this->serializedToHTML($this->FieldsSent)

The property FieldsSent does not exist on SalesforceContactLog. Since you implemented __get, consider adding a @property annotation.

                ),
                ReadonlyField::create(
                    'Type',
                    'Type'
                ),
                LiteralField::create(
                    'FiltersNice',
                    '<h2>Filters</h2>'.$this->serializedToHTML($this->Filters)

The property Filters does not exist on SalesforceContactLog. Since you implemented __get, consider adding a @property annotation.

                ),
                ReadonlyField::create(
                    'ExecutedNice',
                    'Executed',
                    DBField::create_field('Boolean', $this->Executed)->Nice()

The property Executed does not exist on SalesforceContactLog. Since you implemented __get, consider adding a @property annotation.

                ),
                ReadonlyField::create(
                    'HasErrorNice',
                    'HasError',
                    DBField::create_field('Boolean', $this->HasError)->Nice()
                ),
                ReadonlyField::create(
                    'Errors',
                    'Communication Errors'
                )->setRightTitle('Separated by three ||| symbols.')
            ]
        );

        return $fields;
    }

    /**
     * DataObject create permissions
     * @param Member $member
     * @return bool
     */
    public function canCreate($member = null)
    {
        return false;
    }

    /**
     * DataObject edit permissions
     * @param Member $member
     * @return bool
     */
    public function canEdit($member = null)
    {
        return false;
    }

    /**
     * DataObject delete permissions
     * @param Member $member
     * @return bool
     */
    public function canDelete($member = null)
    {
        return false;
    }

    /**
     *
     * @param  string $serializedString (serialised data)
     * @return string (html)
     */
    protected function serializedToHTML($serializedString)
    {
        $s = unserialize($serializedString);

        return '<pre>'.print_r($s, 1).'</pre>';
    }

}