Skip to content

Latest commit

 

History

History
151 lines (98 loc) · 5.67 KB

README.md

File metadata and controls

151 lines (98 loc) · 5.67 KB
Raw

Rinvex University

Rinvex University is a simple and lightweight package for retrieving university details with flexibility. A whole bunch of data including name, country, state, email, website, telephone, address, and much more attributes for the 17k+ known universities worldwide at your fingertips.

Packagist Scrutinizer Code Quality Travis StyleCI License

Usage

Install via composer require rinvex/universities, then use intuitively:

// Get single university
$cairoUniversity = university('cairo-university');

// Get university name: Cairo University
echo $cairoUniversity->getName();

// Get university alternative name: null
echo $cairoUniversity->getAltName();

// Get university country: Egypt
echo $cairoUniversity->getCountry();

// Get university state: null
echo $cairoUniversity->getState();

// Get university address: {"street":"PO Box 12613, Nahdet Misr Street","city":"Giza","province":"Cairo","postal_code":null}
echo $cairoUniversity->getAddress();

// Get university street: PO Box 12613, Nahdet Misr Street
echo $cairoUniversity->getStreet();

// Get university city: Giza
echo $cairoUniversity->getCity();

// Get university province: Cairo
echo $cairoUniversity->getProvince();

// Get university postal code: null
echo $cairoUniversity->getPostalCode();

// Get university contact: {"telephone":"+20(2) 572-9584","website":"http:\/\/www.cu.edu.eg","email":"[email protected]","fax":"+20(2) 568-8884"}
echo $cairoUniversity->getContact();

// Get university telephone: +20(2) 572-9584
echo $cairoUniversity->getTelephone();

// Get university website: http://www.cu.edu.eg
echo $cairoUniversity->getWebsite();

// Get university email: [email protected]
echo $cairoUniversity->getEmail();

// Get university fax: +20(2) 568-8884
echo $cairoUniversity->getFax();

// Get university funding: Public
echo $cairoUniversity->getFunding();

// Get university languages: null
echo $cairoUniversity->getLanguages();

// Get university academic year: September to June (September-January; January-June)
echo $cairoUniversity->getAcademicYear();

// Get university accrediting agency: null
echo $cairoUniversity->getAccreditingAgency();


// Get all universities
$universities = universities();

// Get all universities in Egypt (by country code)
$egyptUniversities = universities('eg');

Notes:

  • Rinvex University is framework-agnostic, so it's compatible with any PHP framework whatsoever without any dependencies at all, except for the PHP version itself ^7.2.0. Awesome, huh? 😃
  • Rinvex University provides the global helpers for your convenience and for ease of use, but in fact it's just wrappers around the underlying UniversityLoader class, which you can utilize and use directly if you wish

Features Explained

  • University data are all stored here: resources/names.json.
  • name - university english name
  • alt_name - university alternative name
  • country - university country
  • state - university state
  • address - university address details
    • street: university street
    • city: university city
    • province: university province
    • postal_code: university postal code
  • contact - university contact details
    • telephone: university telephone
    • website: university website
    • email: university email
    • fax: university fax
  • funding - university institution funding (public/private)
  • languages - university teaching languages (array)
  • academic_year - university academic year
  • accrediting_agency - university accrediting agency

Changelog

Refer to the Changelog for a full history of the project.

Support

The following support channels are available at your fingertips:

Contributing & Protocols

Thank you for considering contributing to this project! The contribution guide can be found in CONTRIBUTING.md.

Bug reports, feature requests, and pull requests are very welcome.

Security Vulnerabilities

If you discover a security vulnerability within this project, please send an e-mail to [email protected]. All security vulnerabilities will be promptly addressed.

About Rinvex

Rinvex is a software solutions startup, specialized in integrated enterprise solutions for SMEs established in Alexandria, Egypt since June 2016. We believe that our drive The Value, The Reach, and The Impact is what differentiates us and unleash the endless possibilities of our philosophy through the power of software. We like to call it Innovation At The Speed Of Life. That’s how we do our share of advancing humanity.

License

This software is released under The MIT License (MIT).

(c) 2016-2020 Rinvex LLC, Some rights reserved.