Hi all!

While browsing the Webdav API docs I noticed that our class tree
overviews start really getting a mess as component sizes are growing and
more and more features are added. Therefore I would suggest that we
start structuring the classes of each component by assigning a
subpackage to it. phpDocumentor already supports the necessary @subpacke
tag and we already make use of this to skip test files from being
documented.

Subpackaging should follow the architecture of the specific component,
but we should invent a common sense about certain architectural elements
of a component, like Drivers and Backends.

To give an example, I'd structure the classes of the Database component
the following way:

@subpackage Main
  - ezcDbInstance
  - ezcDbFactory
  - ...

  - ezcDbHandlerSqlite
  - ezcDbHandlerMssql
  - ...

@subpackage SQL-Abstraction
  - ezcQuerySelect
  - ...
  - ezcQueryExpression
  - ...

This way one has clearly seperated the 2 levels of abstraction.

For Webdav, for example, I'd suggest the following packages:

@Main
@Infrastructure
@Transport
@Backend
@Plugin-API
@Plugin-Lock

I'm still a bit unsure, about a standardization for these structures and
if we maybe find a better one, if this RFC is accepted at all.

Awaiting your feedback.
Regards,
Toby
-- 
Mit freundlichen Grüßen / Med vennlig hilsen / With kind regards

Tobias Schlitt (GPG: 0xC462BC14) eZ Components Developer

[EMAIL PROTECTED] | eZ Systems AS | ez.no
-- 
Components mailing list
[email protected]
http://lists.ez.no/mailman/listinfo/components

Reply via email to