Download the PHP package ilya/block without Composer
On this page you can find all versions of the php package ilya/block. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 block
Block
Block makes parsing PHP DocBlocks easier.
Simple, documented and fully tested. PHP 5.4 is required.
Installation
Using Composer: composer require "ilya/block:~1".
Example
Imagine you have the following code:
First, instantiate Block, like so: $block = new Block\Block(new Foo);.
Now you can begin to inspect the docblocks using these 4 methods available.
Block\Comment property(string $name)array properties(integer $filter)Block\Comment method(string $name)array methods(integer $filter)Block\Comment reflector(Reflector $reflector)
Methods property and method will receive a name (as a string) and return an instance
of Block\Comment. Methods properties and methods will receive an optional argument $filter
and return an array of Block\Comment instances.
If you are wondering what that $filter thing is, take a look at the example:
Ok, so now that you have an instance (or many of them) of \Block\Comment,
what kind of actions can you perform?
- convert the instance to a string:
$comment->getComment(). Note that(string) $commentwould work too! - split it into lines:
$comment->getLines().
Let's review the second option.
Calling the getLines() method will return an array, each element of which is an instance of \Block\Line.
Here's what it offers:
boolean isTag(void)- determine whether the line contains a tag: will be true for@param int $speedand false forMy desc.string getLine(void)- get the line itself, as a string, note that(string) $linewould also work.array tokenize(void)- split the line into "tokens" - e.g@param int $speedwill be represented as['@param', 'int', '$speed']. All white spaces are ignored.string stripTag(void)
So that's it, hopefully you now can start to use Block in your projects.
License
Block is licensed under the MIT license.
