Core class used to implement the translations.

since 1.0.0
package GlotPress
inherited_from \GP_Thing

 Methods

__construct()

__construct($fields = array()
Inherited

Parameters

$fields

Executes after creating a translation.

after_create() : boolean

This is a placeholder function which should be implemented in the child classes.

since 1.0.0
inherited_from \GP_Thing::after_create()

Returns

boolean

Is called after an object is created in the database.

after_create() : boolean
Inherited

This is a placeholder function which should be implemented in the child classes.

Returns

boolean

Executes after deleting a translation.

after_delete() : boolean

This is a placeholder function which should be implemented in the child classes.

since 2.0.0
inherited_from \GP_Thing::after_delete()

Returns

boolean

Is called after an object is deleted from the database.

after_delete() : boolean
Inherited

This is a placeholder function which should be implemented in the child classes.

Returns

boolean

Executes after saving a translation.

after_save(\GP_Translation $translation_before) : boolean

This is a placeholder function which should be implemented in the child classes.

since 1.0.0
since 2.4.0 Added the `$original_before` parameter.
inherited_from \GP_Thing::after_save()

Parameters

$translation_before

\GP_Translation

Translation before the update.

Returns

boolean

Is called after an object is saved to the database.

after_save(\GP_Thing $thing_before) : boolean
Inherited

This is a placeholder function which should be implemented in the child classes.

Parameters

$thing_before

\GP_Thing

Object before the update.

Returns

boolean

Retrieves all rows from this table

all($order = null
Inherited

Parameters

$order

apply_default_conditions()

apply_default_conditions($conditions_str) 
Inherited

Parameters

$conditions_str

Decides whether the status of a translation can be changed to a desired status.

can_set_status(string $desired_status) : boolean
since 2.3.0

Parameters

$desired_status

string

The desired status.

Returns

booleanWhether the status can be set.

coerce()

coerce($thing) 
Inherited

Parameters

$thing

Inserts a new row

create($args) 
inherited_from \GP_Thing::create()

Parameters

$args

Inserts a new row

create($args) : mixed
Inherited

Parameters

$args

array associative array with fields as keys and values as values

Returns

mixedthe object corresponding to the inserted row or false on error

Inserts a record and then selects it back based on the id

create_and_select($args) : mixed
Inherited

Parameters

$args

array see create()

Returns

mixedthe selected object or false on error

Deletes a single row

delete() 
Inherited
since 1.0.0

Deletes all or multiple rows

delete_all(array $where = null
Inherited
since 1.0.0

Parameters

$where

array

An array of conditions to use to for a SQL "where" clause, if null, not used and all matching rows will be deleted.

Deletes multiple rows

delete_many(array $where = null
Inherited
since 2.0.0

Parameters

$where

array

An array of conditions to use to for a SQL "where" clause, if not passed, no rows will be deleted.

fields()

fields() 
Inherited

[find description]

find(string|array $conditions, string|array $order = null) : mixed
Inherited
since 1.0.0

Parameters

$conditions

stringarray

$order

stringarray

Optional.

Returns

mixed

[find_many description]

find_many(string|array $conditions, string|array $order = null) : mixed
Inherited
since 1.0.0

Parameters

$conditions

stringarray

$order

stringarray

Optional.

Returns

mixed

[find_many_no_map description]

find_many_no_map(string|array $conditions, string|array $order = null) : mixed
Inherited
since 1.0.0

Parameters

$conditions

stringarray

$order

stringarray

Optional.

Returns

mixed

[find_no_map description]

find_no_map(string|array $conditions, string|array $order = null) : mixed
Inherited
since 1.0.0

Parameters

$conditions

stringarray

$order

stringarray

Optional.

Returns

mixed

[find_one description]

find_one(string|array $conditions, string|array $order = null) : mixed
Inherited
since 1.0.0

Parameters

$conditions

stringarray

$order

stringarray

Optional.

Returns

mixed

for_export()

for_export($project, $translation_set, $filters = null

Parameters

$project

$translation_set

$filters

for_translation()

for_translation($project, $translation_set, $page, $filters = array(), $sort = array()

Parameters

$project

$translation_set

$page

$filters

$sort

force_false_to_null()

force_false_to_null($value) 
Inherited

Parameters

$value

found_rows()

found_rows() 
Inherited

get()

get($thing_or_id) 
Inherited

Parameters

$thing_or_id

get_db_field_formats()

get_db_field_formats($args) 
Inherited

Parameters

$args

get_static()

get_static($name, $default = null
Inherited

Parameters

$name

$default

has_static()

has_static($name) 
Inherited

Parameters

$name

last_modified()

last_modified($translation_set) 

Parameters

$translation_set

like_escape_printf()

like_escape_printf($s) 
Inherited

Parameters

$s

Retrieves multiple rows from this table

many() : mixed
Inherited

For parameters description see $wpdb->prepare().

since 1.0.0

Returns

mixedAn object, containing the selected row or false on error.

[many_no_map description]

many_no_map() : mixed
Inherited
since 1.0.0

Returns

mixed

[map description]

map(mixed $results) : mixed
Inherited
since 1.0.0

Parameters

$results

mixed

The results, mapped.

Returns

mixed

[map_no_map description]

map_no_map(mixed $results) : mixed
Inherited
since 1.0.0

Parameters

$results

mixed

The results, unmapped.

Returns

mixed

Normalizes an array with key-value pairs representing a GP_Translation object.

normalize_fields(array $args) : array
since 1.0.0
inherited_from \GP_Thing::normalize_fields()

Parameters

$args

array

Arguments for a GP_Translation object.

Returns

arrayNormalized arguments for a GP_Translation object.

Normalizes an array with key-value pairs representing a GP_Thing object.

normalize_fields(array $args) : array
Inherited
todo Include default type handling. For example dates 0000-00-00 should be set to null
since 1.0.0

Parameters

$args

array

Arguments for a GP_Thing object.

Returns

arrayNormalized arguments for a GP_Thing object.

now_in_mysql_format()

now_in_mysql_format() 
Inherited

Retrieves a single row from this table

one() : mixed
Inherited

For parameters description see BPDB::prepare()

Returns

mixedan object, containing the selected row or false on error

prepare()

prepare($args) 
Inherited

Parameters

$args

prepare_fields_for_create()

prepare_fields_for_create($args) 
Inherited

Parameters

$args

Prepares for enetering the database an array with key-value pairs, preresenting a GP_Thing object.

prepare_fields_for_save($args) 
inherited_from \GP_Thing::prepare_fields_for_save()

Parameters

$args

Prepares for enetering the database an array with key-value pairs, preresenting a GP_Thing object.

prepare_fields_for_save($args) 
Inherited

Parameters

$args

Performs a database query.

query() : mixed
Inherited
since 1.0.0

Returns

mixed

reject()

reject() 

Reloads the object data from the database, based on its id

reload() 
Inherited

Sets restriction rules for fields.

restrict_fields(\GP_Validation_Rules $rules) 
since 1.0.0
inherited_from \GP_Thing::restrict_fields()

Parameters

$rules

\GP_Validation_Rules

The validation rules instance.

Sets restriction rules for fields.

restrict_fields(\GP_Validation_Rules $rules) 
Inherited
since 1.0.0

Parameters

$rules

\GP_Validation_Rules

The validation rules instance.

Saves an existing thing.

save(mixed $args = null) : boolean | null
Inherited
since 1.0.0

Parameters

$args

mixed

Values to update.

Returns

booleannullNull and false on failure, true on success.

select_all_from_conditions_and_order()

select_all_from_conditions_and_order($conditions, $order = null
Inherited

Parameters

$conditions

$order

set_as_current()

set_as_current() 

set_fields()

set_fields($db_object) 
inherited_from \GP_Thing::set_fields()

Parameters

$db_object

set_fields()

set_fields($db_object) 
Inherited

Parameters

$db_object

set_memory_limit()

set_memory_limit($new_limit) 
Inherited

Parameters

$new_limit

set_static()

set_static($name, $value) 
Inherited

Parameters

$name

$value

Changes the status of a translation if possible.

set_status(string $status) : boolean
since 2.3.0

Parameters

$status

string

The status to be set.

Returns

booleanWhether the setting of status was successful.

sql_condition_from_php_value()

sql_condition_from_php_value($php_value) 
Inherited

Parameters

$php_value

sql_from_conditions()

sql_from_conditions($conditions) 
Inherited

Parameters

$conditions

sql_from_order()

sql_from_order($order_by, $order_how = ''
Inherited

Parameters

$order_by

$order_how

sql_limit_for_paging()

sql_limit_for_paging($page, $per_page = null
Inherited

Parameters

$page

$per_page

translations()

translations() 

Updates a single row

update($data, $where = null
Inherited

Parameters

$data

array associative array with fields as keys and updated values as values

$where

validate()

validate() 
Inherited

Retrieves a single value from this table

value() : scalar
Inherited

For parameters description see BPDB::prepare()

Returns

scalarthe result of the query or false on error

[_no_map description]

_no_map(string $name, mixed $args) : mixed
Inherited
since 1.0.0

Parameters

$name

string

Method name.

$args

mixed

Method-dependent arguments.

Returns

mixed

 Properties

 

$class

$class 

Default

 

Date when the translation was added.

$date_added : string

Default

 

Date when the translation was modified.

$date_modified : string

Default

 

$default_conditions

$default_conditions 

Default

 

$errors

$errors 

Default

array()
 

List of field names for a translation.

$field_names : array

Default

array('id', 'original_id', 'translation_set_id', 'translation_0', 'translation_1', 'translation_2', 'translation_3', 'translation_4', 'translation_5', 'user_id', 'user_id_last_modified', 'status', 'date_added', 'date_modified', 'warnings')
inherited_from \GP_Thing::field_names
 

$field_names

$field_names 

Default

array()
 

Number of found results.

$found_rows : integer

Default

 

ID of the translation.

$id : integer

Default

inherited_from \GP_Thing::id
 

$id

$id 

Default

 

List of field names which have an integer value.

$int_fields : array

Default

array('id', 'original_id', 'translation_set_id', 'user_id', 'user_id_last_modified')
inherited_from \GP_Thing::int_fields
 

$int_fields

$int_fields 

Default

array()
 

$map_results

$map_results 

Default

true
 

$non_db_field_names

$non_db_field_names 

Default

array()
 

List of field names which cannot be updated.

$non_updatable_attributes : array

Default

array('id')
inherited_from \GP_Thing::non_updatable_attributes
 

$non_updatable_attributes

$non_updatable_attributes 

Default

 

Number of supported translations per original.

$number_of_plural_translations : integer

Default

6
Static
static
 

ID of the original.

$original_id : integer

Default

 

Number of translations per page.

$per_page : integer

Default

15
inherited_from \GP_Thing::per_page
 

$per_page

$per_page 

Default

30
 

$static

$static 

Default

array()
 

$static_by_class

$static_by_class 

Default

array()
Static
 

Status of the translation.

$status : string

Default

 

List of valid statuses.

$statuses : array

Default

array('current', 'waiting', 'rejected', 'fuzzy', 'old')
Static
static
 

$table

$table 

Default

null
 

Name of the database table.

$table_basename : string

Default

'gp_translations'
inherited_from \GP_Thing::table_basename
 

$table_basename

$table_basename 

Default

 

Translation for a singular form.

$translation_0 : string

Default

 

Translation for a plural form.

$translation_1 : string

Default

 

Translation for a second plural form.

$translation_2 : string

Default

 

Translation for a third plural form.

$translation_3 : string

Default

 

Translation for a fourth plural form.

$translation_4 : string

Default

 

Translation for a fifth plural form.

$translation_5 : string

Default

 

ID of the translation set.

$translation_set_id : integer

Default

 

ID of a user who submitted the translation.

$user_id : integer

Default

 

ID of a user (validator) who last changed the status of the translation.

$user_id_last_modified : integer

Default

since 2.1.0
 

$validation_rules

$validation_rules 

Default

null
 

$validation_rules_by_class

$validation_rules_by_class 

Default

array()
Static
 

List of warnings when translation isn't correct.

$warnings : array

Default