README

Projecte - Cicle Formatiu de Grau Superior de Desenvolupament d'Aplicacions Multiplataforma (DAM)

Taula de continguts

Info
Idioma (important)
Controladors i Models
- Controladors
- Models
Documentació del codi
Packagist
Instal·lació
API Routes
Qui?

Info

Programming Package és el projecte final del Cicle Formatiu de Grau Superior de Desenvolupament d'Aplicacions Multiplataforma (DAM), de l'Institut de l'Ebre (Tortosa - Terres de l'Ebre).

Aquest és un paquet que es pot veure implementat al repositori Programming, on a més a més hi trobaràs més informació sobre el projecte desenvolupat.

Enllaços d'interès

Què fa?

Proporciona els CRUDs necessaris per dur endavant la gestió de:

Departaments.
Mòduls professionals.
Unitats formatives.
Nuclis formatius.

Relacions

Es tenen en compte les relacions següents:

Usuaris - Departaments (1,1)
- Un usuari pot no ser cap de departament (0).
- Un usuari pot ser cap de departament de com a màxim 1 (1).
- Un departament només pot tenir un cap de departament (1,1).
Usuaris - Departaments (N,N); [taula pivot]
- Un usuari pot no estar assignat a un departament (0).
- Un usuari pot estar assignat a més d'un departament (N).
- Un departament pot no estar assignat a un usuari (0).
- Un departament pot estar assignat a més d'un usuari (N).
Departaments - Mòduls professionals (1,N)
- Un departament pot no tenir cap mòdul professional (0).
- Un departament pot tenir més d'un mòdul professional (N).
- Un mòdul professional només pot ser assignat a un departament (1).
Mòdul professional - Unitat formativa (1,N)
- Un mòdul professional pot no tenir cap unitat formativa (0).
- Un mòdul professional pot tenir més d'una unitat formativa (N).
- Una unitat formativa només pot ser assignada a un mòdul professional (1,1).
Unitat formativa - Nucli formatiu (1,N)
- Una unitat formativa pot no tenir cap nucli formatiu (0).
- Una unitat formativa pot tenir més d'un nucli formatiu (N).
- Un nucli formatiu només pot ser assignat a una unitat formativa (1,1).

Idioma (important)

Els noms dels models, dels controladors, dels mètodes i variables estàn amb anglès, així com, també, els blocs de comentaris /** */.

Els comentaris que hi ha d'entre mig el codi està en català.

És important tenir en compte aquest aspecte donat que les variables tornades en les peticions AJAX són amb anglès.

Departaments => Departments | Department.
Mòduls professionals => Professional modules | Professional module.
Unitats formatives => Training units | Training unit.
Nuclis formatius => Temaries | Temary.

Controladors i Models

Controladors

namespace Rogerforner\ScoolProgramming\Http\Controllers\API;

Tots els controladors són fills (estenen) d'un controlador pare, el qual ha estat creat per depurar les respostes a través de la API.

ApiResponseController (s'estén de Controller, Laravel).
DepartmentController (s'estén de ApiResponseController).
ProfessionalModuleController (s'estén de ApiResponseController).
TemaryController (s'estén de ApiResponseController).
TrainingUnitController (s'estén de ApiResponseController).

Models

namespace Rogerforner\ScoolProgramming\Models;

Cada controlador té el seu model, el qual disposa de les Relacions Eloquent de Laravel.

Department.
- users(): belongsToMany
  - S'ha d'afegir la relació corresponent al model Users.
- professionalModules(): hasMany
ProfessionalModule.
- department(): belongsTo
- trainingUnits(): hasMany
Temary.
- trainingUnit(): belongsTo
TrainingUnit.
- professionalModule(): belongsTo
- temaries(): hasMany

Documentació del codi

La documentació del codi s'ha dut a terme mitjançant Sami i es pot visualitzar o bé a través de l'enllaç que es mostra a sota de la descripció del repositori o bé aquí.

La documentació està allotjada en el propi GitHub, a través de GitHub Pages.

Packagist

Pots trobar el paquet a Packagist, el repositori de paquets de Composer.

Aquest paquet és rogerforner/scool_programming.

Instal·lació

Composer install

Executa la següent comanda per instal·lar el paquet al teu projecte Laravel.

composer require rogerforner/scool_programming

Configuració

Un cop instal·lat el paquet, ens dirigim a config/app.php i hi instanciem aquest al Package Service Providers...

/*
 * Package Service Providers...
 */
Rogerforner\ScoolProgramming\ScoolProgrammingServiceProvider::class,

Implementació

Un cop instanciat el paquet hem de fer que les migracions siguin inserides a la carpeta propia d'aquestes, del Laravel, doncs només així les podrem executar.

Vendor

Per fer-ho possible executem la següent comanda. S'ha de tenir en compte que aquestes són necessaries per al bon funcionament del paquet.

php artisan vendor:publish

Un cop executada apareixeràn els providers, hem de inserir el número en el que es trobi indexat.

Which provider or tag's files would you like to publish?:
  [0 ] Publish files from all providers and tags listed below
  [1 ] Provider: Fideloper\Proxy\TrustedProxyServiceProvider
  [2 ] Provider: Illuminate\Mail\MailServiceProvider
  [3 ] Provider: Illuminate\Notifications\NotificationServiceProvider
  [4 ] Provider: Illuminate\Pagination\PaginationServiceProvider
  [5 ] Provider: Laravel\Passport\PassportServiceProvider
  [6 ] Provider: Laravel\Tinker\TinkerServiceProvider
  [7 ] Provider: Rogerforner\ScoolProgramming\ScoolProgrammingServiceProvider
  [8 ] Tag: config
  [9 ] Tag: laravel-mail
  [10] Tag: laravel-notifications
  [11] Tag: laravel-pagination
  [12] Tag: migrations
  [13] Tag: passport-components
  [14] Tag: passport-config
  [15] Tag: passport-views
 >

En aquest cas podem veure que el provider està indexat al número 7.

Migracions

Un cop realitzat l'apartat del "Vendor", duem a terme les migracions.

php artisan migrate:fresh

Si s'han creat seeders (no és el nostre cas), podem executar:

php artisan migrate:fresh --seed

API Routes

El paquet proporciona unes rutes a través les quals treballat, aquetes retornen una resposta JSON amb múltiples variables, fet així per poder disposar de missatges (errors o satisfactoris) personalitzats, com també de diverses variables que continguin els objectes necessàris per a cada vista que es vulgui fer servir.

En el nostre cas d'exemple (mirar apartat Info) s'ha emprat Vue i Axios per tal de consumir la API que proporciona el paquet.

Tot i així, a continuació, es porporcionen les rutes, tot i que, abans, es fa menció de la comanda artisan emprada per llistar-les.

php artisan route:list

Departments Routes

|        | GET|HEAD  | api/scool/programming/departments                                | departments.index            | Rogerforner\ScoolProgramming\Http\Controllers\API\DepartmentController@index           | auth:api     |
|        | POST      | api/scool/programming/departments                                | departments.store            | Rogerforner\ScoolProgramming\Http\Controllers\API\DepartmentController@store           | auth:api     |
|        | GET|HEAD  | api/scool/programming/departments/{department}                   | departments.show             | Rogerforner\ScoolProgramming\Http\Controllers\API\DepartmentController@show            | auth:api     |
|        | PUT|PATCH | api/scool/programming/departments/{department}                   | departments.update           | Rogerforner\ScoolProgramming\Http\Controllers\API\DepartmentController@update          | auth:api     |
|        | DELETE    | api/scool/programming/departments/{department}                   | departments.destroy          | Rogerforner\ScoolProgramming\Http\Controllers\API\DepartmentController@destroy         | auth:api     |

Professional Modules Routes

|        | GET|HEAD  | api/scool/programming/professional-modules                       | professional-modules.index   | Rogerforner\ScoolProgramming\Http\Controllers\API\ProfessionalModuleController@index   | auth:api     |
|        | POST      | api/scool/programming/professional-modules                       | professional-modules.store   | Rogerforner\ScoolProgramming\Http\Controllers\API\ProfessionalModuleController@store   | auth:api     |
|        | GET|HEAD  | api/scool/programming/professional-modules/{professional_module} | professional-modules.show    | Rogerforner\ScoolProgramming\Http\Controllers\API\ProfessionalModuleController@show    | auth:api     |
|        | PUT|PATCH | api/scool/programming/professional-modules/{professional_module} | professional-modules.update  | Rogerforner\ScoolProgramming\Http\Controllers\API\ProfessionalModuleController@update  | auth:api     |
|        | DELETE    | api/scool/programming/professional-modules/{professional_module} | professional-modules.destroy | Rogerforner\ScoolProgramming\Http\Controllers\API\ProfessionalModuleController@destroy | auth:api     |

Temaries Routes

|        | GET|HEAD  | api/scool/programming/temaries                                   | temaries.index               | Rogerforner\ScoolProgramming\Http\Controllers\API\TemaryController@index               | auth:api     |
|        | POST      | api/scool/programming/temaries                                   | temaries.store               | Rogerforner\ScoolProgramming\Http\Controllers\API\TemaryController@store               | auth:api     |
|        | DELETE    | api/scool/programming/temaries/{temary}                          | temaries.destroy             | Rogerforner\ScoolProgramming\Http\Controllers\API\TemaryController@destroy             | auth:api     |
|        | GET|HEAD  | api/scool/programming/temaries/{temary}                          | temaries.show                | Rogerforner\ScoolProgramming\Http\Controllers\API\TemaryController@show                | auth:api     |
|        | PUT|PATCH | api/scool/programming/temaries/{temary}                          | temaries.update              | Rogerforner\ScoolProgramming\Http\Controllers\API\TemaryController@update              | auth:api     |

Training Units Routes

|        | GET|HEAD  | api/scool/programming/training-units                             | training-units.index         | Rogerforner\ScoolProgramming\Http\Controllers\API\TrainingUnitController@index         | auth:api     |
|        | POST      | api/scool/programming/training-units                             | training-units.store         | Rogerforner\ScoolProgramming\Http\Controllers\API\TrainingUnitController@store         | auth:api     |
|        | DELETE    | api/scool/programming/training-units/{training_unit}             | training-units.destroy       | Rogerforner\ScoolProgramming\Http\Controllers\API\TrainingUnitController@destroy       | auth:api     |
|        | PUT|PATCH | api/scool/programming/training-units/{training_unit}             | training-units.update        | Rogerforner\ScoolProgramming\Http\Controllers\API\TrainingUnitController@update        | auth:api     |
|        | GET|HEAD  | api/scool/programming/training-units/{training_unit}             | training-units.show          | Rogerforner\ScoolProgramming\Http\Controllers\API\TrainingUnitController@show          | auth:api     |

Vue + Axios (consumir rutes)

A continuació proporcionem un enllaç a la carpeta on disposem dels components Vue a través dels quals consumim la API. Podrem veure que hi ha un component per a cadascuna de les rutes/controladors.

Repositori CFGS-DAM-Projecte-Programming/resources/assets/js/components/scool-programming/

Tal i com es menciona en l'apartat "Info", aquest repositori que es dona d'exemple només ha estat fet servir per dur a terme les funcionalitats del paquet, cadascú és lliure de desenvolupar les vistes i consumir els recursos de la API al seu gust.

Qui?

Alumne:

Roger Forner Fabre

Professors:

Gonçal Verge Arnau
Jaume Ramos Prades
Javier Sancho Fabregat
Quique Lorente Fuertes
Santiago Sabaté Sanz
Sergi Tur Badenas

rogerforner / scool_programming

Maintainers

Details