Download the PHP package enzyme/parrot without Composer
On this page you can find all versions of the php package enzyme/parrot. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download enzyme/parrot
More information about enzyme/parrot
Files in enzyme/parrot
Package parrot
Short Description Mockable native static functions for PHP.
License MIT
Homepage https://github.com/enzyme/parrot
Informations about the package parrot
Mockable native static functions for PHP.
What is it?
Do you have a class method that calls a PHP native/built-in function like file_get_contents
, which you then test by having to create a dummy file for it to ingest? Well, say hello to Parrot. Now you can inject the built-in File functions, along with many others as a dependency which you can mock out during tests.
Installation
Example
Let's take a look at what used to happen:
Using the built in method.
Testing...
The problem with the above is, actual_file.txt
needs to reside in your test folder, get shipped with your tests, have the correct permission etc... it's a hassle.
Now using Parrot.
Testing...
Now we just fake the file and it's contents, sweet!!!
Sugar
You may have noticed in the above example that the Parrot version of file_get_contents
was simply getContents()
.
With all the Parrot'd wrappers around PHP's functions, we leave off the prefix. Who wants to repeat themselves?
The function name rules.
-
If the original function name starts with a prefix like
file_
,f
,curl_
,imap_
,mysql_
etc, you simply leave them off when using the equivalent class wrapper. -
If the original name has an underscore in it, replace it with camelCase. So for example
file_get_contents
becomesgetContents
andmysql_affected_rows
becomesaffectedRows
. -
If the original name has a string of words, they are converted to camelCase too. For example
imap_createmailbox
becomescreateMailbox
. - If the original function, following the rules above now starts with a number, replace then number with it's spelt equivalent. For example
imap_8bit
becomeseightBit
.
Wrappers
The follow wrappers are currently available:
Name | Prefixes removed |
---|---|
Curl | curl_ |
File | file, file_, f |
Ftp | ftp_ |
Gz | gz |
Image | image |
Imap | imap_ |
MySql | mysql_ |
PostgreSql | pg_ |
Sqlite | sqlite_ |
Glob | glob (Simply becomes execute ) |
Missing something?
If there's a particular wrapper you're looking for and it isn't listed above, open a new issue, or simply extend Parrot
following the rules in the existing wrappers and send a PR. Please check out CONTRIBUTING.md
as well.