Differential D25008 Diff 22 src/docs/article/overview.diviner

Changeset View

Standalone View

src/docs/article/overview.diviner

@title libphutil Overview		@title libphutil Overview
@group overview		@group overview

This document provides a high-level introduction to libphutil.		This document provides a high-level introduction to libphutil.

= Overview =		= Overview =

libphutil (pronounced as "lib-futile", like the English word //futile//) is		libphutil (pronounced as "lib-futile", like the English word //futile//) is
a collection of PHP utility classes and functions. Most code in the library is		a collection of PHP utility classes and functions. Most code in the library is
general-purpose, and makes it easier to build applications in PHP.		general-purpose, and makes it easier to build applications in PHP.

libphutil is principally the shared library for		libphutil is principally the shared library for
[[ http://www.phabricator.org \| Phabricator ]] and its CLI Arcanist, but is		[[ http://phorge.it \| Phorge ]] and its CLI Arcanist, but is
suitable for inclusion in other projects. In particular, some of the classes		suitable for inclusion in other projects. In particular, some of the classes
provided in this library vastly improve the state of common operations in PHP,		provided in this library vastly improve the state of common operations in PHP,
like executing system commands.		like executing system commands.

libphutil is developed and maintained by		libphutil is developed and maintained by
[[ http://www.phacility.com/ \| Phacility ]]. Some of the code in this library		[[ http://www.phacility.com/ \| Phacility ]]. Some of the code in this library
was originally developed at Facebook, and parts of it appear in the core		was originally developed at Facebook, and parts of it appear in the core
libraries for <http://www.facebook.com/>.		libraries for <http://www.facebook.com/>.
Show All 24 Lines	Some of the major components of libphutil are:
- @{function:xsprintf}: allows you to define `sprintf()`-style functions		- @{function:xsprintf}: allows you to define `sprintf()`-style functions
which use custom conversions; and		which use custom conversions; and
- Library System: an introspectable, inventoried system for organizing		- Library System: an introspectable, inventoried system for organizing
PHP code and managing dependencies, supported by static analysis.		PHP code and managing dependencies, supported by static analysis.

= Extending and Contributing =		= Extending and Contributing =

Information on extending and contributing to libphutil is available in the		Information on extending and contributing to libphutil is available in the
Phabricator documentation:		Phorge documentation:

- To get started as a contributor, see @{article@phabcontrib:Contributor		- To get started as a contributor, see @{article@contrib:Contributor
Introduction}.		Introduction}.