Download the PHP package metarush/getter without Composer
On this page you can find all versions of the php package metarush/getter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package getter
metarush/getter
Generate a class with getter methods from a yaml or env file.
This is useful if you want to access variables in yaml/env files as PHP getter methods.
Install
Install via composer as metarush/getter
Sample usage
The following will generate a class named MyNewClass from contents of foo/sample.yaml using yaml adapter.
The generated class will be saved in foo/ folder.
via CLI
vendor/metarush/getter/bin/generate -a yaml -c MyNewClass -s tests/unit/samples/sample.yaml -l foo/
via PHP script
Sample yaml content
E.g., located in foo/sample.yaml
stringVar: 'foo'
intVar: 9
floatVar: 2.1
boolVar: true
arrayVar:
- foo
- 1.3
Sample generated class
E.g., located in foo/MyNewClass.php
Supported types
- string
- int
- float
- bool
- array (only available in
yamladapter)
Adapters
- yaml
- env
Advanced usage
Include namespace
Include a namespace, use ->setNamespace('MyNamespace') or via CLI --namespace MyNamespace
Extend class
Extend a class, use ->setExtendedClass('MyBaseClass') or via CLI --extendClass MyBaseClass
Dummify field values
Dummify field values, use the ->setDummifyValues(true) config method or via CLI --dummify
Why dummify?
It's useful for hiding sensitive data such as credentials. Credentials should not be in the source code. The field values of the generated classes with dummy data can later be repopulated (by your custom scripts) on runtime with actual values (see data replacer below). The generated class retains the data types even if the original values have been dummified.
If dummified, the generated field values are as follows:
Data replacer for dummified values
Dynamically change the values of the dummified data on runtime, use ->setConstructorType(\MetaRush\Getter\Config::CONSTRUCTOR_DATA_REPLACER); or via CLI --dataReplacer
You can then call the generated class and inject an array of replacement values on runtime:
Call parent
Call a parent class, use ->setConstructorType(\MetaRush\Getter\Config::CONSTRUCTOR_CALL_PARENT) or via CLI --callParent
Call parent and use data replacer
Call a parent class and also use data replacer, use ->setConstructorType(\MetaRush\Getter\Config::CONSTRUCTOR_BOTH) or via CLI --callParent --dataReplacer
Note: You should only call ->setConstructorType() once
Generate constants
Generate the key/value pairs as constants, use ->setGenerateAsConstants(true) or via CLI --constants.
Generate constants with key as both constant name and value
Use ->setGenerateAsConstants(true) and ->setConstantNameAsValue(true) or via CLI --constants --constantNameAsValue.
Don't generate getter methods
Use ->setNoMethods(true) or via CLI --noMethods. Usually used when you only want to generate constants.