MySalesforceContactConfigApi

Complexity

Total Complexity

23

Size/Duplication

Total Lines	278
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	add_fields_to_send_on_creation()	0	5	1
A	add_fields_to_use_for_filter()	0	5	1
A	add_fields_to_send_on_update()	0	5	1
A	get_fields_for_filter()	0	8	1
A	login_details_field()	0	19	1
A	get_fields_to_send_on_update()	0	8	1
A	array_to_html()	0	11	3
A	list_of_contact_record_types_field()	0	11	1
A	get_fields_to_send_on_creation()	0	7	1
A	select_default_contact_fields_field()	0	19	2
A	mixed_to_array()	0	16	6
A	fields_to_send_field()	0	28	4

<?php
/**
 * returns a bunch of form fields that inform the user about the configuration
 * of the connection and communication with Salesforce.
 */
class MySalesforceContactConfigApi extends Object
{

    /**
     *
     * @var array
     */
    private static $site_wide_fields_to_send_on_creation = [];

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

    /**
     *
     * @var array
     */
    private static $site_wide_fields_to_send_on_update = [];

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

    /**
     *
     * @var array
     */
    private static $site_wide_filter_values = [];

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

    /**
     *
     * @var array
     */
    private static $run_time_fields_to_send_on_creation = [];

    /**
     *
     * @param  array|DataList|string $mixed fields to send
     *
     */
    public static function add_fields_to_send_on_creation($mixed)
    {
        $array = self::mixed_to_array($mixed);

It seems like $mixed can also be of type string; however, parameter $mixed of MySalesforceContactConfigApi::mixed_to_array() does only seem to accept DataList|array|null, maybe add an additional type check?

        self::$run_time_fields_to_send_on_creation += $array;
    }

    /**
     *
     * @var array
     */
    private static $run_time_fields_to_send_on_update = [];

    /**
     *
     * @param  array|DataList|string $mixed fields to send
     *
     * @return array
     */
    public static function add_fields_to_send_on_update($mixed)
    {
        $array = self::mixed_to_array($mixed);

It seems like $mixed can also be of type string; however, parameter $mixed of MySalesforceContactConfigApi::mixed_to_array() does only seem to accept DataList|array|null, maybe add an additional type check?

        self::$run_time_fields_to_send_on_update += $array;
    }

    /**
     *
     * @var array
     */
    private static $run_time_fields_for_filter = [];

    /**
     *
     * @param  array|DataList|string $mixed fields to send
     *
     * @return array
     */
    public static function add_fields_to_use_for_filter($mixed)
    {
        $array = self::mixed_to_array($mixed);

It seems like $mixed can also be of type string; however, parameter $mixed of MySalesforceContactConfigApi::mixed_to_array() does only seem to accept DataList|array|null, maybe add an additional type check?

        self::$run_time_fields_for_filter += $array;
    }


    /**
     *
     * @param  array|DataList|null $mixed fields to send
     *
     * @return array
     */
    public static function get_fields_to_send_on_creation($mixed = null)
    {
        $array = self::mixed_to_array($mixed);
        return array_merge(
            Config::inst()->get('MySalesforceContactConfigApi', 'site_wide_fields_to_send_on_creation'),

It seems like Config::inst()->get('MySalesforceContactConfigApi', 'site_wide_fields_to_send_on_creation') can also be of type boolean and double and integer and string; however, parameter $array1 of array_merge() does only seem to accept array, maybe add an additional type check?

            $array,
            self::$run_time_fields_to_send_on_creation
        );
    }

    /**
     *
     * @param  array|DataList|null $mixed fields to send
     *
     * @return array
     */
    public static function get_fields_to_send_on_update($mixed = null)
    {
        $array = self::mixed_to_array($mixed);

        return array_merge(
            Config::inst()->get('MySalesforceContactConfigApi', 'site_wide_fields_to_send_on_update'),

It seems like Config::inst()->get('MySalesforceContactConfigApi', 'site_wide_fields_to_send_on_update') can also be of type boolean and double and integer and string; however, parameter $array1 of array_merge() does only seem to accept array, maybe add an additional type check?

            $array,
            self::$run_time_fields_to_send_on_update
        );
    }

    /**
     *
     * @param  array|DataList|null $mixed fields to send
     *
     * @return array|DataList|null
     */
    public static function get_fields_for_filter($mixed = null)
    {
        $array = self::mixed_to_array($mixed);

        return array_merge(
            Config::inst()->get('MySalesforceContactConfigApi', 'site_wide_filter_values'),

It seems like Config::inst()->get('MySalesforceContactConfigApi', 'site_wide_filter_values') can also be of type boolean and double and integer and string; however, parameter $array1 of array_merge() does only seem to accept array, maybe add an additional type check?

            $array,
            self::$run_time_fields_for_filter
        );
    }

    /**
     *
     * @param  DataList|array|null $mixed
     * @return array
     */
    protected static function mixed_to_array($mixed = null)
    {
        if(is_object($mixed)) {
            $array = [];
            foreach($mixed as $object) {
                $array[trim($object->Key)] = $object->BetterValueHumanReadable();
            }
        } elseif($mixed === null) {
            $array = [];
        } elseif(is_string($mixed)) {

The condition is_string($mixed) is always false.

            $array = [ $mixed ];
        } elseif(! is_array($array)) {

The variable $array seems to be never defined.

            user_error('Variable '.vardump($mixed).'Should be an array');

The function vardump was not found. Maybe you did not declare it correctly or list all dependencies?

        }

        return $array;

The variable $array does not seem to be defined for all execution paths leading up to this point.

    }

    public static function login_details_field(
        $title = 'Account Used',
        $fieldName = 'SalesforceLoginDetailsField'
    )
    {
        $userName = Config::inst()->get('MySalesforcePartnerApiConnectionOnly', 'username');
        $password = Config::inst()->get('MySalesforcePartnerApiConnectionOnly', 'password');
        $security_token = Config::inst()->get('MySalesforcePartnerApiConnectionOnly', 'security_token');
        $wsdl_location = Config::inst()->get('MySalesforcePartnerApiConnectionOnly', 'wsdl_location');
        $array = [
            'UserName' => $userName,
            'Password' => substr($password, 0, 2) . '...'.substr($password,  -2),

It seems like $password can also be of type array; however, parameter $string of substr() does only seem to accept string, maybe add an additional type check?

            'Token' => substr($security_token, 0, 2) . '...'.substr($security_token,  -2),
            'WSDLLocation' => $wsdl_location,
        ];
        return LiteralField::create(
            $fieldName,
            '<h2>'.$title.'</h2>'.
            self::array_to_html($array)
        );
    }
    /**
     * Field with list of contact record types shown
     * @param  string $fieldName
     * @param  string $title
     *
     * @return LiteralField
     */
    public static function list_of_contact_record_types_field(
        $fieldName = 'ListOfContactRecordTypes',

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

        $title = 'Contact Record Types Available'
    )
    {
        $data = MySalesforceContactApi::retrieve_contact_record_types();

        return LiteralField::create(
            'ListOfContactRecordTypes',
            '<h2>'.$title.'</h2>'.
            '<pre>'.print_r($data, 1).'</pre>'
        );
    }

    /**
     * Needs to link to a many-many relationship (SalesforceDefaultContactFields)
     * @param  array $array fields to send
     *
     * @return CheckboxSetField
     */
    public static function select_default_contact_fields_field($fieldName, $title, $desc = '')
    {
        $count = SalesforceDefaultContactField::get()->count();
        if($count === 0) {
            return HiddenField::create(

The expression return HiddenField::create($fieldName, $title) returns the type HiddenField which is incompatible with the documented return type CheckboxSetField.

                $fieldName,
                $title
            );
        }
        return CheckboxSetField::create(
            $fieldName,
            $title,
            SalesforceDefaultContactField::get()->map()->toArray()
        )
            ->setDescription('
                '.$desc.'
                <br />
                You can
                <a href="/admin/salesforceadmin/'.SalesforceDefaultContactField::class.'/">Add or Edit the options</a>
                as required. Please change with care.
            ');
    }

    /**
     *
     * @param  array|DataList|null $array fields to send
     * @param  string $fieldName fields to send
     * @param  string $title fields to send
     *
     * @return LiteralField
     */
    public static function fields_to_send_field(
        $type,
        $mixed = null,
        $fieldName = 'FieldsToSendToSalesforce',
        $title  = 'Default Fields for'
    )
    {
        $fieldName .= ucfirst($type);
        $title .= ' '.ucfirst($type);

        switch( $type ) {
            case 'create':
                $array = self::get_fields_to_send_on_creation($mixed);
                break;
            case 'update':
                $array = self::get_fields_to_send_on_update($mixed);
                break;
            case 'filter':
                $array = self::get_fields_for_filter($mixed);
                break;
            default:
                user_error('type needs to be create, update or filter - currently set to: '.$type);
                break;
        }
        return LiteralField::create(
            $fieldName,
            '<h2>'.$title.'</h2>'.
            self::array_to_html($array)

The variable $array does not seem to be defined for all execution paths leading up to this point.

        );
    }

    /**
     *
     * @param  [type] $array [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

     * @return [type]        [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

     */
    protected static function array_to_html($array) : string
    {
        $htmlArray = [];
        foreach($array as $field => $value) {
            $htmlArray[] = $field.' = '.$value.' ('.gettype($value).')';
        }
        if(count($htmlArray) == 0) {
            $htmlArray[] = 'none';
        }

        return '<p>- '.implode('</p><p> - ', $htmlArray).'</p>';
    }
}