Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohammedibrahim/boarding-cards
Sort Boarding cards
https://github.com/mohammedibrahim/boarding-cards
boarding-cards
Last synced: about 2 months ago
JSON representation
Sort Boarding cards
- Host: GitHub
- URL: https://github.com/mohammedibrahim/boarding-cards
- Owner: mohammedibrahim
- Created: 2017-11-17T18:09:55.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T01:54:00.000Z (almost 2 years ago)
- Last Synced: 2023-08-07T03:38:25.299Z (over 1 year ago)
- Topics: boarding-cards
- Language: PHP
- Size: 956 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Boarding Card Sorter
- [Description](#description)
- [Installation](#installation)
- [How To use](#how-to-use)
- [New Transportation Type](#new-transportation-type)
- [New Boarding Card Attribute](#new-boarding-card-attribute)
- [New Output Format](#new-output-format)
- [PHP Docs](#php-docs)
- [Test Cases](#test-cases)
## Description
You are given a stack of boarding cards for various transportation that will take you from a point
A to point B via several stops on the way. All of the boarding cards are out of order and you don't
know where your journey starts, nor where it ends. Each boarding card contains information
about seat assignment, and means of transportation (such as flight number, bus number etc).
## Installation
Using composer :
```bash
git clone http://github.com/mohammedibrahim/boarding-cards.git
cd boarding-cards
composer install
php index.php
```
## How To use
To enter the details of the boarding cards.
```php
$boardingCards = new SortingBoardingCards();
//Flight Boarding Card
$boardingCards->addBoardingCard(FlightBoardingCard::instance()->createBoardingCard([
'from' => 'Stockholm',
'to' => 'New York JFK',
'seat_number' => '7B',
'transportation_number' => 'SK22',
'gate_number' => '22',
'baggage_details' => 'Baggage will we automatically transferred from your last leg',
]));
//Bus Boarding Card
$boardingCards->addBoardingCard(BusBoardingCard::instance()->createBoardingCard([
'from' => 'Barcelona',
'to' => 'Gerona Airport',
]));
// Flight Boarding Card
$boardingCards->addBoardingCard(FlightBoardingCard::instance()->createBoardingCard([
'from' => 'Gerona Airport',
'to' => 'Stockholm',
'seat_number' => '3A',
'transportation_number' => 'SK455',
'gate_number' => '45B',
'baggage_details' => 'Baggage drop at ticket counter 344',
]));
//Train Boarding Card
$boardingCards->addBoardingCard(TrainBoardingCard::instance()->createBoardingCard([
'from' => 'Madrid',
'to' => 'Barcelona',
'seat_number' => '45B',
'transportation_number' => '78A'
]));
//Sort Cards and output as string
$boardingCards->sort()->output(StringOutputFormat::instance());
```
## New Transportation Type
You may need to create a new boarding card.
Go to
```
boarding-cards -> app -> BoardingCardsTypes
```
Create a new class
```php
'Barcelona',
'to' => 'Gerona Airport',
```
To add new attribute like seat_number and transportation_number, You must implement it's interfaces.
```php
'',
'transportation_number' => '',
];
/**
* Seat Number.
*
* @var
*/
protected $_seatNumber;
/**
* Transportation Number.
*
* @var
*/
protected $_transportationNumber;
/**
* Set Seat Number.
*
* @return mixed
*/
public function setSeatNumber($seatNumber)
{
$this->_seatNumber = $seatNumber;
return $this;
}
/**
* Must Return Seat number
*
* @return mixed
*/
public function getSeatNumber()
{
return $this->_seatNumber;
}
/**
* Set Transportation Number.
*
* @return mixed
*/
public function setTransportationNumber($transportationNumber)
{
$this->_transportationNumber = $transportationNumber;
return $this;
}
/**
* Must Return Gate number
*
* @return mixed
*/
public function getTransportationNumber()
{
return $this->_transportationNumber;
}
/**
* Output Boarding Card Text to string.
*
* @return mixed
*/
public function outputToString()
{
// Return text to be added.
return 'Text';
}
}
```
Available custom attributes for boarding cards is
```php
//Baggage Details
//'baggage_details' => 'Baggage will we automatically transferred from your last leg',
BoardingCards\Contracts\BaggageBoardingCardAttributes;
// Gate Number
//'gate_number' => '22',
BoardingCards\Contracts\GateBoardingCardAttributes;
//Seat Number
//'seat_number' => '7B',
BoardingCards\Contracts\SeatableBoardingCardAttributes;
// Trasportation Number eg. Train No. 45
//'transportation_number' => 'SK22',
BoardingCards\Contracts\TransportationNumberBoardingCardAttributes;
```
## New Boarding Card Attribute
To create a new custom attribute for a boarding card
Go to
```
boarding-cards -> app -> Contracts
```
Create a new interface
```php
'',
'transportation_number' => '',
'custom_boarding_card_attribute' => '';
];
/**
* Seat Number.
*
* @var
*/
protected $_seatNumber;
/**
* Transportation Number.
*
* @var
*/
protected $_transportationNumber;
/**
* Transportation Number.
*
* @var
*/
protected $_customBoardingCardAttribute;
/**
* Set Seat Number.
*
* @return mixed
*/
public function setSeatNumber($seatNumber)
{
$this->_seatNumber = $seatNumber;
return $this;
}
/**
* Must Return Seat number
*
* @return mixed
*/
public function getSeatNumber()
{
return $this->_seatNumber;
}
/**
* Set Transportation Number.
*
* @return mixed
*/
public function setTransportationNumber($transportationNumber)
{
$this->_transportationNumber = $transportationNumber;
return $this;
}
/**
* Must Return Gate number
*
* @return mixed
*/
public function getTransportationNumber()
{
return $this->_transportationNumber;
}
/**
* Set Custom Boarding Card Attribute.
*
* @return mixed
*/
public function setCustomBoardingCardAttribute($customBoardingCardAttribute)
{
$this->_customBoardingCardAttribute = $customBoardingCardAttribute;
return $this;
}
/**
* Must Return Seat number
*
* @return mixed
*/
public function getCustomBoardingCardAttribute()
{
return $this->_customBoardingCardAttribute;
}
/**
* Output Boarding Card Text to string.
*
* @return mixed
*/
public function outputToString()
{
// Return text to be added.
return 'Text';
}
}
```
To call New created boarding card
```
NewTransportationCard::instance()->createBoardingCard([
'from' => 'Stockholm',
'to' => 'New York JFK',
'seat_number' => '7B',
'transportation_number' => 'SK22',
'custom_boarding_card_attribute' => 'Custom Text Value for new custom attribute',
])
```
## New Output Format
To create a new output format
Go to
```
boarding-cards -> app -> OutputFormater
```
Create a new class that extend AbstractStringOutputFormat class and implement OutputFormat interface
```php
/**
* New output format.
*
* Class NewOutputFormat
* @package BoardingCards\OutputFormats
*/
class NewOutputFormat extends AbstractStringOutputFormat implements OutputFormat
{
/**
* Format boarding card output
*
* @param $data
* @return mixed
*/
public function format($data)
{
// output the result as you wish for each card.
}
/**
* Output boarding cards
*
* @param $boardingCards
* @return mixed
*/
public function allCardsFormat($boardingCards)
{
// Output the resutl as you wish for all cards.
// Final output.
}
}
```
To use it
```php
$boardingCards->sort()->output(NewOutputFormat::instance());
```
## PHP Docs
To View php docs
Go to
```html
http://[your_app_url]/docs/index.html
```
To Update docs
At app root directory Run
```bash
php vendor/bin/phpdoc -d app/ -t docs --title="Boarding Cards Sorter"
```
## Test Cases
To Run test cases. From app root directory
Run
```
php vendor/bin/phpunit tests/SortingBoardingCardsTest.php --testdox
```