Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 7 years ago.
Improve this question
Does anybody use anything else to document their PHP code than PHPDoc?
Are there any tools that read the same documentation syntax but give richer output?
I´ll go for doxygen too.
Here are several reasons :
compatible with phpdoc tags and other popular ones : it´s interoperable
works with various programming languages : a better time investment
there is alternative syntaxes : can choose the commenting style that suit you
very efficient with advanced formating / tagging / metadata
there is a GUI that is not linked to any IDE and an eclipse plugin as well
And still free, multiplatform, and open source :-)
It´s easy to learn, but harder that phpdoc because a lot richer.
You could try DocBlox; which is intended to be an alternative for phpDocumentor but with support for additional features of which full PHP 5.3 support is one. An additional benefit is that is it quite fast and uses relatively little memory.
You can read more on http://www.docblox-project.org or see a demo at http://demo.docblox-project.org/default
Another option other than phpDocumentor is Doxygen documentation with PHP support.
Doxygen (www.doxygen.org).
ApiGen
http://apigen.org/
ApiGen has support for PHP 5.3 namespaces, packages, linking between documentation, cross referencing to PHP standard classes and general documentation, creation of highlighted source code and experimental support for PHP 5.4 traits.
DocBlox
http://www.docblox-project.org/
PHP 5.3 compatible API Documentation generator aimed at projects of all sizes and Continuous Integration.
able to fully parse and transform Zend Framework 2
I've not used it with PHP, but doxygen claims to support the language.
I am using Doxygen too - you get used to the various keywords really fast - they are kind of self-explaining. ;)
RubyDoc is nice too, I espcially like they layout of the rdocs.
Doctrine uses PHPDoctor, which appears to work well with 5.3 in my tests.
http://peej.github.com/phpdoctor/#download
If you need to document code for PHP 5.3+, eg. if it uses namespaces Ted Kulp's fork of PHPDoctor might be your answer.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 1 year ago.
Improve this question
Is there any library that can be used to write custom data files from a PHP app in ORC or Parquet format for Presto queries ?
If not what is the best practice in this case? Hopefully one that doesn't involve setting up Map Reduce cluster.
10X
- Nir
Sorry for bumping, but I felt this question should be updated.
Last year, I released the first publicly available PHP library for reading/writing Parquet files, php-parquet.
See https://github.com/jocoon/php-parquet and/or the published composer package https://packagist.org/packages/jocoon/parquet (composer require jocoon/parquet). It is a partial port of and inspired by parquet-dotnet, based on the Apache Thrift specifications.
As far as you don't have special compression needs (e.g. snappy), you won't need exotic PHP extensions. BCMath and GMP are required, due to the possibility of arbitrary-precision numbers and you'll need to have zlib available (AFAIK the most-used/typical compression method for Parquet files, to be more precise: gzip).
Basic usage instructions are provided on the respective github page.
DISCLAIMER: I'm the developer of this package. This is not meant as advertising. The library is published under the MIT license. Feel free to submit issues or contribute.
There is the https://github.com/apache/parquet-cpp project that provides a C++ implementation to write Parquet files without any use of MapReduce or the JVM. While there are already Python (https://arrow.apache.org/docs/python/parquet.html), Ruby / GLib (https://github.com/red-data-tools/parquet-glib) and NodeJS (https://github.com/skale-me/node-parquet) bindings, there are none yet for PHP. But given those mentioned bindings, you should be able to write ones for PHP quite easily.
We’ve Apache licensed https://github.com/skipprd/php-parquet, a PHP binding for the C++ https://github.com/apache/parquet-cpp implementation that’s been battle tested by skippr.io.
Pleased to see another effort on jocoon/php-parquet too. So now there’s a C binding and a PHP implementation to choose from! :)
DISCLAIMER: I'm the developer of this package. This is not meant as advertising. The library is published under the Apache license. Feel free to submit issues or contribute.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 7 years ago.
Improve this question
I am new to PHP and was wondering whether there is a tool which checks the PHP code syntax and validity.
For example if I have:
class myClass
{
public function function1()
{
$this->myvariable++;
$this->function2();
}
private $myVariable;
}
I would like the tool to highlight that the variable myvariable and the function function2 does not exist within that class.
I have searched online and found http://www.icosaedro.it/phplint/index.html however when I tried it in my PHP project it did not work correctly. I know that php has the -l option, however that only checks for syntax not validity.
Any help would be greatly appreciated.
It sounds like you're looking for an IDE.
PHPStorm is a popular paid IDE for PHP. (~99$/~99€)
Netbeans is also popular, as well as being free.
I've also heard of phpDesigner, Komodo IDE, and Zend Studio. Also, you can find a list of PHP Editors here.
The kind of tool you're looking for, strictly speaking, is a static analysis tool such as PHP Mess Detector. An even simpler (and faster) check can be run from PHP itself using the -l switch, but will only warn against syntax errors.
More advanced checks against code smells, which are somewhat less than bugs but have been found to often evolve into those, can be run by tools such as CodeSniffer for PHP.
That said, the tools above (and many more) are either already bundled, or can be easily integrated, into various IDEs such as Eclipse for PHP. These also supply useful integrations such as code highlighting and inline error highlighting, so that you can quickly "zoom in" on the various bugs. Also, they come with a ton of useful features such as code completion, lookups, insight, templating, and refactoring. More advanced IDEs also "know" about the most popular frameworks and so can be a great help in using them.
You are searching for Integrated Development Environment or shortly IDE, which is software with a lot built in functions to help you to write, test, develop, debug etc... your software.
If we are talking about PHP programming language I prefer them in the following order:
Netbeans
PhpStorm
phpDesigner
Zend Studio
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 6 years ago.
Improve this question
I'm wondering if there are any completely event-drive frameworks out there for PHP which are based around dependency injection for decoupling. I know there are some frameworks that make use of these patterns - but in the end the entire life-cycle of the application is still pre-defined and linear in style.
For example, most frameworks are built to receive, process, and return results from HTTP requests. An event drive framework would have handlers for that, but also be able to be used for new purposes like background processing, command line interaction, or other non-standard use cases.
It sounds to me like the Photon framework fits closest to your description - the key point is that you can't have event-driven code without php running in a daemon-like process. Your choice of webserver in fact dictates whether what you ask is possible or not - photon is dependent on mongrel2.
I have never used it for a project personally, but I believe that Prado covers what you are asking. It is componentised, but I cannot be sure about the dependency injection aspect.
From their site:
PRADOTM is a component-based and event-driven programming framework for developing Web applications in PHP 5. PRADO stands for
PHP Rapid Application Development Object-oriented.
I know of it because one of my university class mates designed the logo and website for the project.
Not used it, but I believe in addition to Prado, which Treffynnon has mentioned, Qcodo is a pure event-driven framework.
I was looking what is around as well and i came across p4e which is based on zend framework,and nette, hope it can help!
Off the bat there are these 2 as well:
Zend Framework 2 (still in beta)
symfony 2
Both have all the things you are looking for I believe.
Symfony2. Simple as that.
http://symfony.com/
Yii ,It is a component based and event-driven framework, Pure OOP and MVC. It is very clean and neat. Check it out.
http://www.yiiframework.com
The Qbix Platform is heavily event-driven in PHP, although it does not use dependency injection.
Reactphp is what you are looking for.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I never cared much about documenting my code before, but recently I started working on an open source project and the need arose. Obviously the 'weapon of choice" is PHPDoc, but...
I couldn't really find a single specification of the PHPDoc standard. There is a wikipedia entry listing some of the properties and there is the phpDocumentor project, which supposedly has a more extensive dictionary, but what puzzles me is where is the definitive guide of PHPDoc? Is there a single standard or it is up to all those numerous phpDocumentor knockoffs to extend the PHPDoc "standard" (if any) to whatever they seem fit.
If we assume that phpDocumentor is the place where the PHPDoc standard is created and maintained, things look pretty grim, since the project's website is dead for for about almost 4 years now. And what puzzles me even more is that about a month ago a version 1.4.4 suddenly appeared from the dead on the Pear site of phpDocumentor.
I know there are a lot more smarted and knowledgable fellows around here, so I would like to know. What is the deal with PHPDoc. Is there a single authority that creates the standard? How reliable is it? Is there any future or we are dealing with a zombie and all hope is lost...
Thanks,
Ivo
According to Wikipedia it's dead.
The specifications for the standard for PhpDoc tags used to be what was listed in the documentation for PhpDocumentor. But like I said, it's dead. As DocBlox seems to be filling the void that PhpDocumentor left, I'd advise using the DocBlox documentation as the basis for how you do your PhpDoc comments.
I'm hoping Netbeans 7.1 will introduce DocBlox support because it's so much better. It's PHP 5.3 aware and it's actively maintained.
This question is already a bit old, but for the sake of information, I should add that DocBlox was merged with PhpDocumentor.
Announcing phpDocumentor 2 – the merging of the old (phpDocumentor)
and the new (DocBlox).
With the first alpha release of phpDocumentor (2.0.0a1), the new
“Responsive” default template sports a new page layout, along with the
useful layout improvements that the original DocBlox templates
provided (which remain available) over the old phpDocumentor templates
(which will retire with old phpDocumentor). Explore this new template
at http://demo.phpdoc.org/Responsive/index.html.
=> http://www.docblox-project.org/2012/03/docblox-is-unmasked-it-is-really-phpdocumentor-2/
PHPDoc is back to the action. =)
As of Aug. 2013 the the PHP Framework Interoperability Group began began writing a formal specification (PSR) for PHPDoc. The proposed standard for PHPDoc, current draft PSR5: https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md
The current draft updates the specification to address PHP 5.3+, as well as other changes which have occurred. I believe the expectation is this standard for php comments will be adopted accross multiple doc generators.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
Questions asking us to recommend or find a tool, library or favorite off-site resource are off-topic for Stack Overflow as they tend to attract opinionated answers and spam. Instead, describe the problem and what has been done so far to solve it.
Closed 8 years ago.
Improve this question
I'm using PDT, but want to switch to any lightweit editor. First I want to try Textmate. Eclipse has several useful features:
class outlile to get list of properties and methods (with signature) to navigate;
type hierarchy, it is like class outlile but it shows full inheritance tree;
autocompletion for custom classes names, methods etc. (not only for standard functions);
go to declaration feature
Does Textmate provide this features, or is there bundles to get such functional?
You can get auto completion in TextMate for PHP using the tm-completion bundle. In doesn't work anything as good as what you might see in other IDEs like Eclipse or Visual Studio, xCode. But is works.
Standard PHP completion is supported. See the PHP Bundle -> Support -> Help
I know it can be frightening — it was for me — but you can code very efficiently with Vim. It's definetly not a turnkey solution but if you have some time between projects it's worth it.
Taglist and tagbar are plugins that provide code navigation.
There are a number of solutions for autocompletion.
you can go to declaration with gd in a single file or with exuberant ctags and ctrl-] in more complex situations.
TextMate has a 30 day trial, so give it a go and see how it is for you.
I use Coda, which has class outline and autocompletion for native PHP functions, but not custom classes.
no, i don't think there's any of these - Textmate is a text editor, not a full-blown IDE.
default php bundle provides autocompletion and code hints... but only for built-in functions.
"go to symbol" command brings up class and functions outline... but only for the current file.
For quickly browsing to classes, functions and methods in a file, there is the TmCodeBrowser plugin. It uses Exuberant CTags to index the various code types.