Download the PHP package hollyit/token-replace without Composer
On this page you can find all versions of the php package hollyit/token-replace. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hollyit/token-replace
More information about hollyit/token-replace
Files in hollyit/token-replace
Package token-replace
Short Description Define tokens and replace the occurrences in strings.
License MIT
Homepage https://github.com/hollyit/token-replace
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package token-replace
Token Replace
This simple package allows you to define tokens that can be replaced in strings. Instead of a simple str_replace, Token Replace lets you add options to each token. Let's start with an example.
There is a certain anatomy to tokens, so let's take a look
at the {{ date:m }}. This is a default token format, but
this format is configurable globally and per instance.
| Part | Name | Global Setting | Local Setting |
|---|---|---|---|
| {{ | Token Start | $defaultStartToken | $instance->startToken() |
| date | Token Name | --- | --- |
| : | Token Separator | $defaultTokenSeparator | $instance->tokenSeparator() |
| m | Options | --- | --- |
| }} | Token End | $defaultEndToken | $instance->endToken() |
Transformers
The replacement of tokens is handled via a transformer. A transformer can be a closure or a simple class.
Transformers can be added to each instance of the TokenReplacer or added globally by executing the following in the bootstrap phase of your app:
Per instance tokens are added via $instance->with({token name}, {class name, transformer instance or closure}); For closure based transformers the signature is:
Included Transformers
All these transformers live under the \HollyIT\TokenReplace\Transformers namespace.
| Transformer | Description | Instantiating |
|---|---|---|
| ArrayTransformer | Extracts a value from an array based on a key. | The array |
| DateTransfomer | Extract parts of a date by PHP date format tokens. | Date object, Carbon, date string or null (assumes now()) |
| FileTransformer | Extract parts from a file based on pathinfo(). | The path string |
| ObjectTransformer | Extract a property from an object. | The object |
| UrlTransformer | Extract based on parse_url() | The URL string |
There are also special Laravel transformers residing in \HollyIT\TokenReplace\Transformers\Laravel
| Transformer | Description | Instantiating |
|---|---|---|
| AuthTransformer | Extract a property from the auth (user) object | none |
| DotArrayTransformer | Extract a property using Laravel's dot syntax | the array |
| ModelTransformer | Extract a property from an Eloquent model. For date properties, you can add the date part by specifying the format after the property name (ie: model:created_at,m) | The model |
| UploadFileTransformer | Extract the basename or extension from an UploadedFile object | The upload |
Post processing.
None of the transformers do any further processing except extracting the item. If you want to do further processing, such as escaping the replacements, you can define an onReplace callback:
This callback will run for every token occurrence found, so you can further filter down what tokens to operate on by checking the $token property.
Invalid or missing tokens
By default invalid and missing tokens will remain in the string. To prevent this, you can set removeEmpty() on the TokenReplacer.
Future Plans
This project was born out of a repeated scenario I faced on numerous projects. There are no real future plans for it. The entire objective here is a very simple solution to a common problem. You may find a transformer or feature that should be included. If so, please submit a PR. I'm very open on extending the project to cover more use cases.
