aedart / model-vendor-path
Getter and Setter package for a vendor path. This package is part of the 'Aedart\Model' namespace; visit https://bitbucket.org/aedart/model to learn more about the project. Official sub-package website (https://bitbucket.org/aedart/model-vendor-path).
Requires
- php: >=5.5.9
- aedart/validate: >=0.9.1 <2.0
Requires (Dev)
- aedart/license: 1.*
- aedart/license-file-manager: 1.*
- codeception/codeception: 2.0.*
- fzaninotto/faker: 1.5.*
Suggests
- aedart/overload: Provides means to dynamically deal with inaccessible properties, by implementing PHP’s magic methods; __get(), __set(), __isset(), and __unset().
This package is auto-updated.
Last update: 2022-02-01 12:46:21 UTC
README
Getter and Setter package for a vendor path.
This package is part of the 'Aedart\Model' namespace; visit https://bitbucket.org/aedart/model to learn more about the project.
Official sub-package website (https://bitbucket.org/aedart/model-vendor-path).
Contents
[TOC]
When to use this
When your component(s) need to be aware a vendor path
How to install
#!console
composer require aedart/model-vendor-path 1.*
This package uses composer. If you do not know what that is or how it works, I recommend that you read a little about, before attempting to use this package.
Quick start
Provided that you have an interface, e.g. for a installer, you can extend the vendor-path-aware interface;
#!php
<?php
use Aedart\Model\Vendor\Path\Interfaces\VendorPathAware;
interface IInstaller extends VendorPathAware {
// ... Remaining interface implementation not shown ...
}
In your concrete implementation, you simple use the vendor-path-traits;
#!php
<?php
use Aedart\Model\Vendor\Path\Traits\VendorPathTrait;
class MyInstaller implements IInstaller {
use VendorPathTrait;
// ... Remaining implementation not shown ...
}
Composer's vendor directory
By default the VendorPathTrait
does not contain any default vendor path. However, if you need to refer to composer's vendor-dir
, then you can use the ComposerVendorPathTrait
, which guesses the full path to the vendor directory,
based upon the filesystem location of Composer's ClassLoader
file.
#!php
<?php
use Aedart\Model\Vendor\Path\Traits\ComposerVendorPathTrait;
class MyInstaller implements IInstaller {
use ComposerVendorPathTrait;
// ... Remaining implementation not shown ...
}
License
BSD-3-Clause, Read the LICENSE file included in this package