Code Monkey home page Code Monkey logo

hofuniversitycanteenapi's Introduction

PersistentObjectStorage

Release PHP

Introduction

HofUniversityCanteenAPI is a small functional libary for accessing and filtering the canteen plan of Hof University.
It is written in PHP 7.3 and above. HofUniversityCanteenAPI is not supported nor endorsed by Studentenwerk Oberfranken or Hochschule Hof.

Data structure

classDiagram
    Week "1" -- "n" Day
    Day "1" -- "n" Dish

    class Week{
      +array days
    }

    class Day{
      +string name
      +DateTime date
      +array mainCourses
      +array sideDishes
      +array desserts
      +array salads
    }

    class Dish{
      +string name
      +array attributes
      +double collegeStudentPrice
    }      

Functions

Just copy the "HofUniversityCanteenAPI"-folder in your project and import the the used functions:

include "HofUniversityCanteenAPI/Helper.php";
use function HofUniversityCanteenAPI\convertAllUnconvertedDataToWeek;
use function HofUniversityCanteenAPI\convertWeekToFormatedGermanString;
use function HofUniversityCanteenAPI\downloadAllUnconvertedData;
use function HofUniversityCanteenAPI\filterWeekByAttributeIdsAndDayNumber;

You can use the following self-explanatory functions:

  • getAttributeIdsTable():array
  • downloadAllUnconvertedData(dayNumber:int, monthNumber:int):SimpleXMLElement
  • convertAllUnconvertedDataToWeek(allUnconvertedData:SimpleXMLElement):Week
  • filterWeekByAttributeIdsAndDayNumber(week:Week, attributeIds:array, dayNumber:int):Week
  • convertWeekToFormatedGermanString(week:Week):string

Testing

The library was tested manually. I could not find any bugs, but there still may be some.

Example

You can find a realistic example here.

Get in contact

Feel free to get in contact and share your experience with HofUniversityCanteenAPI. Bug reports are also very appreciated.

hofuniversitycanteenapi's People

Contributors

stevensolleder avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.