Skip to content

Latest commit

 

History

History
151 lines (131 loc) · 14.5 KB

index.wiki

File metadata and controls

151 lines (131 loc) · 14.5 KB

Table of Contents

Documentation

<<css mode="next" class="sidebar"></css>> (((

Downloadable

Grab a single HTML file containing all class and API docs, plus applicable general topics )))

For those just beginning with Flourish, <<css mode="next" class="important"></css>>getting started and <<css mode="next" class="important"></css>>how do I…? provide a gentle introduction. The [#ClassDocumentation] provides in-depth information about each class, along with links to related functionality, the API and source code.

The [#GeneralDocumentation] supplements the class documentation and covers topics that touch on multiple parts of the library, or apply to PHP in general.

Class Documentation

<<css mode="next" class="class_docs first"></css>> (((

Database

 - <a href="/docs/fDatabase">fDatabase</a>                                <a href="/api/fDatabase">API</a>,                <a href="https://github.com/flourishlib/flourish-classes/blob/master/fDatabase.php" target="_blank">Code</a>
 - <a href="/docs/fResult">fResult</a>                                    <a href="/api/fResult">API</a>,                  <a href="https://github.com/flourishlib/flourish-classes/blob/master/fResult.php" target="_blank">Code</a>
 - <a href="/docs/fSQLTranslation">fSQLTranslation</a>                    <a href="/api/fSQLTranslation">API</a>,          <a href="https://github.com/flourishlib/flourish-classes/blob/master/fSQLTranslation.php" target="_blank">Code</a>
 - <a href="/docs/fSQLSchemaTranslation">fSQLSchemaTranslation</a>        <a href="/api/fSQLSchemaTranslation">API</a>,    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fSQLSchemaTranslation.php" target="_blank">Code</a>
 - <a href="/docs/fSchema">fSchema</a>                                    <a href="/api/fSchema">API</a>,                  <a href="https://github.com/flourishlib/flourish-classes/blob/master/fSchema.php" target="_blank">Code</a>
 - <a href="/docs/fStatement">fStatement</a>                              <a href="/api/fStatement">API</a>,               <a href="https://github.com/flourishlib/flourish-classes/blob/master/fStatement.php" target="_blank">Code</a>
 - <a href="/docs/fUnbufferedResult">fUnbufferedResult</a>                <a href="/api/fUnbufferedResult">API</a>,        <a href="https://github.com/flourishlib/flourish-classes/blob/master/fUnbufferedResult.php" target="_blank">Code</a>

ORM

 - <a href="/docs/fActiveRecord">fActiveRecord</a>                        <a href="/api/fActiveRecord">API</a>,            <a href="https://github.com/flourishlib/flourish-classes/blob/master/fActiveRecord.php" target="_blank">Code</a>
 - <a href="/docs/fRecordSet">fRecordSet</a>                              <a href="/api/fRecordSet">API</a>,               <a href="https://github.com/flourishlib/flourish-classes/blob/master/fRecordSet.php" target="_blank">Code</a>

 - <a href="/docs/fORM">fORM</a>                                          <a href="/api/fORM">API</a>,                     <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORM.php" target="_blank">Code</a>
 - <a href="/docs/fORMColumn">fORMColumn</a>                              <a href="/api/fORMColumn">API</a>,               <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORMColumn.php" target="_blank">Code</a>
 - <a href="/docs/fORMDatabase">fORMDatabase</a>                          <a href="/api/fORMDatabase">API</a>,             <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORMDatabase.php" target="_blank">Code</a>
 - <a href="/docs/fORMDate">fORMDate</a>                                  <a href="/api/fORMDate">API</a>,                 <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORMDate.php" target="_blank">Code</a>
 - <a href="/docs/fORMFile">fORMFile</a>                                  <a href="/api/fORMFile">API</a>,                 <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORMFile.php" target="_blank">Code</a>
 - <a href="/docs/fORMJSON">fORMJSON</a>                                  <a href="/api/fORMJSON">API</a>,                 <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORMJSON.php" target="_blank">Code</a>
 - <a href="/docs/fORMMoney">fORMMoney</a>                                <a href="/api/fORMMoney">API</a>,                <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORMMoney.php" target="_blank">Code</a>
 - <a href="/docs/fORMOrdering">fORMOrdering</a>                          <a href="/api/fORMOrdering">API</a>,             <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORMOrdering.php" target="_blank">Code</a>
 - <a href="/docs/fORMRelated">fORMRelated</a>                            <a href="/api/fORMRelated">API</a>,              <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORMRelated.php" target="_blank">Code</a>
 - <a href="/docs/fORMSchema">fORMSchema</a>                              <a href="/api/fORMSchema">API</a>,               <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORMSchema.php" target="_blank">Code</a>
 - <a href="/docs/fORMValidation">fORMValidation</a>                      <a href="/api/fORMValidation">API</a>,           <a href="https://github.com/flourishlib/flourish-classes/blob/master/fORMValidation.php" target="_blank">Code</a>

Filesystem

 - <a href="/docs/fFilesystem">fFilesystem</a>                            <a href="/api/fFilesystem">API</a>,              <a href="https://github.com/flourishlib/flourish-classes/blob/master/fFilesystem.php" target="_blank">Code</a>
 - <a href="/docs/fFile">fFile</a>                                        <a href="/api/fFile">API</a>,                    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fFile.php" target="_blank">Code</a>
  - <a href="/docs/fImage">fImage</a>                                     <a href="/api/fImage">API</a>,                   <a href="https://github.com/flourishlib/flourish-classes/blob/master/fImage.php" target="_blank">Code</a>
 - <a href="/docs/fDirectory">fDirectory</a>                              <a href="/api/fDirectory">API</a>,               <a href="https://github.com/flourishlib/flourish-classes/blob/master/fDirectory.php" target="_blank">Code</a>

)))

<<css mode="next" class="class_docs second"></css>> (((

Request

 - <a href="/docs/fCookie">fCookie</a>                                    <a href="/api/fCookie">API</a>,                  <a href="https://github.com/flourishlib/flourish-classes/blob/master/fCookie.php" target="_blank">Code</a>
 - <a href="/docs/fRequest">fRequest</a>                                  <a href="/api/fRequest">API</a>,                 <a href="https://github.com/flourishlib/flourish-classes/blob/master/fRequest.php" target="_blank">Code</a>
 - <a href="/docs/fUpload">fUpload</a>                                    <a href="/api/fUpload">API</a>,                  <a href="https://github.com/flourishlib/flourish-classes/blob/master/fUpload.php" target="_blank">Code</a>
 - <a href="/docs/fURL">fURL</a>                                          <a href="/api/fURL">API</a>,                     <a href="https://github.com/flourishlib/flourish-classes/blob/master/fURL.php" target="_blank">Code</a>
 - <a href="/docs/fValidation">fValidation</a>                            <a href="/api/fValidation">API</a>,              <a href="https://github.com/flourishlib/flourish-classes/blob/master/fValidation.php" target="_blank">Code</a>

Session

 - <a href="/docs/fAuthorization">fAuthorization</a>                      <a href="/api/fAuthorization">API</a>,           <a href="https://github.com/flourishlib/flourish-classes/blob/master/fAuthorization.php" target="_blank">Code</a>
 - <a href="/docs/fMessaging">fMessaging</a>                              <a href="/api/fMessaging">API</a>,               <a href="https://github.com/flourishlib/flourish-classes/blob/master/fMessaging.php" target="_blank">Code</a>
 - <a href="/docs/fSession">fSession</a>                                  <a href="/api/fSession">API</a>,                 <a href="https://github.com/flourishlib/flourish-classes/blob/master/fSession.php" target="_blank">Code</a>

Response

 - <a href="/docs/fBuffer">fBuffer</a>                                    <a href="/api/fBuffer">API</a>,                  <a href="https://github.com/flourishlib/flourish-classes/blob/master/fBuffer.php" target="_blank">Code</a>
 - <a href="/docs/fCRUD">fCRUD</a>                                        <a href="/api/fCRUD">API</a>,                    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fCRUD.php" target="_blank">Code</a>
 - <a href="/docs/fHTML">fHTML</a>                                        <a href="/api/fHTML">API</a>,                    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fHTML.php" target="_blank">Code</a>
 - <a href="/docs/fJSON">fJSON</a>                                        <a href="/api/fJSON">API</a>,                    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fJSON.php" target="_blank">Code</a>
 - <a href="/docs/fTemplating">fTemplating</a>                            <a href="/api/fTemplating">API</a>,              <a href="https://github.com/flourishlib/flourish-classes/blob/master/fTemplating.php" target="_blank">Code</a>

Utilities

 - <a href="/docs/fCache">fCache</a>                                      <a href="/api/fCache">API</a>,                   <a href="https://github.com/flourishlib/flourish-classes/blob/master/fCache.php" target="_blank">Code</a>
 - <a href="/docs/fCryptography">fCryptography</a>                        <a href="/api/fCryptography">API</a>,            <a href="https://github.com/flourishlib/flourish-classes/blob/master/fCryptography.php" target="_blank">Code</a>
 - <a href="/docs/fGrammar">fGrammar</a>                                  <a href="/api/fGrammar">API</a>,                 <a href="https://github.com/flourishlib/flourish-classes/blob/master/fGrammar.php" target="_blank">Code</a>
 - <a href="/docs/fLoader">fLoader</a>                                    <a href="/api/fLoader">API</a>,                  <a href="https://github.com/flourishlib/flourish-classes/blob/master/fLoader.php" target="_blank">Code</a>
 - <a href="/docs/fText">fText</a>                                        <a href="/api/fText">API</a>,                    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fText.php" target="_blank">Code</a>
 - <a href="/docs/fXML">fXML</a>                                          <a href="/api/fXML">API</a>,                     <a href="https://github.com/flourishlib/flourish-classes/blob/master/fXML.php" target="_blank">Code</a>

)))

<<css mode="next" class="class_docs third"></css>> (((

Email

 - <a href="/docs/fEmail">fEmail</a>                                      <a href="/api/fEmail">API</a>,                   <a href="https://github.com/flourishlib/flourish-classes/blob/master/fEmail.php" target="_blank">Code</a>
 - <a href="/docs/fMailbox">fMailbox</a>                                  <a href="/api/fMailbox">API</a>,                 <a href="https://github.com/flourishlib/flourish-classes/blob/master/fMailbox.php" target="_blank">Code</a>
 - <a href="/docs/fSMTP">fSMTP</a>                                        <a href="/api/fSMTP">API</a>,                    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fSMTP.php" target="_blank">Code</a>

Date/Time

 - <a href="/docs/fDate">fDate</a>                                        <a href="/api/fDate">API</a>,                    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fDate.php" target="_blank">Code</a>
 - <a href="/docs/fTime">fTime</a>                                        <a href="/api/fTime">API</a>,                    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fTime.php" target="_blank">Code</a>
 - <a href="/docs/fTimestamp">fTimestamp</a>                              <a href="/api/fTimestamp">API</a>,               <a href="https://github.com/flourishlib/flourish-classes/blob/master/fTimestamp.php" target="_blank">Code</a>

Numbers/Strings

 - <a href="/docs/fMoney">fMoney</a>                                      <a href="/api/fMoney">API</a>,                   <a href="https://github.com/flourishlib/flourish-classes/blob/master/fMoney.php" target="_blank">Code</a>
 - <a href="/docs/fNumber">fNumber</a>                                    <a href="/api/fNumber">API</a>,                  <a href="https://github.com/flourishlib/flourish-classes/blob/master/fNumber.php" target="_blank">Code</a>
 - <a href="/docs/fUTF8">fUTF8</a>                                        <a href="/api/fUTF8">API</a>,                    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fUTF8.php" target="_blank">Code</a>

Errors/Exceptions

 - <a href="/docs/fCore">fCore</a>                                        <a href="/api/fCore">API</a>,                    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fCore.php" target="_blank">Code</a>
 - <a href="/docs/fException">fException</a>                              <a href="/api/fException">API</a>,               <a href="https://github.com/flourishlib/flourish-classes/blob/master/fException.php" target="_blank">Code</a>
  - <a href="/docs/fExpectedException">fExpectedException</a>             <a href="/api/fExpectedException">API</a>,       <a href="https://github.com/flourishlib/flourish-classes/blob/master/fExpectedException.php" target="_blank">Code</a>
   - <a href="/docs/fAuthorizationException">fAuthorizationException</a>  <a href="/api/fAuthorizationException">API</a>,  <a href="https://github.com/flourishlib/flourish-classes/blob/master/fAuthorizationException.php" target="_blank">Code</a>
   - <a href="/docs/fEmptySetException">fEmptySetException</a>            <a href="/api/fEmptySetException">API</a>,       <a href="https://github.com/flourishlib/flourish-classes/blob/master/fEmptySetException.php" target="_blank">Code</a>
   - <a href="/docs/fNoRemainingException">fNoRemainingException</a>      <a href="/api/fNoRemainingException">API</a>,    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fNoRemainingException.php" target="_blank">Code</a>
   - <a href="/docs/fNoRowsException">fNoRowsException</a>                <a href="/api/fNoRowsException">API</a>,         <a href="https://github.com/flourishlib/flourish-classes/blob/master/fNoRowsException.php" target="_blank">Code</a>
   - <a href="/docs/fNotFoundException">fNotFoundException</a>            <a href="/api/fNotFoundException">API</a>,       <a href="https://github.com/flourishlib/flourish-classes/blob/master/fNotFoundException.php" target="_blank">Code</a>
   - <a href="/docs/fValidationException">fValidationException</a>        <a href="/api/fValidationException">API</a>,     <a href="https://github.com/flourishlib/flourish-classes/blob/master/fValidationException.php" target="_blank">Code</a>
  - <a href="/docs/fUnexpectedException">fUnexpectedException</a>         <a href="/api/fUnexpectedException">API</a>,     <a href="https://github.com/flourishlib/flourish-classes/blob/master/fUnexpectedException.php" target="_blank">Code</a>
   - <a href="/docs/fConnectivityException">fConnectivityException</a>    <a href="/api/fConnectivityException">API</a>,   <a href="https://github.com/flourishlib/flourish-classes/blob/master/fConnectivityException.php" target="_blank">Code</a>
   - <a href="/docs/fEnvironmentException">fEnvironmentException</a>      <a href="/api/fEnvironmentException">API</a>,    <a href="https://github.com/flourishlib/flourish-classes/blob/master/fEnvironmentException.php" target="_blank">Code</a>
   - <a href="/docs/fProgrammerException">fProgrammerException</a>        <a href="/api/fProgrammerException">API</a>,     <a href="https://github.com/flourishlib/flourish-classes/blob/master/fProgrammerException.php" target="_blank">Code</a>
   - <a href="/docs/fSQLException">fSQLException</a>                      <a href="/api/fSQLException">API</a>,            <a href="https://github.com/flourishlib/flourish-classes/blob/master/fSQLException.php" target="_blank">Code</a>

)))

General Documentation

This documentation supplements the [#ClassDocumentation] and covers topics that touch on multiple parts of the library, or apply to PHP in general.

<<css mode="next" class="stackable"></css>>


<<css mode="next" class="stackable"></css>>

 - <a href="/docs/InternationalizationLocalization">Internationalization/Localization</a>
 - <a href="/docs/LicenseAgreement">License Agreement</a>
 - <a href="/docs/MessagesList">Messages List</a>
 - <a href="/docs/MethodNaming">Method Naming</a>
 - <a href="/docs/MotivationsForFlourish">Motivations for Flourish</a>
 - <a href="/docs/ObjectRelationalMapping">Object-Relational Mapping</a>
 - <a href="/docs/ObtainingaSecureCertificateKeyPair">Obtaining a Secure Certification Key Pair</a>
 - <a href="/docs/OrmConventions">ORM Conventions</a>
 - <a href="/docs/PerformanceTips">Performance Tips</a>
 - <a href="/docs/PhpVersionDifferences">PHP Version Differences</a>

<<css mode="next" class="stackable"></css>>

 - <a href="/docs/ReferenceObjects">Reference Objects</a>
 - <a href="/docs/Roadmap">Roadmap</a>
 - <a href="/docs/Security">Security</a>
 - <a href="/docs/ServerFund">Server Fund</a>
 - <a href="/docs/ServerRequirements">Server Requirements</a>
 - <a href="/docs/SitesPoweredByFlourish">Sites Powered by Flourish</a>
 - <a href="/docs/UTF-8">UTF-8</a>
 - <a href="/docs/ValueObjects">Value Objects</a>
 - <a href="/docs/Versioning">Versioning</a>