azine / AzineHybridAuthBundle

Services/AzineMergedBusinessNetworksProvider.php

<?php

namespace Azine\HybridAuthBundle\Services;

use Azine\HybridAuthBundle\Entity\UserContact;
use Symfony\Component\HttpFoundation\Session\Session;

class AzineMergedBusinessNetworksProvider
{
    /**
     * @var AzineHybridAuth
     */
    private $hybridAuth;

    /**
     * @var array
     */
    private $contacts;

    /**
     * @var Session
     */
    private $session;

    /**
     * @var array of provider ids
     */
    private $providers;

    /**
     * @var array of provider ids that are loaded already
     */
    private $loadedProviders;

    /**
     * @var ContactSorter
     */
    private $sorter;

    /**
     * @var ContactMerger
     */
    private $merger;

    /**
     * @var GenderGuesser
     */
    private $genderGuesser;

    /**
     * @var string
     */
    const CONTACTS_SESSION_NAME = 'hybrid_auth_contacts';
    const LOADED_PROVIDERS_NAME = 'hybrid_auth_loaded_providers';

    /**
     * Get the contacts from all configured providers.
     *
     * @param AzineHybridAuth $hybridAuth
     * @param Session         $session
     * @param array           $providers
     */
    public function __construct(AzineHybridAuth $hybridAuth, Session $session, ContactSorter $sorter, ContactMerger $merger, GenderGuesser $genderGuesser, ContactFilter $contactFilter, array $providers)
    {
        $this->hybridAuth = $hybridAuth;
        $this->sorter = $sorter;
        $this->merger = $merger;
        $this->contacts = $session->get(self::CONTACTS_SESSION_NAME, array());
        $this->loadedProviders = $session->get(self::LOADED_PROVIDERS_NAME, array());
        $this->providers = array_keys($providers);
        $this->session = $session;
        $this->genderGuesser = $genderGuesser;
        $this->contactFilter = $contactFilter;

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

    }

    /**
     * Get user-profiles from linked-in.
     *
     * @param int   $pageSize
     * @param int   $offset
     * @param array $filterParams
     *
     * @return array
     */
    public function getContactProfiles($pageSize = 50, $offset = 0, $filterParams = array())
    {
        // check if the contacts are loaded already
        if (sizeof($this->providers) != sizeof($this->loadedProviders)) {
            $this->getAllContacts();
        }

        // filter according to the $filterParams
        $contacts = $this->contactFilter->filter($this->contacts, $filterParams);

        // return one page
        $contacts = array_slice($contacts, $offset, $pageSize, true);

        return $contacts;
    }

    /**
     * Fetch all contacts from the networks.
     */
    private function getAllContacts()
    {
        $newContactsCount = 0;
        foreach ($this->providers as $provider) {
            $connected = $this->hybridAuth->getProvider(null, $provider, false)->isConnected();
            if ($connected && (!array_key_exists($provider, $this->loadedProviders) || 0 == sizeof($this->loadedProviders[$provider]))) {
                $newContacts = $this->getUserContactsFor($provider);
                $this->loadedProviders[$provider] = $newContacts;
                $this->session->set(self::LOADED_PROVIDERS_NAME, $this->loadedProviders);
                $this->session->save();
                $newContactsCount += sizeof($newContacts);
            }
        }

        if ($newContactsCount > 0) {
            // merge the old and new contacts
            $this->contacts = $this->merger->merge($this->loadedProviders);

            // sort all contacts
            usort($this->contacts, array($this->sorter, 'compare'));

            $this->session->set(self::CONTACTS_SESSION_NAME, $this->contacts);
            $this->session->save();
        }
    }

    /**
     * Get ALL contacts of the current user.
     *
     * @param $provider
     *
     * @return array
     *
     * @throws \Exception
     */
    public function getUserContactsFor($provider)
    {
        if ('LinkedIn' == $provider) {
            return $this->getLinkedInContacts();
        }

        $userContacts = array();
        foreach ($this->hybridAuth->getProvider(null, $provider)->getUserContacts() as $next) {
            $nextContact = new UserContact($provider);
            $nextContact->identifier = $next->identifier;
            $nextContact->profileURL = $next->profileURL;
            $nextContact->firstName = $next->firstName;

The property firstName does not seem to exist on Hybridauth\User\Contact.

            $nextContact->lastName = $next->lastName;

The property lastName does not seem to exist on Hybridauth\User\Contact.

            $nextContact->displayName = $nextContact->firstName.' '.$nextContact->lastName;
            $nextContact->description = $next->description;
            $nextContact->email = $next->email;
        }

        return $userContacts;
    }

    /**
     * Get ALL linkedin contacts of the current user.
     *
     * @throws \Exception
     *
     * @return array of UserContact
     */
    public function getLinkedInContacts()
    {
        $api = $this->hybridAuth->getLinkedInApi();
        $fetchSize = 500;
        $fetchMore = true;
        $fetchOffset = 0;
        $users = array();

        try {
            while ($fetchMore) {
                $response = $api->profile("~/connections:(id,first-name,last-name,picture-url,public-profile-url,summary,headline,specialities)?start=$fetchOffset&count=$fetchSize");
                $connectionsXml = new \SimpleXMLElement($response['linkedin']);
                foreach ($connectionsXml->person as $person) {
                    $users[] = $person;
                }
                $fetchMore = $fetchSize == sizeof($connectionsXml->person);
                $fetchOffset = $fetchOffset + $fetchSize;
            }
        } catch (\LinkedInException $e) {

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

            throw new \Exception("User contacts request failed! {$this->providerId} returned an error.", $e->getCode(), $e);

The property providerId does not exist on Azine\HybridAuthBundle\Services\AzineMergedBusinessNetworksProvider. Did you mean providers?

        }

        $contacts = array();
        foreach ($users as $connection) {
            $contacts[] = $this->createUserContactFromLinkedInProfile($connection);
        }

        return $contacts;
    }

    /**
     * Get the basic profile of the current users contact with the given user id.
     *
     * @param string $provider
     * @param string $contactId
     *
     * @return UserContact
     */
    public function getUserContactBasicProfile($provider, $contactId)
    {
        if (!array_key_exists($provider, $this->loadedProviders)) {
            $this->loadedProviders[$provider] = $this->getUserContactsFor($provider);
            $this->session->set(self::LOADED_PROVIDERS_NAME, $this->loadedProviders);
            $this->session->save();
        }

        foreach ($this->loadedProviders[$provider] as $userContact) {
            if ($userContact->identifier == $contactId) {
                return $userContact;
            }
        }

        return null;
    }

    /**
     * Get the basic profile of the user with the given profileUrl.
     *
     * @param string $profileUrl
     *
     * @throws \Exception
     *
     * @return UserContact
     */
    public function getUserProfileByUrl($profileUrl)
    {
        $matches = array();
        preg_match('/https?:\/\/.{0,5}(linkedin)(\.ch|\.com).*/', $profileUrl, $matches);
        $provider = $matches[1];
        if (false !== strpos($provider, 'linkedin')) {
            $profileUrl = urlencode($profileUrl);
            try {
                $response = $this->hybridAuth->getLinkedInApi()->connections("url=$profileUrl:(id,first-name,last-name,picture-url,public-profile-url,summary,headline,specialities,email-address)");
            } catch (\LinkedInException $e) {
                throw new \Exception('User profile by url request failed! linkedin returned an error.', $e->getCode(), $e);
            }
            $connectionsXml = new \SimpleXMLElement($response['linkedin']);

            return $this->createUserContactFromLinkedInProfile($connectionsXml);
        }
    }

    /**
     * @param $linkedinProfile
     *
     * @return UserContact
     */
    private function createUserContactFromLinkedInProfile($linkedinProfile)
    {
        $newContact = new UserContact('LinkedIn');
        $newContact->identifier = (string) $linkedinProfile->id;
        $newContact->firstName = (string) $linkedinProfile->{'first-name'};
        $newContact->lastName = (string) $linkedinProfile->{'last-name'};
        $newContact->displayName = (string) $linkedinProfile->{'first-name'}.' '.$linkedinProfile->{'last-name'};
        $newContact->profileURL = (string) $linkedinProfile->{'public-profile-url'};
        if (null == $newContact->profileURL) {
            $newContact->profileURL = (string) $linkedinProfile->{'site-standard-profile-request'};
        }
        $newContact->photoURL = (string) $linkedinProfile->{'picture-url'};
        $newContact->description = (string) $linkedinProfile->{'summary'};
        $newContact->description .= '' == $newContact->description ? (string) $linkedinProfile->{'specialities'} : "\n".(string) $linkedinProfile->{'specialities'};
        if ($linkedinProfile->{'email-address'}) {
            $newContact->email = (string) $linkedinProfile->{'email-address'};
        }
        $newContact->gender = $this->genderGuesser->gender($newContact->firstName, 5);

$newContact->firstName of type string is incompatible with the type string expected by parameter $firstName of Azine\HybridAuthBundle\Services\GenderGuesser::gender().

        $headline = (string) $linkedinProfile->{'headline'};
        $newContact->headline = str_replace(' at ', ' @ ', $headline);

        return $newContact;
    }
}