-
Notifications
You must be signed in to change notification settings - Fork 3
/
soo_txp_obj.php
1976 lines (1758 loc) · 54.7 KB
/
soo_txp_obj.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/** @mainpage notitle
* <p><a href="http://ipsedixit.net/txp/21/soo-txp-obj">soo_txp_obj</a> is a support library for <a href="http://textpattern.com/">Textpattern</a> plugins.
* <p>It includes classes for building and running queries, handling results sets, building HTML output, and manipulating URI query strings.
* <p><small>This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <a href="http://www.opensource.org/licenses/lgpl-2.1.php">http://www.opensource.org/licenses/lgpl-2.1.php</a>.</small>
* @author Copyright 2009–2011 <a href="http://ipsedixit.net/info/2/contact">Jeff Soo</a>
* @version 1.1.1
* @date Released 2012-01-25
* @sa <a href="http://ipsedixit.net/txp/21/soo-txp-obj">soo_txp_obj Developer Guide</a>
*/
$plugin['name'] = 'soo_txp_obj';
$plugin['description'] = 'Support library for Txp plugins';
$plugin['version'] = '1.1.1';
$plugin['author'] = 'Jeff Soo';
$plugin['author_uri'] = 'http://ipsedixit.net/txp/';
$plugin['type'] = 2;
@include_once('zem_tpl.php');
# --- BEGIN PLUGIN CODE ---
/// Generic abstract base class, with a few low-level utility methods.
abstract class soo_obj
{
/** Generic getter.
* Allow calls in the form $obj->property for protected properties.
*/
public function __get( $property )
{
return isset($this->$property) ? $this->$property : null;
}
/** Method overloading for generic setters.
* Allow calls in the form $obj->property($value).
* Returns $this to allow method chaining.
*/
public function __call( $request, $args )
{
if ( isset($this->$request) )
$this->$request = array_shift($args);
return $this;
}
/** Return an object's class name.
* Allows object to be used in a string context.
* @return string Class name
*/
public function __toString()
{
return get_class($this);
}
/** Return an object's properties as an associative array.
* Note: includes protected and private properties.
* For public properties only, use get_object_vars($obj) directly.
* @return array
*/
public function properties()
{
return get_object_vars($this);
}
/** Return an object's properties as an indexed array.
* @return array
*/
public function property_names()
{
return array_keys($this->properties());
}
}
/// Abstract base class for SQL queries.
abstract class soo_txp_query extends soo_obj
{
/// Database table name.
protected $table = '';
/// SQL WHERE expressions.
protected $where = array();
/// SQL ORDER BY expressions.
protected $order_by = array();
/// SQL LIMIT.
protected $limit = 0;
/// SQL OFFSET.
protected $offset = 0;
/** Constructor.
* Use $key to match a single row matching on appropriate key column
* If $key is an array, current key is the column and current value
* is the value. Otherwise column will be taken from self::key_column().
* @param table Table name
* @param key Key column value (or array) for WHERE expression
*/
public function __construct( $table, $key = null )
{
$this->table = trim($table);
if ( is_array($key) )
$this->where(key($key), current($key));
elseif ( $key )
$this->where($this->key_column($key), $key);
}
/** Add expression to WHERE clause.
* @param column Column name
* @param value Column value(s) (string, array, or soo_txp_select)
* @param operator Comparison operator
* @param join AND or OR
*/
public function where( $column, $value, $operator = '=', $join = '' )
{
$join = $this->andor($join);
if ( is_array($value) )
$value = '(' . implode(',', quote_list(doSlash($value))) . ')';
elseif ( $value instanceof soo_txp_select )
$value = '(' . $value->sql() . ')';
else
$value = "'$value'";
$this->where[] = ( $join ? "$join " : '' ) .
self::quote($column) . " $operator $value";
return $this;
}
/** Add a raw expression to WHERE clause.
* Use instead of {@link where()} for complex (e.g. nested) expressions
* @param clause WHERE Expression
* @param join AND or OR
*/
public function where_clause( $clause, $join = '' )
{
$join = $this->andor($join);
$this->where[] = ( $join ? "$join " : '' ) . $clause;
return $this;
}
/** Add an IN expression to the WHERE clause.
* @param column Column name
* @param list Items to compare against
* @param join AND or OR
* @param in true = IN, false = NOT IN
*/
public function in( $column, $list, $join = '', $in = true )
{
$in = ( $in ? '' : ' not' ) . ' in';
if ( is_string($list) )
$list = do_list($list);
return $this->where($column, $list, $in, $join);
}
/** Alias of in() with $in = false (add a NOT IN expression).
* @param column Column name
* @param list Items to compare against
* @param join AND or OR
*/
public function not_in( $column, $list, $join = '' )
{
return $this->in( $column , $list , $join , false );
}
/** Add a MySQL REGEXP expression to the WHERE clause.
* @param pattern MySQL REGEXP pattern
* @param subject Column name or string to match
* @param join AND or OR
*/
public function regexp( $pattern, $subject, $join = '' )
{
return $this->where($subject, $pattern, 'regexp', $join);
}
protected function andor( $join = 'and' )
{
$join = strtolower($join);
return count($this->where) ?
( in_list($join, 'and,or') ? $join : 'and' ) : '';
}
/** Quote with backticks.
* Only quote items consisting of alphanumerics, $, and/or _
* @param identifier Item to quote
* @return string
*/
public static function quote( $identifier )
{
return preg_match('/^[a-z_$\d]+$/i', $identifier) ?
"`$identifier`" : $identifier;
}
/** Add an expression to the ORDER BY array.
* Example: $query->order_by('foo ASC, bar DESC');
* @param expr Comma-separated list, or array, of expressions
* @param direction ASC or DESC
*/
public function order_by( $expr, $direction = '' )
{
if ( $expr )
{
if ( ! is_array($expr) ) $expr = do_list($expr);
foreach ( $expr as $x )
{
if ( preg_match('/(\S+)\s+(\S+)/', $x, $match) )
list( , $column, $direction) = $match;
else
$column = $x;
if ( in_array(strtolower($column), array('random', 'rand', 'rand()')) )
$column = 'rand()';
else
$direction = in_array(strtolower($direction), array('asc', 'desc')) ? $direction : '';
$this->order_by[] = $column . ( $direction ? ' ' . $direction : '');
}
}
return $this;
}
/** Alias of order_by() for a single column ASC.
* @param col Column name
*/
public function asc( $col )
{
return $this->order_by($col, 'asc');
}
/** Alias of order_by() for a single column DESC.
* @param col Column name
*/
public function desc( $col )
{
return $this->order_by($col, 'desc');
}
/** Add a FIELD() expression to the ORDER BY array.
* For preserving an arbitrary sort order, e.g. '7,5,12,1'
* Note that FIELD() is a MySQL-specific function (not standard SQL)
* @param field Column name
* @param list Comma-separated list, or array, of values in order
*/
public function order_by_field( $field, $list )
{
if ( is_string($list) ) $list = do_list($list);
if ( count($list) )
$this->order_by[] = 'field(' . self::quote($field) . ', ' .
implode(', ', quote_list(doSlash($list))) . ')';
return $this;
}
/** Add a LIMIT to the query.
* @param limit Maximum number of items to return
*/
public function limit( $limit )
{
if ( $limit = intval($limit) )
$this->limit = ' limit ' . $limit;
return $this;
}
/** Add an OFFSET to the query.
* @param offset Number of items to skip
*/
public function offset( $offset )
{
if ( $offset = intval($offset) )
$this->offset = ' offset ' . $offset;
return $this;
}
/** Assemble and return the query clauses as a string.
* @return string
*/
protected function clause_string()
{
return implode(' ', $this->where) .
( count($this->order_by) ? ' order by ' . implode(', ', $this->order_by) : '' ) .
( $this->limit ? $this->limit : '' ) . ( $this->offset ? $this->offset : '' );
}
/** Number of items the query will return.
* Runs the query with COUNT() as the select expression
* @return int|false
*/
public function count()
{
return getCount($this->table, $this->clause_string() ? $this->clause_string() : '1=1');
}
/** Return the key column name for the current table.
* Some Txp tables have multiple indexes.
* If $key_value is provided, column of the matching type will be returned.
* Otherwise the numeric index will be returned in preference to the string index.
* @param key_value
* @return string
*/
public function key_column( $key_value = null )
{
$numeric_index = array(
'textpattern' => 'ID',
'txp_category' => 'id',
'txp_discuss' => 'discussid',
'txp_file' => 'id',
'txp_image' => 'id',
'txp_lang' => 'id',
'txp_link' => 'id',
'txp_log' => 'id',
'txp_users' => 'user_id',
);
$string_index = array(
'textpattern' => 'Title',
'txp_category' => 'name',
'txp_css' => 'name',
'txp_discuss_ipban' => 'ip',
'txp_discuss_nonce' => 'nonce',
'txp_file' => 'filename',
'txp_form' => 'name',
'txp_image' => 'name',
'txp_lang' => 'lang',
'txp_page' => 'name',
'txp_plugin' => 'name',
'txp_prefs' => 'name',
'txp_section' => 'name',
'txp_users' => 'name',
);
if ( isset($numeric_index[$this->table]) )
$nx = $numeric_index[$this->table];
if ( isset($string_index[$this->table]) )
$sx = $string_index[$this->table];
if ( is_numeric($key_value) )
return isset($nx) ? $nx : null;
if ( is_string($key_value) )
return isset($sx) ? $sx : null;
return isset($nx) ? $nx : ( isset($sx) ? $sx : null );
}
}
/// Class for SELECT queries.
class soo_txp_select extends soo_txp_query
{
/// SQL SELECT expressions.
protected $select = array();
/// Whether to add DISTINCT
protected $distinct = false;
/** Constructor.
* @param table Table name
* @param key Optional key for selecting a single record
* @param select item(s) to select
*/
public function __construct( $table, $key = null, $select = null )
{
parent::__construct($table, $key);
if ( $select ) $this->select($select);
}
/** Add items to the SELECT array.
* @param list comma-separated list, or array, of items to select
*/
public function select( $list = '*' )
{
if ( is_string($list) ) $list = do_list($list);
foreach ( $list as $col ) $this->select[] = parent::quote($col);
return $this;
}
/** Add the DISTINCT keyword to the query
* @return $this to allow method chaining
*/
public function distinct( )
{
$this->distinct = true;
return $this;
}
protected function init_query()
{
if ( ! count($this->select) ) $this->select();
if ( ! count($this->where) ) $this->where[] = '1 = 1';
}
/** Return a single record, or empty array if no matching records.
* @return array
*/
public function row()
{
$this->init_query();
return safe_row(implode(',', $this->select), $this->table,
$this->clause_string());
}
/** Return all records, or empty array if no matching records.
* @return array
*/
public function rows()
{
$this->init_query();
return safe_rows( ( $this->distinct ? 'distinct ' : '') .
implode(',', $this->select), $this->table, $this->clause_string());
}
/** Return the query as a string.
* @return string
*/
public function sql()
{
$this->init_query();
return 'select ' . implode(',', $this->select) . ' from ' . safe_pfx($this->table) . ' where ' . $this->clause_string();
}
/** Return result of a SELECT COUNT(*) query
* @int
*/
public function count()
{
$select = $this->select;
$this->select = array('count(*)');
$r = safe_query($this->sql());
$this->select = $select;
if ( $r )
return mysql_result($r, 0);
}
}
/// Class for SELECT ... LEFT JOIN queries.
/// Currently very incomplete; needs to override most parent methods
/// to specify which table each expression refers to.
class soo_txp_left_join extends soo_txp_select
{
/// Join table name
protected $left_join;
/// ON expression for join
protected $join_on;
/// Left table alias
const t1 = 't1';
/// Join table alias
const t2 = 't2';
/** Constructor.
* @param table Left table
* @param left_join Join table
* @param col1 Key column name for left table
* @param col2 Key column name for join table
*/
public function __construct ( $table, $left_join, $col1, $col2 )
{
parent::__construct($table);
$this->left_join = $left_join;
$this->join_on = self::t1 . '.' . self::quote($col1) . ' = ' . self::t2 . '.' . self::quote($col2);
}
/** Like parent::quote, optionally prepending table name/alias.
* @param identifier Column name or alias
* @param prefix Table name or alias
*/
public static function quote( $identifier, $prefix = '' )
{
return ( $prefix ? $prefix . '.' : '' ) . parent::quote($identifier);
}
/** Add items to the SELECT array from the left table.
* @param list comma-separated list, or array, of items to select
*/
public function select( $list = '*' )
{
return self::select_from($list, self::t1);
}
/** Add items to the SELECT array from the join table.
* @param list comma-separated list, or array, of items to select
*/
public function select_join( $list = '*' )
{
return self::select_from($list, self::t2);
}
private function select_from( $list, $table )
{
if ( is_string($list) ) $list = do_list($list);
foreach ( $list as $col ) $this->select[] = self::quote($col, $table);
return $this;
}
/** Add expression to WHERE clause, referring to the left table.
* @param column Column name
* @param value Column value
* @param operator Comparison operator
* @param join AND or OR
*/
public function where( $column, $value, $operator = '=', $join = '' )
{
return parent::where(self::quote($column, self::t1), $value, $operator, $join);
}
/** Add expression to WHERE clause, referring to the join table.
* @param column Column name
* @param value Column value
* @param operator Comparison operator
* @param join AND or OR
*/
public function where_join( $column, $value, $operator = '=', $join = '' )
{
return parent::where(self::quote($column, self::t2), $value, $operator, $join);
}
/** Add an IS NULL expression, for selecting only items not in the join table
* @param column Key column in join table
*/
public function where_join_null( $column )
{
$join = parent::andor('');
$this->where[] = ( $join ? $join . ' ' : '' ) . self::quote($column, self::t2) . ' is null';
return $this;
}
/** Add a column to the ORDER BY array.
* @param col Column name from left table
* @param direction ASC or DESC
*/
public function order_by( $cols, $direction = '' )
{
$direction = in_array(strtolower($direction), array('asc', 'desc')) ? $direction : '';
if ( is_string($cols) ) $cols = do_list($cols);
foreach ( $cols as $col )
{
if ( $col == 'random' or $col == 'rand' or $col == 'rand()' )
{
$col = 'rand()';
$direction = '';
}
$this->order_by[] = self::quote($col, self::t1) . ( $direction ? ' ' . $direction : '');
}
return $this;
}
/** Override parent function; return a single record.
* @return array
*/
public function row()
{
return getRow($this->sql());
}
/** Override parent function; return all records
* @return array
*/
public function rows()
{
return getRows($this->sql());
}
/** Assemble query.
* @return string
*/
public function sql()
{
parent::init_query();
return 'select ' . implode(',', $this->select) . ' from ' . self::quote(safe_pfx($this->table)) . ' as ' . self::t1 . ' left join ' . self::quote(safe_pfx($this->left_join)) . ' as ' . self::t2 . ' on ' . $this->join_on . ' where ' . $this->clause_string();
}
}
/// Class for INSERT and UPDATE queries.
class soo_txp_upsert extends soo_txp_query
{
// For use with VALUES() syntax
/// Columns to be explicitly set.
public $columns = array();
/// VALUES() values.
public $values = array();
/// VALUES() clause
protected $values_clause = '';
// For use with SET col_name=value syntax
/// SET columns and values.
public $set = array();
/// SET clause.
protected $set_clause = '';
/** Constructor.
* Use $col to update a single row matching on appropriate key column
* (usually `name` or `id`)
* @param init Table name, soo_txp_rowset, or soo_txp_row
* @param col Key column value for WHERE expression
*/
public function __construct( $init, $col = null )
{
if ( is_scalar($init) )
parent::__construct($init, $col);
elseif ( $init instanceof soo_txp_rowset )
{
$this->table = $init->table;
if ( $col )
$this->columns = is_array($col) ? $col : do_list($col);
else
$this->columns = array_keys(current($init->data));
foreach ( $init->rows as $r )
$this->values[] = $r->data;
}
elseif ( $init instanceof soo_txp_row )
{
$this->table = $init->table;
if ( $col )
$this->columns = is_array($col) ? $col : do_list($col);
else
$this->columns = array_keys($init->data);
$this->values[] = $init->data;
}
}
/** Add a column:value pair to the $set array.
* @param column Column name
* @param value Column value
*/
public function set( $column, $value )
{
$this->set[$column] = $value;
return $this;
}
private function init_query()
{
if ( count($this->set) )
{
foreach ( $this->set as $col => $val )
{
$val = is_numeric($val) ? $val : "'$val'";
$set_pairs[] = "$col = $val";
}
$this->set_clause = implode(',', $set_pairs);
}
elseif ( count($this->values) )
{
if ( count($this->columns) )
$this->values_clause = '(`' . implode('`,`', $this->columns) . '`) ';
$this->values_clause .= ' values ';
foreach ( $this->values as $vs )
{
$this->values_clause .= '(';
foreach ( $vs as $v )
$this->values_clause .= ( is_numeric($v) ? $v : "'$v'" ) . ',';
$this->values_clause = rtrim($this->values_clause, ',') . '),';
}
$this->values_clause = rtrim($this->values_clause, ',') . ';';
}
}
/** Run the query.
* Runs an UPDATE query if $where is set, otherwise INSERT
* @return bool success or failure
*/
public function upsert()
{
$this->init_query();
if ( count($this->where) )
return safe_upsert($this->table, $this->set_clause, $this->clause_string());
if ( $this->set_clause )
return safe_insert($this->table, $this->set_clause);
if ( $this->values_clause )
return safe_query('insert into ' . safe_pfx($this->table) . $this->values_clause);
}
}
/// Class for DELETE queries.
class soo_txp_delete extends soo_txp_query
{
/** Execute the DELETE query.
* @return bool Query success or failure
*/
public function delete()
{
if ( count($this->where) )
return safe_delete($this->table, $this->clause_string());
}
}
/// Class for data results sets.
class soo_txp_rowset extends soo_obj
{
/// Database table name.
protected $table = '';
/// Array of soo_txp_row objects.
public $rows = array();
/** Constructor.
* $init can be a soo_txp_select object, mysql result resource,
* or an array of records.
* If $index is provided or if $init is a soo_txp_select object,
* the $rows array will be indexed by key column values.
* @param init Data array or query object to initialize rowset
* @param table Txp table name
*/
public function __construct( $init = array(), $table = '', $index = null )
{
if ( $init instanceof soo_txp_select )
{
$table = $init->table;
$index = $init->key_column();
$init = $init->rows();
}
if ( is_resource($init) and mysql_num_rows($init) )
{
while ( $r = mysql_fetch_assoc($init) )
$data[] = $r;
mysql_free_result($init);
$init = $data;
}
$this->table = $table;
if ( is_array($init) and count($init) )
{
foreach ( $init as $r )
if ( $index )
$this->add_row($r, $table, $r[$index]);
else
$this->add_row($r, $table);
}
}
/** Generic getter, overriding parent method.
* If $property is not a property name, look for row object
* matching this index value
* @param property Property name, or rowset index
*/
public function __get( $property )
{
if ( property_exists($this, $property) )
return $this->$property;
if ( array_key_exists($property, $this->rows) )
return $this->rows[$property];
}
/** Return an array of all values for a particular column (field).
* If $key is set, make it an associative array, using the value
* of the key column as the array index
* @param field Column (field) name
* @param key Key column name
*/
public function field_vals( $field, $key = null )
{
foreach ( $this->rows as $r )
if ( ! is_null($key) )
$out[$r->$key] = $r->$field;
else
$out[] = $r->$field;
return isset($out) ? $out : array();
}
/** Add a soo_txp_row object to $rows.
* @param data soo_txp_row object or key value
* @param table Txp table name
* @param i index value for new row in $rows array
*/
public function add_row( $data, $table = null, $i = null )
{
$table = is_null($table) ? $this->table : $table;
$r = $data instanceof soo_txp_row ?
$data : ( $table == 'txp_image' ?
new soo_txp_img($data) : new soo_txp_row($data, $table) );
if ( is_null($i) )
$this->rows[] = $r;
else
$this->rows[$i] = $r;
return $this;
}
/** Split off a subset of rows as a new soo_txp_rowset object
* @param key array key for finding rows for the new set
* @param value key column value to match for rows for the new set
* @param index array index for new rowset rows
* @return soo_txp_rowset
*/
public function subset( $key, $value, $index = null )
{
$out = new self;
foreach ( $this->rows as $row )
if ( $row->$key == $value )
$out->add_row($row, null, is_null($index) ? null : $row->$index);
return $out;
}
}
/// Class for Joe Celko nested sets, aka modified preorder tree
class soo_nested_set extends soo_txp_rowset
{
/** Constructor.
* $init can be a soo_txp_rowset object,
* otherwise see parent::__construct()
* @param init Data array or query object to initialize rowset
* @param table Txp table name
*/
public function __construct( $init = array(), $table = '', $index = null )
{
if ( $init instanceof soo_txp_rowset )
{
$this->table = $init->table;
$this->rows = $init->rows;
}
else
parent::__construct($init, $table);
}
/** Return all rows as a nested array of row objects.
* Each array item is either a soo_txp_row object,
* or an array of such. If an array, it is the children of the
* immediately preceding item.
* This is a recursive function.
* @param rows Internal use only.
* @param rgt Internal use only.
*/
public function as_object_array( &$rows = null, $rgt = null )
{
if ( is_null($rows) )
{
$rows = $this->rows;
$root = current($rows);
$rgt = $root->rgt;
}
while ( $out[] = $node = array_shift($rows) and $node->rgt <= $rgt )
if ( $node->rgt > $node->lft + 1 )
$out[] = $this->as_object_array($rows, $node->rgt);
if ( $node and $node->rgt > $rgt )
array_unshift($rows, array_pop($out));
if ( is_null($out[count($out) - 1]) )
array_pop($out);
return $out;
}
/** Return all rows as a nested array of values.
* Each array item is either a node, as $index_column => $value_column,
* or an array of such. If an array, it is the children of the
* immediately preceding item, and has the key 'x_c' where 'x' is
* the parent node's index.
* This is a recursive function.
* @param index_column Column for node index value
* @param index_column Column for node value
* @param rows Internal use only.
* @param rgt Internal use only.
*/
public function as_array( $index_column, $value_column, &$rows = null, $rgt = null )
{
if ( is_null($rows) )
{
$rows = $this->rows;
$root = current($rows);
$rgt = $root->rgt;
}
while ( $node = array_shift($rows) and $node->rgt <= $rgt )
{
$out[$node->$index_column] = $node->$value_column;
if ( $node->rgt > $node->lft + 1 )
$out[$node->$index_column . '_c'] = $this->as_array($index_column, $value_column, $rows, $node->rgt);
}
if ( $node and $node->rgt > $rgt )
array_unshift($rows, $node);
return $out;
}
/** Split off a subtree of rows as a new soo_nested_set object
* @param root id of subtree root node
* @return soo_txp_rowset
*/
public function subtree( $root, $index = null )
{
$out = new self;
$root = $this->rows[$root];
foreach ( $this->rows as $row )
if ( $row->lft >= $root->lft and $row->rgt <= $root->rgt )
$out->add_row($row, null, is_null($index) ? null : $row->$index);
return $out;
}
}
/// Class for single data records.
class soo_txp_row extends soo_obj
{
/// Database table name.
protected $table = '';
/// Database record.
protected $data = array();
/** Constructor.
* @param init Key value, soo_txp_select object, or data array
* @param table Txp table name
*/
public function __construct( $init = array(), $table = '' )
{
if ( is_scalar($init) and $table )
$init = new soo_txp_select($table, $init);
if ( $init instanceof soo_txp_select )
{
$table = $init->table;
$init = $init->row();
}
if ( is_array($init) )
foreach ( $init as $k => $v )
$this->data[$k] = $v;
$this->table = $table;
}
/** Generic getter, overriding parent method.
* Look for $property in the $data array first
* @param property Column or property name
* @return mixed Data field or object property
*/
public function __get( $property )
{
return isset($this->data[$property]) ? $this->data[$property]
: parent::__get($property);
}
/// Override parent method, to keep $data protected.
public function data( )
{
return;
}
/// @return array Database record (column:value array)
public function properties( )
{
return $this->data;
}
}
/// Class for Txp image records.
class soo_txp_img extends soo_txp_row
{
/// URL of full-size image.
protected $full_url = '';
/// URL of thumbnail image.
protected $thumb_url = '';
/** Constructor.
* @param init Txp image id
*/
public function __construct( $init )
{
global $img_dir;
parent::__construct($init, 'txp_image');
$this->full_url = hu . $img_dir . '/' . $this->id . $this->ext;
if ( $this->thumbnail )
$this->thumb_url = hu . $img_dir . '/' . $this->id . 't' . $this->ext;
}
}
/// Abstact base class for (X)HTML elements.
abstract class soo_html extends soo_obj
{
// HTML element class. Instantiation takes a required 'name' argument and an
// optional 'atts' array: items with keys matching HTML attributes
// will be transferred to the new object.
//
// See the soo_html_img class for an example of how to extend this class.
/// @name Inherent properties
//@{
/// (X)HTML element name
protected $element_name = '';
/// container (false) or empty element (true)
protected $is_empty = 0;
/// Element content array (strings or soo_html objects)
protected $contents = array();
//@}
/// @name Common (X)HTML attributes
//@{
protected $class = '';
protected $dir = '';
protected $id = '';
protected $lang = '';
protected $onclick = '';
protected $ondblclick = '';
protected $onkeydown = '';
protected $onkeypress = '';
protected $onkeyup = '';
protected $onmousedown = '';
protected $onmousemove = '';
protected $onmouseout = '';
protected $onmouseover = '';
protected $onmouseup = '';
protected $style = '';
protected $title = '';
//@}
/** Constructor.
* @param element_name (X)HTML element name
* @param atts Attributes (array of name=>value pairs)
* @param content Element content (string, soo_html object, or array thereof)
*/
public function __construct($element_name, $atts, $content = null, $is_empty = 0)
{
$this->element_name($element_name)->is_empty($is_empty);
if ( empty($atts) )
$atts = array();