Feature #439
Classes for Superfecta
| Status: | Reviewed | Start: | 12/26/2010 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assigned to: | - | % Done: | 0% |
|
| Category: | Planning | |||
| Target version: | Caller ID Superfecta v 3.0.0 |
Description
This case is designed for the discussion of the details for classes being created for Superfecta 3.x
Discussions best here are those that begin to specific what classes will be created. Once that is settled, new tickets for each class development may be opened if extensive discussion / work / etc occurs.
NOTE: The previous ticket for this was unintentionally deleted by me - I'm VERY sorry for the accident. I Have recreated it as best I could.
History
Updated by tshif over 1 year ago
updated by tm1000.
Main Class:
- Function to Strip HTML
- Function to Prevent CSS & MYSQL Injection attacks
- simplexml_load_file function (to replace xml2array)
- error checking function
- base functions that will be 'extended' in the extended classes
Extended Classes
Use the pre-defined functions from the base class.
- Do all other processing
?????
- Profit?
Please see r403. I did a tiny little bit of work on a class setup. Hopefully it will spark ideas.
Updated by tshif over 1 year ago
- Category set to Planning
Updated by tshif over 1 year ago
I have attempted to grant developers the ability to edit their comments in the tickets.
Please let me know if you can do that now -
edited by lgaetz Dec. 27/10
Updated by jkiel over 1 year ago
Somewhat on topic;
I think each source class extension file needs a way of easily reporting its requirements/dependencies (what version of SCID it needs to run), and its version. Simple metadata of some type embedded in the header comments of the source could work.
Before or during the include loop execution allowing the source files to extend the main class, each source file's metadata should be checked and verified if its requirements are able to be met by the current install -- if not disable the source.
As for classes/functions/files, I propose the following folder/file structure:
superfecta:
-- functions:
---- database.php (all database abstraction functions, including escape functions to protect against injection)
---- sql.php (all SQL queries, abstracted by functions -- no SQL should be used directly anywhere but here)
---- string.php (string manipulation functions -- pattern matching, stripping odd characters, html, etc.)
---- http.php (All functions related to retrieving data from http sources)
---- (others I'm sure)
-- sources:
---- v3source-[Source_Name].php
Updated by tshif over 1 year ago
jkiel wrote:
Somewhat on topic;
I think each source class extension file needs a way of easily reporting its requirements/dependencies (what version of CIDS it needs to run), and its version. Simple metadata of some type embedded in the header comments of the source could work.
Agreed.
> As for classes/functions/files, I propose the following folder/file structure: > > superfecta: > -- functions: > ---- database.php (all database abstraction functions, including escape functions to protect against injection) > ---- sql.php (all SQL queries, abstracted by functions -- no SQL should be used directly anywhere but here) > ---- string.php (string manipulation functions -- pattern matching, stripping odd characters, html, etc.) > ---- http.php (All functions related to retrieving data from http sources) > ---- (others I'm sure) > -- sources: > ---- v3source-[Source_Name].php
Looks reasonable - seems straightforward and and serviceable. Well hold for a couple days for dissenting / other input.
Then it will be our first topic in the Projects standards and practices document for version 3.x. I'm thinking Ill start that in the Wiki where ore people have permissions to work on it. (That document can help us keep track of whats already been decided, and service as a reference for new folks joining the project.