The Solar Framework for PHP

Table of Contents

I. Getting Started

1. Quick-Start Blog Demo

1.1. Introduction

1.2. Download and Install Solar

1.3. Make a Vendor Space

1.4. Configure the System

1.5. Make a Model From a Database Table

1.6. Make a Basic Application

1.7. Basic Application Setup

1.8. Browse All Public Articles

1.9. Read One Article

1.10. Browse All Draft Articles

1.11. Edit One Article

1.12. Add One New Article

1.13. Delete One Article

1.14. Set Locale Strings

1.15. Cleaner URIs with a Virtual Host

2. Dynamic Dispatch Cycle

2.1. Bootstrap and Configuration

2.2. Front Controller

2.3. Rewrite Rules

2.4. Page Controller

3. Working With Models

3.1. Introduction

3.2. Major Components and Patterns

3.3. The Model Catalog

3.4. Fetching Data

3.5. Records and Collections

3.6. Record Creation, Modification, and Saving

3.7. Record Filters

3.8. Special Column Processing

3.9. Single Table Inheritance

4. Working With Related Models

4.1. Introduction

4.2. Domain Description

4.3. Native Model "Has One" Related Foreign Record

4.4. Native Model "Has Many" Related Foreign Records

4.5. Native Model "Belongs To" Related Foreign Model

4.6. Native Model "Has Many" Related Foreign Records "Through" An Association

4.7. Eager Fetching

4.8. Creating, Modifying, and Saving Relateds

5. Views and Layouts

5.1. Introduction

5.2. Location of Views and Layouts

5.3. Nested Views and Partials

5.4. Alternate Formats

5.5. View Helpers

5.6. Layouts

6. Models and Forms

6.1. Introduction

6.2. Controller Logic

6.3. The Form Object

6.4. Form Elements

6.5. View Presentation

6.6. View Decoration

6.7. Semi-Automatic View Presentation

6.8. Custom Record Elements

6.9. Locale Strings

7. User Authentication, Roles, and Access Control

7.1. Introduction

7.2. The Solar_User Object

7.3. Authentication Processing

7.4. Authentication Forms

7.5. Roles

7.6. Access Control

7.7. Integration With Page Controllers

7.8. Ownership Access

8. Command-Line Tools

8.1. Introduction

8.2. Make Vendor Source

8.3. Link Vendor Source

8.4. Link Public Assets

8.5. Unlink Vendor Source

8.6. Get Help

8.7. Make One Or More Models

8.8. Make A Web Application Page

8.9. Make A CLI Command

8.10. Make A Test Suite

8.11. Run A Test Suite

8.12. Make Wiki-Like Documentation

8.13. Make DocBook Files

9. Mail

9.1. Introduction

9.2. Composing Messages

9.3. Message Attachments

9.4. Sending Messages

II. Appendices

A. Project Standards

A.1. Introduction

A.2. Style Guide

A.3. Base Class

A.4. Universal Constructor

A.5. Universal Configuration

A.6. Project System

B. Naming Conventions

B.1. Introduction

B.2. Vendor and Class Names

B.3. Methods

B.4. Global Variables and Functions

B.5. Session Variables

B.6. Configuration Keys

B.7. Locale Files

B.8. Locale Translation Keys

B.9. Exceptions

B.10. Model Classes