Internals

Ad Hoc Text On most websites, there is often a need for simple pages of information. These are not really content pages, since they are mostly to do with the operation of the site, and not its informational purpose. For example, these sorts of things: terms of service help pages contact information notification of upcoming events To support these uses, Siteframe 5.x provides "...
0 comment(s) / glen / Internals / on April 24, 2005 at 07:22

Importing from Siteframe 3.x The Admin menu on Beaumont provides a mechanism for importing content from a Siteframe 3.x database. This page contains information you should be aware of if you are planning on importing from a 3.x website. When importing, you can selectively import Users, Folders, and Documents. These options are really provided for testing (unless, for example, you want to convert a public site to a...
0 comment(s) / glen / Internals / on June 12, 2005 at 09:09

Issues with MySQL 5.21-beta I recently upgraded to MySQL 5.21 beta and discovered that the home page of my Siteframe (v5) sites all look a bit strange. Evidently this little bit of SQL: ORDER BY page_id DESC LIMIT 20 returns the FIRST 20 page_ids, and not the LAST 20. I made this change in index.php: ORDER BY page_created DESC LIMIT 20 I presume this is a beta bug in MySQL 5.21, and it will be fixed shortly....
0 comment(s) / glen / Internals / on August 30, 2007 at 22:46

Logging Siteframe 5.x has two internal tables for logging. The first is the audit log; this is always functional and records any major changes to data. The purpose of this log is to track changes to the system; for example, if a large number of objects are deleted from the site, you can use this log to find what event or user initiated the deletion. The second log is called the user log and...
0 comment(s) / glen / Internals / on April 17, 2005 at 16:32

Metadata Metadata means data about data and is used generically to describe data that holds information about other data objects. In a Siteframe class definition, however, the metadata is a specific data structure (a PHP array) that contains information about the properties, or individual data elements, that make up a data class. Each Siteframe class definition contains a metadata structure...
1 comment(s) / glen / Internals / on April 3, 2005 at 21:03

MySQL Notes Various bits of information about using MySQL with Siteframe. MySQL Permissions Typically, you need these permissions on your MySQL database: grant alter,index,select,insert,pdate,delete,create,drop on database .* to ' user '@' host ' identified by ' password ' or (somewhat easier) grant all on database .* to ' user '@' host ' identified by ' password ' though this is possibly...
0 comment(s) / glen / Internals / on April 24, 2005 at 14:38

Ownership and anonymous objects When an object in the Siteframe Beaumont database is owned by a user, this means, in practice, that the table has a something _user_id column that is a foreign key back to the user table. In the class definition for the object, there is also a metadata field, "owner", that holds the name of the owner ID column. Finally, an internal method authorized() determines which users are...
0 comment(s) / glen / Internals / on September 19, 2005 at 06:59

Plugin API The Plugin API provides a collection of services for use by Siteframe plugins. The API is implemented as a PHP class file and classes are called directly, not through the creation of an object. This page defines the functions available in the plugin API and shows examples of their use. Please note that the Plugin API is a PHP5 API for use by plugin scripts; this is distinct from the...
0 comment(s) / glen / Internals / on April 3, 2005 at 20:54

Recommended/Required Software This document describes the software that is required to install Siteframe. Web server: Siteframe has been installed under Apache 2.0.53 ; it will most likely work under older versions of Apache, but it has not been verified. It should work under any web server that supports PHP5, but, again, nothing besides Apache 2.0 has been confirmed and tested. PHP5: Siteframe...
0 comment(s) / glen / Internals / on March 22, 2005 at 21:18

RSS Feed Support I am assuming that people would like to be able to display RSS feeds on their site. Since Siteframe is not intended to be an RSS aggregator (of which there are already many), my presumption is that RSS feeds would be used to link certain sites together. For example, the Contax G Pages might like to display recent images from the Non-Contax G Pages, a sister site. A community website might want...
6 comment(s) / glen / Internals / on September 2, 2005 at 11:27

Siteframe Classes A class is a representation of a type of Siteframe data object. Specifically, a class is implemented as a PHP5 class definition, which usually (though not always) has a physical representation as a MySQL table. For example, the class "Page" is defined in includes/Page.class.inc , and is stored in the prefix _pages table. If you are not familiar with object-oriented programming, then...
0 comment(s) / glen / Internals / on April 6, 2005 at 14:51

siteframe.ini Most of the core configuration for Siteframe Beaumont is performed through the siteframe.ini file. This is a text file in standard .INI file format that defines configuration variables for use by all the site software. There are several types of lines in the file: Comments begin with a semicolon and extend to the end of the line. Sections are indicated with [brackets] and must...
0 comment(s) / glen / Internals / on March 18, 2005 at 11:30

Trackback Some time ago, I removed Trackback functionality from Siteframe because of the potential for abuse. That is, with Trackback, it's very easy for a spammer to create false Trackbacks that link to spam websites. After thoughtful deliberation, I've restored this functionality, but have it disabled by default. Configuration All Trackback functionalty is controlled by two basic settings: ...
0 comment(s) / glen / Internals / on January 1, 2006 at 11:03