seanmcn/php-represent

A PHP library for http://represent.opennorth.ca/

PHP Represent

, _(*1)

A PHP library for http://represent.opennorth.ca/, _(*2)

Find the elected officials and electoral districts for any Canadian address or postal code, at all levels of government, _(*3)

Install

Install using composer:, _(*4)

"require": {
  "seanmcn/php-represent": "1.*"
}

Alternatively you could just download the package and load it in yourself., _(*5)

Example Usage

$represent = new PHPRepresent\API();
$represent->getAll('boundaries', ['sets' => ['toronto-wards', 'ottawa-wards']]);

API Documentation

• Represent Civic Information API Documentation

Library Documentation

get($path, $params, $throttle);

Returns a single result or one page of results from API path and parameters provided., _(*6)

Parameters: - $path - The API Path of your request. - $params - $_GET variables you want to append to the request. Allows supplying multiple values per key by array or comma seperated. - $throttle - Default TRUE. Option to ignore the API rate limit., _(*7)

Example Usage:, _(*8)

$represent = new PHPRepresent\API();
$path = 'boundaries';
$params = ['sets' => ['toronto-wards', 'ottawa-wards']];
$represent->get($path, $params);

getAll($path, $params);

Returns all results from API path and parameters provided., _(*9)

Parameters: - $path - The API Path of your request. - $params - $_GET variables you want to append to the request. Allows supplying multiple values per key by array or comma seperated., _(*10)

Example Usage:, _(*11)

$represent = new PHPRepresent\API();
$path = 'boundaries';
$params = ['sets' => 'toronto-wards,ottawa-wards'];
$represent->getAll($path, $params);

postcode($postcode);

Find representatives and boundaries by postal code., _(*12)

Parameters: - $postcode - Post code to find representatives and boundaries for., _(*13)

Example Usage:, _(*14)

$represent = new PHPRepresent\API();
$represent->postcode('L5G4L3');

boundarySets($name, $params);

Return boundary sets which are groups of electoral districts, like BC provincial districts or Toronto wards., _(*15)

Parameters: - $name - Optional, if provided will return the singular boundary set. - $params - $_GET variables you want to append to the request. Allows supplying multiple values per key by array or comma seperated., _(*16)

Example Usage:, _(*17)

$represent = new PHPRepresent\API();
$represent->boundarySets();

boundaries($boundarySet, $name, $representatives, $params)

Return boundaries of electoral districts, can be proved a set like toronto-wards for boundaries of a singular set., _(*18)

All Parameters are optional however $name requires you provide $boundarySet and $representatives requires you provided both $boundarySet and $name, _(*19)

Parameters: - $boundarySet - Optional, if provided returns boundaries from a singular boundary set - $name - Optional, if provided will return a singular boundary - $representatives - Optional, if provided will return representatives for the boundary. - $params - Optional, $_GET variables you want to append to the request. Allows supplying multiple values per key by array or comma seperated., _(*20)

Example Usage:, _(*21)

$represent = new PHPRepresent\API();
// One Set
$represent->boundaries('toronto-wards');
// Multiple Sets
$represent->boundaries(null, null, false,  ['sets' => ['toronto-wards', 'ottawa-wards']]);

representativeSets($set);

Returns all or a singular representative set., _(*22)

A representative set is a group of elected officials, like the House of Commons or Toronto City Council., _(*23)

Parameters: - $set - Optional, if provided will return the singular represenative set., _(*24)

Example Usage:, _(*25)

$represent = new PHPRepresent\API();
$represent->representativeSets('north-dumfries-township-council');

representatives($set, $params);

Returns a list of representatives., _(*26)

Parameters: - $set - Optional, if provided will return the represenatives for a singular set. - $params - Optional, $_GET variables you want to append to the request. Allows supplying multiple values per key by array or comma seperated., _(*27)

Example Usage:, _(*28)

$represent = new PHPRepresent\API();
$represent->representatives('house-of-commons');

elections($election);

Returns a list of elections or a singular election., _(*29)

This doesn't have any data right now so I am usnure if this is working correctly., _(*30)

Parameters: - $election - Optional, if provided will return the a singular election based on provided ID., _(*31)

Example Usage:, _(*32)

$represent = new PHPRepresent\API();
$represent->elections();

candidates($election, $params);

Returns a list of all candidates for all elections or all candidates for a singular election, _(*33)

This doesn't have any data right now so I am unsure if this is working correctly., _(*34)

Parameters: - $election - Optional, if provided will return the candidates for a singular election. - $params - Optional, $_GET variables you want to append to the request. Allows supplying multiple values per key by array or comma seperated., _(*35)

Example Usage:, _(*36)

$represent = new PHPRepresent\API();
$represent->candidates();

setInsecure();

Option to disable using HTTPS, if for example you are having certificate problems while testing this out., _(*37)

Note: You really shouldn't use this in Production, _(*38)

Example Usage:, _(*39)

$represent = new PHPRepresent\API();
$represent->setInsecure();
$represent->boundaries('toronto-wards');

setRateLimit($limit);

Option to set the rate limit (per minute) to whatever you choose. The default rate limit is 60 requests per minute., _(*40)

Note: Don't change this unless you have agreed upon a higher rate limit with Open North otherwise you're going to get HTTP 503 errors, _(*41)

Example Usage:, _(*42)

$represent = new PHPRepresent\API();
$represent->setRateLimit(42);
$represent->boundaries('ottawa-wards');