soo_txp_obj: OOP library for plugin development

jsoo · 2009-02-04 22:20:13

soo_txp_obj

An object-oriented library for developing Textpattern plugins. Mainly for making database calls, dealing with the ensuing data, and generating HTML output therefrom. Also has a URI class for query string manipulation.

Requires:

PHP 5

Details:

Learn more and download the thing here: soo_txp_obj

Version History

1.1.0, released 2011-01-07

Minor update, mainly needed only for sites running Multidoc and using the latest version of the admin plugin (0.1.1).

soo_txp_select::distinct() for SELECT DISTINCT queries
Bugfix: soo_txp_left_join now works with database table prefixes

1.1.b.1, released 9/12/2010

New class, soo_txp_left_join for SELECT ... LEFT JOIN queries
soo_txp_upsert new features:
- properties and methods for VALUES() syntax
- can be initialized with a soo_txp_rowset or soo_txp_row object
soo_txp_rowset new features:
- can be initialized with a query result resource
- new function subset() to create a new rowset object from an existing one
New class, soo_nested_set for Celko nested sets (modified preorder tree)
soo_html_form, new features and related classes:
- Constructor’s atts argument can include an action array for adding query parameters to the form’s action attribute
- New classes:
  - soo_html_label for labeling form controls
  - soo_html_input for input elements
  - soo_html_select for select elements (can be initialized with an array which will auto-create appropriate option elements)
  - soo_html_option (see above)
  - soo_html_textarea for textarea elements
soo_html_img bugfix for pre Txp 4.2 compatibility
soo_html_table can now be initialized with an array of values or table cells; these will automatically be formatted into rows and cells appropriately
New class, *soo_html_caption for table captions
soo_html_ol and soo_html_ul can be initialized with nested arrays, automatically generating nested lists (see soo_nested_set for a possible source of the nested array)

1.0.b.8, released 7/9/2010

Documentation updates (DoxyGen compatibility)

1.0.b.7, released 7/4/2010

soo_html_img now adds thumbnail height and width attributes (Txp 4.2.0 or later)

1.0.b.6, released 7/1/2010

New class: soo_util, for static utility methods

1.0.b.5, released 1/27/2010

new method: where_clause() in soo_txp_query, a catch-all for complex clauses
minor HTML formatting change to tag() method in soo_html

1.0.b.4, released 10/3/2009

soo_uri updated for correct behavior in Txp sub-dir installations

1.0.b.3, released 9/22/2009

soo_uri now gets query params by parsing $_SERVER[‘QUERY_STRING’] instead of $_GET

1.0.b.2, released 9/16/2009

New callback function for MLP Pack compatibility with soo_uri
New classes:
- soo_txp_upsert for SQL insert/update statements
- soo_txp_delete for SQL delete statements
- soo_html_form for form elements
soo_txp_rowset overrides parent::__get() method

1.0.b.1

Major re-organization and re-write of most classes.
- The old Soo_Txp_Data family has been divided into separate classes for queries and data.
- There are no longer separate classes for each Txp table.
- All class names now lowercase (these aren’t case sensitive anyway).
- Generic setting is now in the form obj->property() instead of obj->set_property().
- Various renaming, code cleaning, etc.

1.0.a.6, released 6/2/2009

Added Soo_Txp_Uri class, for URI query string manipulation
Soo_Html_P and soo_html_th can now have contents set during instantiation. Note that this will break compatibility with some previous uses, e.g. new Soo_Html_P($atts).
Added $in argument to where_in() method (Soo_Txp_Data) to allow “NOT IN” queries

1.0.a5, released 5/13/2009

Corrected SQL syntax in order_by_field() function of Soo_Txp_Data class
Modified tag() function of Soo_Html class to handle a PHP 5.2.0 bug

1.0.a4, released 5/1/2009

Added count() and field() methods to the abstract Soo_Txp_Data class.

1.0.a3, released 2/19/2009

Added “Expires” property to Soo_Txp_Article and “load_order” property to Soo_Txp_Plugin. These fields were added in Textpattern version 4.0.7.

h3. 1.0.a2, released 2/5/2009

No significant functional changes, but added generic getters and setters (thanks to jm for the hint), making the file about 35% smaller.

h3. 1.0.a1, released 2/4/2009

Initial public release

Last edited by jsoo (2011-01-07 19:54:34)

Logoleptic · 2009-02-04 23:36:07

Interesting idea. I look forward to watching this develop.

TheEric · 2009-02-05 02:51:09

I’m not sure if an Object Oriented Approach is wise to plugin development.

jm · 2009-02-05 03:51:56

Haven’t looked at it too closely, but wouldn’t PHP’s __get|set methods simplify most of the getters and setters?

jsoo · 2009-02-05 12:20:06

jm wrote:

Haven’t looked at it too closely, but wouldn’t PHP’s __get|set methods simplify most of the getters and setters?

I didn’t know about those. Thanks. Certainly I’ll make use of __get(). That is going to shorten some of those classes quite a bit. At this point I prefer having separate specific setters, if nothing else for the method chaining.

TheEric wrote:

I’m not sure if an Object Oriented Approach is wise to plugin development.

Please share — I want to know.

jsoo · 2009-02-05 14:48:07

Following jm’s hint, I replaced all the generic getters with a __get() in the super-parent class. Then I made a __call() to handle the generic setters, so I still get method chaining. The file’s now about 35% smaller, and extending the base class is much less tedious. Thanks jm!

TheEric · 2009-02-05 18:59:01

jsoo wrote:

Please share — I want to know.

This framework is redundant and doesn’t ease development. Everything needed for plugin development already exists within TXP. Adding an additional OOP layer on top of a procedural based app just doesn’t seem all that …efficient. I would be all for it if there were the slightest speed benefit, but there is none. While I think this is an interesting concept to consider, I don’t think any sort of OOP approach to plugin-programming is currently practical.

jsoo · 2009-02-05 19:49:44

Thanks for the insight. Certainly there is no performance benefit. In my limited trials I have found it makes it easier for me to write plugins, but that may simply be a reflection of my limited skills.

jsoo · 2009-06-18 00:40:52

There is now a soo_txp_obj github repo. At the moment there is an experimental branch taking a quite different approach to query and data classes. If I go this route, and I probably will, any plugins based on the current release will require some editing. I know there aren’t many if any other plugin devs using this, but wanted to give fair warning — now is the time to give input.

Last edited by jsoo (2009-09-22 21:02:27)

TheEric · 2009-06-18 14:38:39

My above comment still holds.

jsoo · 2009-09-22 21:05:05

In response to this issue, soo_uri in v1.0.b.3 no longer relies on $_GET.

jsoo · 2009-10-04 12:53:04

In response to this issue, soo_uri now plays better with Txp subdirectory installations.

Textpattern CMS

Textpattern CMS support forum

#1 2009-02-04 22:20:13

soo_txp_obj: OOP library for plugin development

#2 2009-02-04 23:36:07

Re: soo_txp_obj: OOP library for plugin development

#3 2009-02-05 02:51:09

Re: soo_txp_obj: OOP library for plugin development

#4 2009-02-05 03:51:56

Re: soo_txp_obj: OOP library for plugin development

#5 2009-02-05 12:20:06

Re: soo_txp_obj: OOP library for plugin development

#6 2009-02-05 14:48:07

Re: soo_txp_obj: OOP library for plugin development

#7 2009-02-05 18:59:01

Re: soo_txp_obj: OOP library for plugin development

#8 2009-02-05 19:49:44

Re: soo_txp_obj: OOP library for plugin development

#9 2009-06-18 00:40:52

Re: soo_txp_obj: OOP library for plugin development

#10 2009-06-18 14:38:39

Re: soo_txp_obj: OOP library for plugin development

#11 2009-09-22 21:05:05

Re: soo_txp_obj: OOP library for plugin development

#12 2009-10-04 12:53:04

Re: soo_txp_obj: OOP library for plugin development

Board footer