1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-11-26 16:52:41 +01:00

Remove references to __init__.php from docs

Test Plan: Regenerate docs.

Reviewers: btrahan, epriestley

Reviewed By: epriestley

CC: aran, Koolvin

Maniphest Tasks: T1103

Differential Revision: https://secure.phabricator.com/D2640
This commit is contained in:
vrana 2012-06-01 13:04:01 -07:00
parent 8d37576bd8
commit fd10bcea48
2 changed files with 27 additions and 42 deletions

View file

@ -37,10 +37,6 @@ containing the file ##DerpController.php## with the class
which returns some @{class:AphrontResponse} object. The class would probably which returns some @{class:AphrontResponse} object. The class would probably
extend @{class:PhabricatorController}. extend @{class:PhabricatorController}.
plus an auto-generated ##__init__.php## file.
NOTE: ##__init.php__## files are generated and maintained via `arc lint`.
If ##Derp## were (relatively) complex, one could reasonably expect to see If ##Derp## were (relatively) complex, one could reasonably expect to see
the following directory layout: the following directory layout:
@ -54,17 +50,17 @@ the following directory layout:
phabricator/src/applications/derp/view/ phabricator/src/applications/derp/view/
phabricator/src/applications/conduit/method/derp/ phabricator/src/applications/conduit/method/derp/
(The following two folders are also likely to be included for javascript and (The following two folders are also likely to be included for JavaScript and
css respectively. However, static resources are largely outside the scope of CSS respectively. However, static resources are largely outside the scope of
this document. See @{article:Adding New CSS and JS}.) this document. See @{article:Adding New CSS and JS}.)
phabricator/webroot/rsc/js/application/derp/ phabricator/webroot/rsrc/js/application/derp/
phabricator/webroot/rsc/css/application/derp/ phabricator/webroot/rsrc/css/application/derp/
These directories under ##phabricator/src/applications/derp/## represent These directories under ##phabricator/src/applications/derp/## represent
the basic set of class types from which most Phabrictor applications are the basic set of class types from which most Phabrictor applications are
assembled. Each would contain a class file and an ##__init__.php## file. assembled. Each would contain a class file. For ##Derp##, these classes could be
For ##Derp##, these classes could be something like: something like:
- **DerpConstants**: constants used in the ##Derp## application. - **DerpConstants**: constants used in the ##Derp## application.
- **DerpController**: business logic providing functionality for a given - **DerpController**: business logic providing functionality for a given
@ -89,18 +85,8 @@ For ##Derp##, these classes could be something like:
functionality that is accessible over Conduit. functionality that is accessible over Conduit.
However, it is likely that ##Derp## is even more complex, and rather than However, it is likely that ##Derp## is even more complex, and rather than
containing a class and an ##__init__.php## file, each directory has containing one class, each directory has several classes. A typical example
subdirectories of its own. A typical example happens around the CRUD of an happens around the CRUD of an object:
object:
phbaricator/src/application/derp/controller/base/
phabricator/src/application/derp/controller/delete/
phabricator/src/application/derp/controller/edit/
phabricator/src/application/derp/controller/list/
phabricator/src/application/derp/controller/view/
Which would then each contain a class and an ##__init__.php## file mapping to
corresponding classes
- **DerpBaseController**: typically extends @{class:PhabricatorController}, - **DerpBaseController**: typically extends @{class:PhabricatorController},
implements ##buildStandardPageResponse## with the ##Derp## application name implements ##buildStandardPageResponse## with the ##Derp## application name

View file

@ -120,8 +120,7 @@ Now, run ##arc liberate## to regenerate the static resource map:
libcustom/ $ arc liberate src/ libcustom/ $ arc liberate src/
This will automatically create and update ##__init__.php## files, and regenerate This will automatically regenerate the static map of the library.
the static map of the library.
= What You Can Extend And Invoke = = What You Can Extend And Invoke =