2017 © Pedro Peláez
 

library avetmiss

AVETMISS Validation and Report Generation

image

bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  • Tuesday, January 30, 2018
  • by bluedogtraining
  • Repository
  • 8 Watchers
  • 2 Stars
  • 7,764 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 21 Versions
  • 6 % Grown

The README.md

Avetmiss

This library is designed to help with the generation of AVETMISS NAT files., (*1)

Build Status, (*2)

Install

Via Composer, (*3)

``` bash $ composer require bluedogtraining/avetmiss, (*4)


## Usage

The idea behind the library is very simple.

1. Create fieldset with field definitions (or use a bundled fieldset)
2. Initiate a file with the fieldset.
3. Create a row from the file.
4. Populate the row.
5. Add the populated row back to the file.
6. Export the file.


```php
use Bdt\Avetmiss\File;
use Bdt\Avetmiss\Nat\V7\Nat120;

// array of student courses, pulled from the database
$studentcourses = DB::getStudentCourses();

// initiate a new nat file
$file = new File(new Nat120);

// loop through the studentcourses and add them to the file
foreach($this->studentcourses as $studentcourse) {

    try {
        $row = $file->createRow();

        $row->set('client_id', $studentcourse->Student->id);
        $row->set('subject_id', $studentcourse->Course->id);
        //...

        $file->writeRow($row);
    } catch(Exception $e) {
        // Display or log any errors.
    }
}

$file->export('nat120.txt');

Extending

The library comes with preliminary Fieldset definitions for AVETMISS Version 7 NAT files., (*5)

You can very easily add your own NAT files if required., (*6)

$myFieldset = new Fieldset([
    Field::make('date')->name('enrolment_date')->length(8),
    Field::make('numeric')->name('state_id')->length(2)->pad('0')->in(Config::keys('states')),
]);

Or own rules., (*7)

class MyOwnConfig extends Config
{
    protected static $deliveryTypes = [
        10 => 'Classroom-based',
        20 => 'Electronic based',
        30 => 'Employment based',
        40 => 'Other delivery (eg correspondence)',
        90 => 'Not applicable - recognition of prior learning/ recognition of current competency/ credit transfer'
    ];
}

Framework Integration

Laravel 5

This library comes with a service provider to add rules for validating against AVETMISS NAT fields., (*8)

To use this, first add the Bdt\Avetmiss\Frameworks\Laravel\ValidationServiceProvider to the providers array in config/app.php., (*9)

$validator = Validator::make([
    'my_start_date' => '01022000'
], [
    'my_start_date' => 'avetmiss:nat120,activity_start_date'
]);

$isValid = $validator->passes();

You can optionally pass a third boolean parameter to the avetmiss rule to enforce a maximum string length., (*10)

Zend Framework 1

This library comes with a utility for creating Zend Framework 1 validators based on AVETMISS NAT fields., (*11)

$factory = new Bdt\Avetmiss\Frameworks\Zf1\ValidatorFactory;
$validator = $factory->create('nat120', 'activity_start_date');
$validator->isValid('my_start_date');

You can optionally pass a third boolean parameter to the ValidatorFactory::create method to enforce a maximum string length., (*12)

Change log

Please see CHANGELOG for more information what has changed recently., (*13)

Testing

bash $ composer test, (*14)

License

The MIT License (MIT). Please see License File for more information., (*15)

Attribution

This library is based upon information provided in the AVETMISS VET Provider Collection Specifications, which is provided under a Creative Commons Attribution 3.0 Australia license., (*16)

The Versions

30/01 2018

dev-master

9999999-dev https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

30/01 2018

4.2.0

4.2.0.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

24/01 2018

4.1.1

4.1.1.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

24/01 2018

4.1.0

4.1.0.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

24/01 2018

4.0.5

4.0.5.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

15/01 2018

4.0.4

4.0.4.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

15/01 2018

4.0.3

4.0.3.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

15/01 2018

4.0.2

4.0.2.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

15/01 2018

4.0.1

4.0.1.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

12/01 2018

4.0.0

4.0.0.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

19/09 2017

3.0.8

3.0.8.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

26/08 2016

3.0.7

3.0.7.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

24/05 2016

3.0.6

3.0.6.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

05/05 2016

3.0.5

3.0.5.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

08/01 2016

3.0.4

3.0.4.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

14/12 2015

3.0.3

3.0.3.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

09/07 2015

3.0.2

3.0.2.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

01/07 2015

3.0.1

3.0.1.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

01/07 2015

3.0.0

3.0.0.0 https://github.com/bluedogtraining/avetmiss

AVETMISS Validation and Report Generation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Ryan Senn

avetmiss

24/03 2014

1.0.0

1.0.0.0 https://github.com/bluedogtraining/avetmiss

Avetmiss report generation

  Sources   Download

The Requires

  • php >=5.4.0

 

The Development Requires

by Ryan Senn

24/03 2014

2.0.0

2.0.0.0 https://github.com/bluedogtraining/avetmiss

Avetmiss report generation

  Sources   Download

The Requires

  • php >=5.4.0

 

The Development Requires

by Ryan Senn