🎁 Name day library [WIP]
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
nbproject
src/WebinoNameDayLib
test
vendor
.gitignore
.travis.yml
LICENSE.txt
README.md
build.properties
build.xml
composer.json

README.md

Webino Name Day Library

Build Status Build Status

Provides API to resolve name day. Still under development. (currently only Slovak)

Features

  • Today and tomorrow name day according to the date
  • Reverse resolving, name day date for a name
  • Holy day flag

Setup

Following steps are necessary to get this library working:

  1. Add "minimum-stability": "dev" to your composer.json, because this lib is under development

  2. Run php composer.phar require webino/webino-name-day-lib:dev-develop

Requirements

  • PHP 5.3

QuickStart

    // Create the name day service
    $locale  = 'sk_SK';
    $factory = new \WebinoNameDayLib\Factory;
    $nameDay = $factory->create($locale);

    // Get the name day
    $result = $nameDay->today();

    // Holy day logic (optional)
    if ($result->isHolyDay()) {
        $text = 'Today is';
    } else {
        $text = 'Name-day today celebrating';
    }

    // Name day of the day
    $result->getName();

    // Get tomorrow name day
    $result = $nameDay->tomorrow();

    // Get today & tomorrow name day
    $arrayOfResults = $nameDay->combo();

Functions

The service

  • NameDayResult today($date = 'now')
  • NameDayResult tomorrow($date = 'now')
  • array[NameDayResult, NameDayResult] combo($date = 'now')
  • DateTime nameDate($name)
  • DateTime nearestNameDate($name)

The result

  • string getName()
  • bool isHolyDay()

Develop

Requirements

  • Linux (recommended)
  • NetBeans (optional)
  • Phing
  • PHPUnit

Setup

  1. Clone this repository and run: phing update

    Now your development environment is set.

  2. Open project in the (NetBeans) IDE

Adding region names

  1. Look at the \WebinoNameDayLib\Region\Sk
  2. It's best to extend \WebinoNameDayLib\Region\AbstractNames

Testing

  • Run phpunit in the test directory

  • Run phing test in the module directory to run the tests and code insights

    NOTE: To run the code insights there are some tool requirements.

Todo

  • Add Czech names
  • Add other nation names
  • Tests for nameDate() & nearesetNameDate()

Addendum

Please, if you are interested in this library report any issues and don't hesitate to contribute.