Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chengkangzai/laravel-apu-schedule

This package provide simple API to get all and query the student's timetable information from Asia Pacific University(APU).
https://github.com/chengkangzai/laravel-apu-schedule

Last synced: about 1 month ago
JSON representation

This package provide simple API to get all and query the student's timetable information from Asia Pacific University(APU).

Host: GitHub
URL: https://github.com/chengkangzai/laravel-apu-schedule
Owner: chengkangzai
License: mit
Created: 2021-12-07T06:57:29.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-10-09T19:29:26.000Z (about 1 year ago)
Last Synced: 2024-10-31T21:04:55.478Z (2 months ago)
Language: PHP
Homepage:
Size: 70.3 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md

Awesome Lists containing this project

README

        # This is my package laravel-apu-schedule

[![Latest Version on Packagist](https://img.shields.io/packagist/v/chengkangzai/laravel-apu-schedule.svg?style=flat-square)](https://packagist.org/packages/chengkangzai/laravel-apu-schedule)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/chengkangzai/laravel-apu-schedule/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/chengkangzai/laravel-apu-schedule/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/chengkangzai/laravel-apu-schedule/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/chengkangzai/laravel-apu-schedule/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/chengkangzai/laravel-apu-schedule.svg?style=flat-square)](https://packagist.org/packages/chengkangzai/laravel-apu-schedule)

![Package Banners](https://banners.beyondco.de/Laravel%20Apu%20Schedule.png?theme=light&packageManager=composer+require&packageName=chengkangzai%2Flaravel-apu-schedule&pattern=ticTacToe&style=style_1&description=query+student%27s+timetable+from+APU&md=1&showWatermark=1&fontSize=100px&images=academic-cap)

This package provide simple API to get all and query the student's timetable information from [Asia Pacific University(APU)](https://apu.edu.my/).

## Installation

You can install the package via composer:

```bash

composer require chengkangzai/laravel-apu-schedule

```

## Usage

## Get all the intake code

```php

use Chengkangzai\ApuSchedule\ApuSchedule;

$intakes = ApuSchedule::getIntakes(); // UC3F2111SE, AFCF2011AS ... 

```

## Get all the grouping by intake code

```php

use Chengkangzai\ApuSchedule\ApuSchedule;

ApuSchedule::getGroupings("UC3F2111SE"); // G1,G2,G3

```

## Get schedule of specific intake and grouping

```php

use Chengkangzai\ApuSchedule\ApuSchedule;

ApuSchedule::getSchedule("UC3F2111SE","G1"); 

```

Example Output

```json

[

    {

        "INTAKE": "...",

        "MODID": "...",

        "MODULE_NAME": "...",

        "DAY": "...",

        "LOCATION": "...",

        "ROOM": "...",

        "LECTID": "...",

        "NAME": "...",

        "SAMACCOUNTNAME": "...",

        "DATESTAMP": "...",

        "DATESTAMP_ISO": "...",

        "TIME_FROM": "...",

        "TIME_TO": "...",

        "TIME_FROM_ISO": "...",

        "TIME_TO_ISO": "...",

        "GROUPING": "...",

        "CLASS_CODE": "...",

        "COLOR": "..."

    },

    {}

]

```

## Get all official apu holiday

```php

use Chengkangzai\ApuSchedule\ApuHoliday; 

ApuHoliday::getAll(); // return collection of holiday

```

## Get official apu holiday by year

```php

use Chengkangzai\ApuSchedule\ApuHoliday; 

ApuHoliday::getByYear(2023); // return collection of holiday

```

Example Output of Holiday Object

```php

[

    "holiday_description" => "New Year's Day",

    "holiday_end_date" => "Sat, 01 Jan 2022 00:00:00 GMT",

    "holiday_name" => "New Year's Day",

    "holiday_people_affected" => "all",

    "holiday_start_date" => "Sat, 01 Jan 2022 00:00:00 GMT",

    "id" => 336,

]

```

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [chengkangzai](https://github.com/chengkangzai)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.