plugindo/plugindo

This library is used for get item from the nintendo eshop

dev-main 2022-01-07 14:41 UTC

GPL-3.0-only

• astol

README

PLUGINDO

Presentation

This project is a plugin for any project for requesting products from europe nintendo eshop the official website: https://www.nintendo.com/games/

Summary

1. Requirements

2. How to use

3. Items Retrievable

4. Set Request Parameters

Requirements

Requirements

Techno	Minimum Version	Library Required	Plugin url
PHP	>= 7.4	- curl	https://packagist.org/packages/plugindo/plugindo

How to use

The way for requesting items is the same on all languages.
For requesting something you have to do call your items like this :

require 'vendor/autoload.php';
use Plugindo\Games;

//================ BASIC USAGE ================
// type of collection you want to get
// always take the plural filename like Games and NOT Game
$typeOfCollection = new Games();

// get products for the collection
$typeOfCollection->get();

// access to the game get
var_dump($typeOfCollection->getGames());

//================ CUSTOM LANGUAGE ================
// default language is English
// in this case I set it to French
$typeOfCollection = new Games('fr');

//================ SET PARAMETERS ================
// here I set parameter with a searched by keywords
// available parameters are described below
$parameters = [
    'q' => 'mario kart',
];

$typeOfCollection = new Games('fr');

$typeOfCollection->get($parameters);
var_dump($typeOfCollection->getGames());

Items Retrievable

Items

Name	Class You Have To Call
Games	Games
Nintendo news	News
Amiibo	Amiibos
Merchandising	Merchandises

Set parameters for your request

You can pass parameters for getting precise result, if any params dont match with what
is described below you will get an Exception for avoiding error during request
execution

You can find an example of how set parameter on top of this readme

Parameters

Key	Value Type	Default Value if not set	Desc
rows	int	5	amount of result you want
q	string	*	set keywords the product name include
fq	string[]	[]	You must have a syntax like this "keys:value" or "keys_name:value"

Language Available

Language available

language	key to use
English	en
French	fr
German	de
Spanish	es
Italian	it
Russian	ru
Portuguese	pt
Dutch	du

License

GNU GENERAL PUBLIC LICENSE Version 3

Project Status

this project is in development to be available on composer and next as a python package atm