BrazilHoliday

Brazil Holiday

Brazil Holiday is a PHP library that says whether or not it is a holiday, for now we have only the most important holidays but we are constantly updated and always adding new holidays!

Starting

Installing

The library can be installed by the composer (and is the most recommended), the command to install is this below:

 composer require gs-nasc/brazil-holiday

via packagist

Implementing

The library is easy to implement and use below are example codes:
Note Remember to carry the composer autoad

Any date

 use BrazilHoliday  Holiday ;

$ holiday = new Holiday ();

// Aqui carregamos o ano que vamos usar para encontrarmos o feriado
// Somente feriados que não são dias úteis (Ex: Natal)
$ holiday -> load ( 2021 );

// Todos os feriados ( Ex: Dia da Bandeira )
$ holiday -> load ( 2021 , " all " );

// troque 2021 pelo ano que irá utilizar

// No lugar de 01/01/2021 coloque a data que você quer 
//saber se é feriado, siga o padrão que está ali!
$ date = DateTime:: createFromFormat ( ' d/m/Y ' , ' 01/01/2021 ' );

// Finalmente verificamos se é ou não feriado
$ feriado = $ holiday -> isHoliday ( $ date );

echo  ( $ feriado ) ? " Feriado " . $ feriado -> title : " Não é feriado " ;

// OU

if ( $ feriado ) {
    $ foo = " Feriado " . $ feriado -> title ;
} else {
    $ foo = " Não é feriado " ;
}


echo $ foo ;

Today

 use BrazilHoliday  Holiday ;

$ holiday = new Holiday ();

// Aqui carregamos o ano que vamos usar para encontrarmos o feriado
// Somente feriados que não são dias úteis (Ex: Natal)
$ holiday -> load ( 2021 );

// Todos os feriados ( Ex: Dia da Bandeira )
$ holiday -> load ( 2021 , " all " );

// troque 2021 pelo ano que irá utilizar

// Finalmente verificamos se é ou não feriado
$ feriado = $ holiday -> todayHoliday ();

echo  ( $ feriado ) ? " Feriado " . $ feriado -> title : " Não é feriado " ;

// OU

if ( $ feriado ) {
    $ foo = " Feriado " . $ feriado -> title ;
} else {
    $ foo = " Não é feriado " ;
}


echo $ foo ;

Tomorrow

 use BrazilHoliday  Holiday ;

$ holiday = new Holiday ();

// Aqui carregamos o ano que vamos usar para encontrarmos o feriado
// Somente feriados que não são dias úteis (Ex: Natal)
$ holiday -> load ( 2021 );

// Todos os feriados ( Ex: Dia da Bandeira )
$ holiday -> load ( 2021 , " all " );

// troque 2021 pelo ano que irá utilizar

// Finalmente verificamos se é ou não feriado
$ feriado = $ holiday -> tomorrowHoliday ();

echo  ( $ feriado ) ? " Feriado " . $ feriado -> title : " Não é feriado " ;

// OU

if ( $ feriado ) {
    $ foo = " Feriado " . $ feriado -> title ;
} else {
    $ foo = " Não é feriado " ;
}


echo $ foo ;

Yesterday

 use BrazilHoliday  Holiday ;

$ holiday = new Holiday ();

// Aqui carregamos o ano que vamos usar para encontrarmos o feriado
// Somente feriados que não são dias úteis (Ex: Natal)
$ holiday -> load ( 2021 );

// Todos os feriados ( Ex: Dia da Bandeira )
$ holiday -> load ( 2021 , " all " );

// troque 2021 pelo ano que irá utilizar

// Finalmente verificamos se é ou não feriado
$ feriado = $ holiday -> yesterdayHoliday ();

echo  ( $ feriado ) ? " Feriado " . $ feriado -> title : " Não é feriado " ;

// OU

if ( $ feriado ) {
    $ foo = " Feriado " . $ feriado -> title ;
} else {
    $ foo = " Não é feriado " ;
}


echo $ foo ;

When the library is holiday returns an object with the following attributes:

• Title (Holiday Title. Ex: New Year)
• Date (holiday date. Ex: 01/01/2021)
• Type (Holiday Type. Ex: National Holiday)

When it is not a holiday the library returns false

How to help?

If you are missing a holiday or want to get some bug that found the steps below:

Add new holiday

Fixed holiday

To add a new fixed holiday (eg Christmas) just make a fork of this resposterory and edit the Dates.json file that echoes in the src/ Following your standards, when finishing just make a pull Request that I will analyze the order and if I fit the library I will add to the project.

Mobile holiday

To add a new mobile holiday just open a issue saying which holiday I will look for a method of adding it to the project

Bug

If you want to fix a bug just do fork of the project, pack the bug and test to see if everything keeps working, if everything works to make a pull request to be implemented.

Available holiday table

	Status
New Year	✔️
International Women's Day	✔️
Lying Day	✔️
Day of the Indian	✔️
Tiradentes	✔️
Discovery of Brazil	✔️
Labor Day	✔️
DAY OF ABOLITION OF SLAVATING	✔️
World Environment Day	✔️
Valentine's Day	✔️
St. John's Day	✔️
Friend's day	✔️
Grandparents' day	✔️
Student Day	✔️
Folklore Day	✔️
Soldier's Day	✔️
Independence of Brazil	✔️
Tree day	✔️
International Peace Day	✔️
Children's Day	✔️
Our Lady Aparecida	✔️
Teacher's Day	✔️
National Book Day	✔️
Halloween	✔️
Tie	✔️
Proclamation of the Republic	✔️
Flag Day	✔️
National Black Awareness Day	✔️
International Human Rights Day	✔️
Christmas Eve	✔️
Christmas	✔️
New Year's Eve	✔️
Carnival	✔️
Easter	✔️
Good Friday	✔️
Corpus Christ	✔️
Mother's Day	✔️
Father's Day	✔️
Public Servant Day	✔️