2017 © Pedro PelĂĄez
 

library wp-activerecord

An ActiveRecord implementation for WordPress

image

friedolinfoerder/wp-activerecord

An ActiveRecord implementation for WordPress

  • Monday, June 18, 2018
  • by friedolinfoerder
  • Repository
  • 2 Watchers
  • 10 Stars
  • 2 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 5 Forks
  • 0 Open issues
  • 4 Versions
  • 0 % Grown

The README.md

WordPress ActiveRecord

WordPress ActiveRecord implements the active record pattern to easily retrieve, update and delete rows of database tables without struggling with raw SQL query strings. The goal of this library is to provide a small but yet powerful ORM for the CMS WordPress, which should be easy to implement. Therefore it only consists of two classes: ActiveRecord and Query: * The ActiveRecord class maps rows to object instances and the columns to object properties. * The Query class provides a fluent interface to create sql queries., (*1)

Installation

composer require friedolinfoerder/wp-activerecord

Usage

You can use the library in your plugin or directly in your functions.php file. All you have to do is to require the ActiveRecord class and define your model classes (e.g. Slideshow):, (*2)


// create a model class for the table {wp-prefix}slideshows 
class Slideshow extends \wp_activerecord\ActiveRecord {
    protected static $table_name = 'slideshows';
}

With this you can create new rows, update and save them like this:, (*3)

// create new row
$slideshow = Slideshow::create([
    'title'        => 'Header slideshow',
    'slide_time'   => 3000,
    'slide_effect' => 'fade'
]);

// retrieve by id...
$slideshow = Slideshow::get(1);

// ... and update the row
$slideshow->title = 'New title';
$slideshow->slide_effect = 'slide';
$slideshow->save();

API

Class ActiveRecord

Static Properties

Property $casts

Cast row values to native types., (*4)

Example:
class Slideshow extends \wp_activerecord\ActiveRecord {
    protected static $casts = [
        'num_slides' => 'int',
        'duration' => 'float',
        'active' => 'boolean',
        'created_at' => 'datetime',
    ];
}

Static Methods

Method create([$attributes])

Create a model with an array of attributes, (*5)

Example:
$activeRecord = Table::create();
// or
$activeRecord = Table::create([
   'name'  => 'wp-activerecord',
   'title' => 'WordPress ActiveRecord'
]);
Method delete_by_id($id)

Delete a row by id, (*6)

Example:
Table::delete_by_id(3);
Method get([$id])

Get all model instances or a model instance by id, (*7)

Example:
$activeRecords = Table::get(); // all records
$activeRecord = Table::get(3); // one record by id
Method get_{type}_by_{column}($value [, $...])

Dynmamic finder method: Get a var, rows, results or model instances, (*8)

Example:
$activeRecord = Table::get_one_by_title('WordPress');
$array = Table::get_by_name_or_title('wp-activerecord', 'WP');
$row = Table::get_row_by_name_and_title('wp', 'WP');
$var = Table::get_var_name_by_id(3);
Method get_table_name()

Get the table name, (*9)

Example:
$table_name = Table::get_table_name();
Method insert($data)

Insert one or multiple rows into the database, (*10)

Example:
$last_insert_id = Table::insert([
   'name'  => 'wp-activerecord',
   'title' => 'WordPress ActiveRecord'
]);
// or
$last_insert_id = Table::insert([[
   'name'  => 'ActiveRecord',
   'title' => 'Class ActiveRecord'
], [
   'name'  => 'Query',
   'title' => 'Class Query'
]]);
Method query()

Get a query instance, (*11)

Example:
$query = Table::query();
Method update($column [, $value])

Shortcut method for creating a query instance and calling update on it, (*12)

Example:
$query = Table::update('name', 'wp-activerecord-updated');
// or
$query = Table::update([
   'name'  => 'wp-activerecord-updated',
   'title' => 'Updated WordPress ActiveRecord'
]);
Method wpdb()

Get the wpdb instance, (*13)

Example:
$wpdb = Table::wpdb();

// use case:
$userInput = '20%';
Table::query()
  ->delete()
  ->where('name', 'like', '%' . Table::wpdb()->esc_like($userInput) . '%')
  ->execute();

Instance methods

Method delete()

Delete the model, (*14)

Example:
$activeRecord->delete();
Method save()

Save the model, (*15)

Example:
$activeRecord->save();

Event methods

Method save_pre($isNew)

Called before saving the model, (*16)

Example:
// in your derived class:
protected function save_pre($isNew) {
    $this->new = $isNew ? 1 : 0;
}
Method save_post($isNew)

Called after saving the model, (*17)

Example:
// in your derived class:
protected function save_post($isNew) {
    // do something with $this
}
Method delete_pre()

Called before deleting the model, (*18)

Example:
// in your derived class:
protected function delete_pre() {
    // do something with $this
}
Method delete_post()

Called after deleting the model, (*19)

Example:
// in your derived class:
protected function delete_post() {
    // do something with $this
}

Class Query

Static Methods

Method wpdb()

Get the wpdb instance, (*20)

Example:
$wpdb = Query::wpdb();

Instance Methods

Select rows, (*21)

Method select([$...])
Example:
$activeRecord = Table::query()
  ->select('id', 'name')
  ->get();
Method delete()

Delete rows, (*22)

Example:
Table::query()
  ->delete()
  ->where('name', 'wp')
  ->execute();
Method update([$column [, $value]])

Update rows (Alias for \wp_activerecord\Query::set), (*23)

Example:
Table::query()
  ->update()
  ->set('name', 'wp')
  ->execute();
// or
Table::query()
  ->update('name', 'wp')
  ->execute();
// or
Table::query()
  ->update([
    'name'  => 'wp',
    'title' => 'WordPress'
  ])
  ->execute();
Method set($column [, $value])

Set columns, which should be updated, (*24)

Example:
Table::query()
  ->set('name', 'wp')
  ->execute();
// or
Table::query()
  ->set([
    'name'  => 'wp',
    'title' => 'WordPress'
  ])
  ->execute();
Method insert($data)

Insert rows, (*25)

Example:
Table::query()
  ->insert([
    'name'  => 'wp',
    'title' => 'WordPress'
  ])
  ->execute();
// or
Table::query
  ->insert([[
    'name'  => 'ActiveRecord',
    'title' => 'Class ActiveRecord'
  ], [
    'name'  => 'Query',
    'title' => 'Class Query'
  ]])
  ->execute();
Method where($column [, $type_or_value [, $value]])

Add a where condition, (*26)

Example:
$activeRecords = Table::query()
  ->where('name', 'wp')
  ->where('title', 'LIKE', '%active%')
  ->where([
    'start' => 12,
    'end'   => 37
  ])
  ->where(['deleted_at', null]) // query for NULL value, produces  `deleted_at` IS NULL
  ->where('value', '>', ['RAND()']) // raw value wrapped in array
  ->where('numbers', 'in', [[1, 2, 3]] // a array as raw value will be joined
  ->get();
Method and_where($column [, $type_or_value [, $value]])

Alias for where., (*27)

Method or_where($column [, $type_or_value [, $value]])

Alias for where, but adds a new group to the where clause, which will be added with the keyword OR, (*28)

Method group_by($column [, $order])

Add a group by section, (*29)

Example:
$activeRecords = Table::query()
  ->group_by('name', 'asc')
  ->get();
Method having($column [, $type_or_value [, $value]])

Add a having condition, (*30)

Example:
$activeRecords = Table::query()
  ->group_by('name')
  ->having(["SUM(price)"], ">", 10) // raw column value wrapped in array
  ->get();
Method and_having($column [, $type_or_value [, $value]])

Alias for having., (*31)

Method or_having($column [, $type_or_value [, $value]])

Alias for having, but adds a new group to the having clause, which will be added with the keyword OR, (*32)

Method order_by($column [, $order])

Add a order by section, (*33)

Example:
$activeRecords = Table::query()
  ->order_by('description')
  ->order_by('name', 'desc')
  ->get();
Method limit($limit)

Add a limit, (*34)

Example:
$activeRecords = Table::query()
  ->limit(5)
  ->get();
Method offset($offset)

Add a offset, (*35)

Example:
$activeRecords = Table::query()
  ->offset(10)
  ->get();
Method join($table, $attribute, $foreign_attribute [, $type])

Add a join condition, (*36)

Example:
$activeRecords = Table::query()
  ->join('OtherTable', 'id', 'table_id')
  ->get();
Method sql()

Create the final sql statement, (*37)

Example:
$sql = Table::query()
  ->select('description')
  ->where('description', 'like', 'Title: %')
  ->sql();
Method get_results()

Get the results of the query, (*38)

Example:
$results = Table::query()
  ->get_results();
Method get_row()

Get the row of the query, (*39)

Example:
$row = Table::query()
  ->where('name', 'this is a unique name')
  ->get_row();
Method get_col()

Get the column of the query, (*40)

Example:
$descriptions = Table::query()
  ->select('description')
  ->get_col();
Method get_var()

Get the value of the query, (*41)

Example:
$description = Table::query()
  ->select('description')
  ->where('name', 'this is a unique name')
  ->get_var();
Method get()

Get the results of the query as an array of model instances, (*42)

Example:
$activeRecords = Table::query()
  ->get();
Method get_one()

Get the results of the query as a model instances, (*43)

Example:
$activeRecord = Table::query()
  ->where('name', 'this is a unique name')
  ->get_one();
Method execute()

Execute the query, (*44)

Example:
Table::query()
  ->delete()
  ->where('name', 'this is a unique name')
  ->execute();

License

This code is licensed under the MIT license., (*45)

The Versions

18/06 2018

dev-master

9999999-dev https://github.com/friedolinfoerder/wp-activerecord

An ActiveRecord implementation for WordPress

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Friedolin Förder

wordpress database sql php activerecord

18/06 2018

v1.0.2

1.0.2.0 https://github.com/friedolinfoerder/wp-activerecord

An ActiveRecord implementation for WordPress

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Friedolin Förder

wordpress database sql php activerecord

15/06 2018

v1.0.1

1.0.1.0 https://github.com/friedolinfoerder/wp-activerecord

An ActiveRecord implementation for WordPress

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Friedolin Förder

wordpress database sql php activerecord

15/06 2018

v1.0.0

1.0.0.0 https://github.com/friedolinfoerder/wp-activerecord

An ActiveRecord implementation for WordPress

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Friedolin Förder

wordpress database sql php activerecord