Download the PHP package crodas/notoj without Composer
On this page you can find all versions of the php package crodas/notoj. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package notoj
Short Description Annotation parser. Uses reflection and provides cache out of the box.
License BSD-4-Clause
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 notoj
Notoj 
Yet another annotation parser (DocBlocks). It's designed to be simple and intuitive. It extends the Reflection methods inside the Notoj namespace (ReflectionClass, RefletionProperties, ReflectionMethod so far), and adds the getAnnotations() method.
The getAnnotations() returns an array, with a very simple array structure (array("method" => "Foo", "args" => NULL))
How to use it
Notoj supports works under two scenearios, offline and online parsing.
Online
Online parsing means that you want to retrieve annotations from an object, class or function that exists at run time. To use you'd need to use Reflection classes from the Notoj namespace.
Offline
Offline parsing means that you want to get annotations from a file or directory and you rather not include them to use the online API. Notoj provides the Notoj\File and \Notoj\Dir classes to do that. They both return Annotations object which behaves as an array of Annotation (the output the online API), plus with a few extra things such as the file, line.
File
Dir
Annotation object
It is the output object that represents an annotation. It is important that you notice that it does represents the annotations in a object, class or function and not a single annotation.
It provides ->get($tag) and ->has($tag) filters that helps processing the object.
Annotations object
It is an object that behaves like an array of Annotation object. Provides a very simple filter ->get($name) and ->has($name).
Format
Warning: Notoj will do its best effort to parse broken annotations, but if there is an error it will fail silently. Also, in the @foo bar foobar format whitespaces are ignored.
Caching support
Notoj supports caching that will help the Notoj's engine to avoid parsing over and over the same string. The cache will be invalidated automatically.
To enable this feature you need to specify which file should be used to save the cache, Notoj will do the rest :-).
Todo
- Cache for offline parsing
Feel free to email fork and submit pull requests or write me [email protected]
All versions of notoj with dependencies
crodas/class-info Version ^0.2
crodas/file-util Version ^0.2
nikic/php-parser Version ^2.0 | ^1.0
crodas/remember Version >=0.4.2