README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require shakewell/laravel-agile-plm

You can publish the config file with:

php artisan vendor:publish --tag="agile-plm-config"

This is the contents of the published config file:

return [
    'soap_endpoint' => env('AGILE_PLM_SOAP_ENDPOINT'),
    'username' => env('AGILE_PLM_SOAP_USERNAME'),
    'password' => env('AGILE_PLM_SOAP_PASSWORD'),
];

Agile PLM SOAP access uses basic authentication.

Usage

This package contains services that can be injected into the controller via Laravel Dependency Injection

use Shakewell\LaravelAgilePlm\Services\AgilePlmService;

public function handle(AgilePlmService $agilePlmService){
 // Code Here
}

The AgoilePlmService contains different search methods

Search for Document using Document Number and Document Revision

$results = $agilePlmService->searchDocumentByNumberAndRevision("0200-06288-1000", "C");

This method will return an AgileDocument class with the following properties or null if no document is found.

    public string $id;
    public string $documentNumber;
    public string $revision;
    public string $description;
    public string $lifeCyclePhase;
    public string $ItemType;

Search for ECO using Document Number and Document Revision

$results = $agilePlmService->searchEcoByDocumentNumberAndRevision("0200-06288-1000", "C");

This method will return an AgileChange class with the following properties or null if no ECO is found.

    public string $number;
    public string $description;

Search for ECR using Document Number and Document Revision

$results = $agilePlmService->searchEcrByDocumentNumberAndRevision("0200-06288-1000", "C");

This method will return an AgileChange class with the following properties or null if no ECO is found.

    public string $number;
    public string $description;

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

shakewell / laravel-agile-plm

Maintainers

Details