zeeshan / inspector
Inspector - A PHP library that fetches the social accounts, website, name, photos, employment history and other details possible for the user by his email.
Requires (Dev)
- phpunit/phpunit: 4.2.*
This package is not auto-updated.
Last update: 2024-10-26 19:37:49 UTC
README
Inspector - A PHP library that fetches the social accounts, website, name, photos, employment history and other details possible for the user by their email.
Installation
You can install the library using the following ways:
Using Composer
You can install this through Composer, a dependency manager for PHP. Just run the below command:
composer require zeeshanu/inspector
For further details you can find the package at Packagist.
Manual way
- Copy
src
to your codebase, perhaps to the vendor directory. - Add the
Zeeshan\Inspector\Inspector
class to your autoloader or require the file directly.
Getting Started
I'm going to use the following email address to demonstrate the usage of this php wrapper.
// Your FulContact API key https://portal.fullcontact.com/signup $apiKey = ""; $inspector = new Inspector($apiKey); $person = $inspector->getProfile("ziishaned@gmail.com"); $person->getPhotos(); // An array of arrays where typename could be one of 'facebook', 'Gravatar', 'Twitter' etc // [ // [ // "typeName" => "Facebook" // "url" => "https://d2ojpxxtu63wzl.cloudfront.net/static/a2dcfe7a0136f34ace8c8fd378557a96_ce4301d022a5423869916af01ad8c2c// e11f7638b11958db47b89bf4ef7369ab7", // ], // [..], // [..], // [..], // ] $person->getContactInfo(); // An array of found contact info e.g websites and full name // [ // "websites" => [ // [ // "url" => "http://webxyz.com", // ], // ], // "fullName" => "Zeeshan Ahmed", // ] $person->getOrganizations(); // An array of organizations found in which he worked or currently working // [ // [ // "name" => "Company XYZ", // "startDate" => "2014-07", // "title" => "Software Engineer", // "current" => true, // ], // [..], // ] $person->getDemographics(); // An array of information about the user location // [ // [ // "locationDeduced" => [ // "normalizedLocation" => "Pakistan", // "deducedLocation" => "Pakistan", // "country" => [ // "name" => "Pakistan", // "code" => "PK", // ], // "continent" => [ // "deduced" => true // "name" => "Asia" // ], // "likelihood" => true, // ], // "locationGeneral" => "Pakistan", // "gender" => "Male", // ], // ] $person->getSocialProfiles(); // An array of user social network links or information // [ // [ // "bio" => "Full Stack Web Engineer, Blogger, Freelancer, IT Enthusiast, Open Source and Web Lover, PHP and Javascript Fanatic", // "typeName" => "Twitter", // "url" => "https://twitter.com/ziishaned", // "username" => "ziishaned", // ], // [..], // [..], // [..], // [..], // ] $person->getInterests(); // An array of user digital Footprint or user interests // [ // "Blogging", "Cloud Computing", "Software Development", "Cybersecurity", "Hacking", // ] $person->getEmail(); // User email address // "ziishaned@gmail.com"
Feedback
If you notice that there might be some improvements in code you can create a pull request or report an issue. You can also contact me at ziishaned@gmail.com.
Note
Please note that the library relies upon FullContact API and you will need an API key to use this package.
License
The MIT License (MIT). Please see License File for more information.