Nooku Framework is an open source project powered by Assembla

Assembla offers free public and private SVN/Git repositories and project hosting with bug/issue tracking and collaboration tools.

nooku-framework

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
<?php
/**
 * @version        $Id$
 * @category    Koowa
 * @package     Koowa_Database
 * @subpackage  Rowset
 * @copyright    Copyright (C) 2007 - 2010 Johan Janssens and Mathias Verraes. All rights reserved.
 * @license        GNU GPLv2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
 * @link         http://www.koowa.org
 */

/**
 * Database Rowset Class
 *
 * @author        Johan Janssens <johan@koowa.org>
 * @category    Koowa
 * @package     Koowa_Database
 * @subpackage  Rowset
 * @uses         KMixinClass
 */
abstract class KDatabaseRowsetAbstract extends KObjectArray implements KObjectIdentifiable
{
    /**
     * Tracks columns where data has been updated. Allows more specific
     * save operations.
     *
     * @var array
     */
    protected $_modified = array();

    /**
     * KDatabaseTableAbstract parent class or instance.
     *
     * @var object
     */
    protected $_table;

    /**
     * Name of the identity column in the rowset
     *
     * @var    string
     */
    protected $_identity_column;

     /**
     * Constructor
     *
     * @param     object     An optional KConfig object with configuration options.
     */
    public function __construct(KConfig $config = null)
    {
          //If no config is passed create it
        if(!isset($config)) $config = new KConfig();

        parent::__construct($config);

        // Set the table indentifier
        if(isset($config->table)) {
            $this->setTable($config->table);
        }

        // Set the table indentifier
        if(isset($config->identity_column)) {
            $this->_identity_column = $config->identity_column;
        }

        // Reset the rowset
        $this->reset();

        // Insert the data, if exists
        if(!empty($config->data))
        {
            //Create a row prototype and clone it this is faster then instanciating a new row
            $prototype = KFactory::tmp(KFactory::get($this->getTable())->getRow(), array(
                'table' => $this->getTable(),
                'new'   => $config->new
             ));

             //Set the data in the row object and insert the row
            foreach($config->data as $k => $row)
            {
                $clone = clone $prototype;
                $clone->setData($row, $config->new);

                $this->insert($clone);
            }
        }
    }

    /**
     * Initializes the options for the object
     *
     * Called from {@link __construct()} as a first step of object instantiation.
     *
     * @param     object     An optional KConfig object with configuration options.
     * @return void
     */
    protected function _initialize(KConfig $config)
    {
        $config->append(array(
            'table'              => null,
            'data'                 => null,
            'new'                 => true,
            'identity_column'    => null
        ));

        parent::_initialize($config);
    }

    /**
     * Get the object identifier
     *
     * @return    KIdentifier
     * @see     KObjectIdentifiable
     */
    public function getIdentifier()
    {
        return $this->_identifier;
    }

    /**
     * Get the identifier for the table with the same name
     *
     * @return    KIdentifierInterface
     */
    final public function getTable()
    {
        if(!$this->_table)
        {
            $identifier         = clone $this->_identifier;
            $identifier->name    = KInflector::tableize($identifier->name);
            $identifier->path    = array('table');

            $this->_table = $identifier;
        }

        return $this->_table;
    }

    /**
     * Method to set a table object attached to the rowset
     *
      * @param    mixed    An object that implements KObjectIdentifiable, an object that
     *                  implements KIndentifierInterface or valid identifier string
     * @throws    KDatabaseRowsetException    If the identifier is not a table identifier
     * @return    KDatabaseRowsetAbstract
     */
    public function setTable($table)
    {
        $identifier = KFactory::identify($table);

        if($identifier->path[0] != 'table') {
            throw new KDatabaseRowsetException('Identifier: '.$identifier.' is not a table identifier');
        }

        $this->_table = $identifier;
        return $this;
    }

    /**
     * Returns all data as an array.
     *
     * @param   boolean     If TRUE, only return the modified data. Default FALSE
     * @return array
     */
    public function getData($modified = false)
    {
        $result = array();
        foreach ($this->_data as $i => $row)  {
            $result[$i] = $row->getData($modified);
        }
        return $result;
    }

    /**
       * Set the rowset data based on a named array/hash
       *
       * @param   mixed     Either and associative array, a KDatabaseRow object or object
       * @param   boolean If TRUE, update the modified information for each column being set.
       *                     Default TRUE
      * @return     KDatabaseRowsetAbstract
       */
       public function setData( $data, $modified = true )
       {
          //Get the data
           if($data instanceof KDatabaseRowAbstract) {
            $data = $data->getData();
        } else {
            $data = (array) $data;
        }

        //Prevent changing the identity column
        if(isset($this->_identity_column)) {
            unset($data[$this->_identity_column]);
        }

        //Set the data in the rows
        if($modified)
           {
               foreach($data as $column => $value) {
                   $this->$column = $value;
               }
           }
           else
           {
               foreach ($this->_data as $i => $row) {
                   $row->setData($data, false);
            }
           }

           //Track any new colums being added
           foreach ($data as $column => $value)
           {
                if(!in_array($column, $this->_columns)) {
                $this->_columns[] = $column;
            }
       }

          return $this;
    }

    /**
     * Get a list of columns that have been modified
     *
     * @return array    An array of column names that have been modified
     */
    public function getModified()
    {
        return array_keys($this->_modified);
    }

    /**
     * Gets the identitiy column of the rowset
     *
     * @return string
     */
    public function getIdentityColumn()
    {
        return $this->_identity_column;
    }

    /**
     * Returns a KDatabaseRow from a known position or based on a key/value pair
     *
     * @param     string     The position or the key to search for
     * @param     mixed      The value to search for
     * @return KDatabaseRowAbstract
     */
    public function find($key, $value = null)
    {
        if(!is_null($value))
        {
            $result = KFactory::tmp(KFactory::get($this->getTable())->getRow(), array('table' => $this->getTable()));

            foreach ($this as $i => $row)
            {
                if($row->$key == $value)
                {
                    $result = $row;
                    break;
                }
            }
        }
        else $result = $this->_data[$key];

        return $result;
    }

    /**
     * Saves all rows in the rowset to the database
     *
     * @return KDatabaseRowsetAbstract
     */
    public function save()
    {
        foreach ($this as $i => $row) {
            $row->save();
        }

        return $this;
    }

    /**
     * Deletes all rows in the rowset from the database
     *
     * @return KDatabaseRowsetAbstract
     */
    public function delete()
    {
        foreach ($this as $i => $row) {
            $row->delete();
        }

        return $this;
    }

    /**
     * Reset the rowset
     *
     * @return KDatabaseRowsetAbstract
     */
    public function reset()
    {
        $this->_columns  = array_keys(KFactory::get($this->getTable())->getColumns());
        $this->_modified = array();

        $this->_data = array();

        return $this;
    }

    /**
     * Insert a row in the rowset
     *
     * The row will be stored by i'ts identity_column if set or otherwise by
     * it's object handle.
     *
     * @param  object     A KDatabaseRow object to be inserted
     * @return KDatabaseRowsetAbstract
     */
    public function insert(KDatabaseRowAbstract $row)
    {
        if(isset($this->_identity_column)) {
            $this->_data[$row->{$this->_identity_column}] = $row;
        } else {
            $this->_data[$row->getHandle()] = $row;
        }

        //Add the columns, only if they don't exist yet
        $columns = array_keys($row->getData());
        foreach($columns as $column)
        {
            if(!in_array($column, $this->_columns)) {
                $this->_columns[] = $column;
            }
        }

        return $this;
    }

    /**
     * Extracts a row
     *
     * The row will be removed based on it's identity_column if set or otherwise by
     * it's object handle.
     *
     * @param  object     A KDatabaseRow object to be removed
     * @return KDatabaseRowsetAbstract
     */
    public function extract(KDatabaseRowAbstract $row)
    {
        if(isset($this->_identity_column)) {
            unset($this->_data[$row->{$this->_identity_column}]);
        } else {
            unset($this->_data[$row->getHandle()]);
        }

        return $this;
    }

    /**
     * Set row field value
     *
     * @param      string     The column name.
     * @param      mixed      The value for the property.
     * @return     void
     */
    public function __set($column, $value)
    {
        parent::__set($column, $value);

        //Track the column as modified
        $this->_modified[$column] = true;
   }

    /**
     * Forward the call to each row
     *
        * @param  string     The function name
     * @param  array      The function arguments
     * @throws BadMethodCallException     If method could not be found
     * @return mixed The result of the function
     */
    public function __call($method, array $arguments)
    {
            //If the method hasn't been mixed yet, load all the behaviors
        if(!isset($this->_mixed_methods[$method]))
        {
            foreach(KFactory::get($this->getTable())->getBehaviors() as $behavior) {
                $this->mixin(KFactory::get($behavior));
            }
        }

            //If the method is of the formet is[Bahavior] handle it
        $parts = KInflector::explode($method);

        if($parts[0] == 'is' && isset($parts[1]))
        {
            if(isset($this->_mixed_methods[$method])) {
                return true;
            }

            return false;
        }
        else
        {
                //If the mixed method exists call it for all the rows
            if(isset($this->_mixed_methods[$method]))
            {
                foreach ($this as $i => $row) {
                     $row->__call($method, $arguments);
                }

                return $this;
            }
        }

        //If the method cannot be found throw an exception
        throw new BadMethodCallException('Call to undefined method :'.$method);
    }
}
Ajax-loader Loading, please wait...