Class: Model

[line 53]
Data Model

Describes a database table: fields, rules and relationships.

Automatically composes simple JOIN queries for relationships described in the models via has_many, has_one, etc.

Usage:

1.    // define a new table named photos
2.   $model =& $db->model( 'photo' );
3.  
4.    // define the fields in the table
5.   $model->auto_field( 'id' );
6.  $model->file_field( 'image' );
7.  $model->char_field( 'title', 255 );
8.  $model->text_field( 'caption' );
9.  
10.    // create the table in the database
11.   $model->save();
12.  
13.    // deny access to everybody, unless they are an administrator
14.   $model->let_access( 'all:never all:admin' );
15.  
16.    // function to test whether current user is an administrator
17.   function admin() {
18.    return true;
19.  }

More info... http://dbscript.net/model

Tags:

$access_list =

[line 83]

list of security access rules

$allowed_methods =

[line 113]

list of public methods

$custom_class =

[line 107]

proper CamelCase name of data model object

$exists =

[line 65]

true if table exists in database

$field_array =

[line 71]

list of field names

$field_attrs =

[line 77]

list of field attributes

$limit =

[line 125]

limit query to x records

$offset =

[line 119]

when querying with find(), offset by x records

$order =

[line 137]

order query ASC or DESC

$orderby =

[line 131]

order query by this column

$params =

[line 143]

list of Collection/Feed params for layout

$primary_key =

[line 89]

name of primary key field

$relations =

[line 101]

list of relationships to other tables

$table =

[line 59]

name of the database table

$uri_key =

[line 95]

name of collection key field

---

method base [line 245]

---

method belongs_to [line 373]

---

method can_delete [line 526]

---

method can_display [line 531]

---

method can_display_fields [line 485]

---

method can_insert [line 521]

---

method can_read [line 497]

---

method can_read_fields [line 461]

---

method can_write [line 509]

---

method can_write_fields [line 473]

---

method db_field [line 236]

---

method delete_from_post [line 199]

---

method exists [line 241]

---

method fields_from_request [line 203]

---

method field_attributes [line 293]

---

method find [line 617]

---

method find_by [line 632]

---

method foreign_key_for [line 400]

---

method has_and_belongs_to_many [line 369]

---

method has_many [line 377]

---

method has_one [line 381]

---

method insert_from_post [line 145]

---

method is_allowed [line 359]

---

method is_blob [line 612]

---

method join_table_for [line 420]

---

method let_access [line 297]

---

method let_display [line 335]

---

method let_read [line 303]

---

method let_write [line 319]

---

method MoveFirst [line 636]

---

method MoveNext [line 645]

---

method register [line 270]

---

method rewind [line 544]

---

method rowcount [line 676]

---

method save [line 571]

---

method session_exists [line 654]

---

method set_action [line 351]

---

method set_attribute [line 393]

---

method set_field [line 277]

---

method set_limit [line 660]

---

method set_offset [line 664]

---

method set_order [line 672]

---

method set_orderby [line 668]

---

method set_param [line 355]

---

method set_primary_key [line 287]

---

method set_relation [line 427]

---

method set_routes [line 548]

---

method set_uri_key [line 283]

---

method update_from_post [line 170]

---

method validates_presence_of [line 385]

---

method validates_uniqueness_of [line 389]