Core class used to implement the translations.
since | 1.0.0 |
---|---|
package | GlotPress |
inherited_from | \GP_Thing |
__construct($fields = array()
)
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() |
boolean
after_create() : boolean
This is a placeholder function which should be implemented in the child classes.
boolean
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() |
boolean
after_delete() : boolean
This is a placeholder function which should be implemented in the child classes.
boolean
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 | 3.0.0 Added the `$original_before` parameter. |
inherited_from | \GP_Thing::after_save() |
\GP_Translation
Translation before the update.
boolean
after_save(\GP_Thing $thing_before) : boolean
This is a placeholder function which should be implemented in the child classes.
\GP_Thing
Object before the update.
boolean
all($order = null
)
apply_default_conditions($conditions_str)
can_set_status(string $desired_status) : boolean
since | 2.3.0 |
---|
string
The desired status.
boolean
Whether the status can be set.coerce(array|object $thing) : \GP_Thing | false
since | 1.0.0 |
---|
array
object
Data about the thing retrieved from the database.
\GP_Thing
false
Thing object on success, false on failure.create($args)
inherited_from | \GP_Thing::create() |
---|
create($args) : mixed
array associative array with fields as keys and values as values
mixed
the object corresponding to the inserted row or false on errorcreate_and_select($args) : mixed
array see create()
mixed
the selected object or false on errordelete()
since | 1.0.0 |
---|
delete_all(array $where = null
)
since | 1.0.0 |
---|
array
An array of conditions to use to for a SQL "where" clause, if null, not used and all matching rows will be deleted.
delete_many(array $where)
since | 2.0.0 |
---|
array
An array of conditions to use to for a SQL "where" clause, if not passed, no rows will be deleted.
fields()
find(string|array $conditions, string|array $order = null
) : mixed
since | 1.0.0 |
---|
string
array
string
array
Optional.
mixed
find_many(string|array $conditions, string|array $order = null
) : mixed
since | 1.0.0 |
---|
string
array
string
array
Optional.
mixed
find_many_no_map(string|array $conditions, string|array $order = null
) : mixed
since | 1.0.0 |
---|
string
array
string
array
Optional.
mixed
find_no_map(string|array $conditions, string|array $order = null
) : mixed
since | 1.0.0 |
---|
string
array
string
array
Optional.
mixed
find_one(string|array $conditions, string|array $order = null
) : mixed
since | 1.0.0 |
---|
string
array
string
array
Optional.
mixed
for_export($project, $translation_set, $filters = null
)
for_translation($project, $translation_set, $page, $filters= array()
, $sort= array()
)
force_false_to_null($value)
found_rows()
get(\GP_Thing|integer $thing_or_id) : \GP_Thing | false
since | 1.0.0 |
---|
\GP_Thing
integer
ID of a thing or GP_Thing object.
\GP_Thing
false
Thing object on success, false on failure.get_db_field_formats($args)
get_static($name, $default = null
)
has_static($name)
last_modified(\GP_Translation_Set $translation_set) : string | false
since | 1.0.0 |
---|
\GP_Translation_Set
The translation set to retrieve the last modified date.
string
false
The last modified date on success, false on failure.like_escape_printf($s)
many(string $query, mixed $args) : array<mixed,\GP_Thing>
since | 1.0.0 |
---|---|
since | 3.0.0 Added spread operator and require `$query` argument to be set. |
see | |
see |
string
Query statement with optional sprintf()-like placeholders.
mixed
Optional arguments to pass to the GP_Thing::prepare() function.
array<mixed,\GP_Thing>
A list of GP_Thing objects.many_no_map(string $query, mixed $args) : array<mixed,object>
since | 1.0.0 |
---|---|
since | 3.0.0 Added spread operator and require `$query` argument to be set. |
see | |
see |
string
Query statement with optional sprintf()-like placeholders.
mixed
Optional arguments to pass to the GP_Thing::prepare() function.
array<mixed,object>
Database query results.map(mixed $results) : array<mixed,\GP_Thing> | array<mixed,object>
since | 1.0.0 |
---|
mixed
The results from the database.
array<mixed,\GP_Thing>
array<mixed,object>
If enabled, a list of objects mapped to GP_Thing.map_no_map(mixed $results) : mixed
since | 1.0.0 |
---|
mixed
The results, unmapped.
mixed
normalize_fields(array $args) : array
since | 1.0.0 |
---|---|
inherited_from | \GP_Thing::normalize_fields() |
array
Arguments for a GP_Translation object.
array
Normalized arguments for a GP_Translation object.normalize_fields(array $args) : array
todo | Include default type handling. For example dates 0000-00-00 should be set to null |
---|---|
since | 1.0.0 |
since | 3.0.0 Normalizes int fields to be integers. |
array
Arguments for a GP_Thing object.
array
Normalized arguments for a GP_Thing object.now_in_mysql_format()
one(string $query, mixed $args) : \GP_Thing | false
since | 1.0.0 |
---|---|
since | 3.0.0 Added spread operator and require `$query` argument to be set. |
see | |
see |
string
Query statement with optional sprintf()-like placeholders.
mixed
Optional arguments to pass to the GP_Thing::prepare() function.
\GP_Thing
false
Thing object on success, false on failure.prepare(string $query, mixed $args) : string
since | 1.0.0 |
---|---|
since | 3.0.0 Added spread operator and require `$query` argument to be set. |
see |
string
Query statement with optional sprintf()-like placeholders.
mixed
Optional arguments to pass to the GP_Thing::prepare() function.
string
Sanitized query string, if there is a query to prepare.prepare_fields_for_create($args)
prepare_fields_for_save($args)
inherited_from | \GP_Thing::prepare_fields_for_save() |
---|
prepare_fields_for_save($args)
query(string $query, mixed $args) : integer | boolean
reject()
reload() : \GP_Thing
\GP_Thing
Thing object.restrict_fields(\GP_Validation_Rules $rules)
since | 1.0.0 |
---|---|
inherited_from | \GP_Thing::restrict_fields() |
\GP_Validation_Rules
The validation rules instance.
restrict_fields(\GP_Validation_Rules $rules)
since | 1.0.0 |
---|
\GP_Validation_Rules
The validation rules instance.
save(mixed $args = null
) : boolean | null
since | 1.0.0 |
---|
mixed
Values to update.
boolean
null
Null and false on failure, true on success.select_all_from_conditions_and_order($conditions, $order = null
)
set_as_current()
set_fields(array $fields)
inherited_from | \GP_Thing::set_fields() |
---|
array
Fields for a GP_Thing object.
set_fields(array $fields)
array
Fields for a GP_Thing object.
set_static($name, $value)
set_status(string $status) : boolean
since | 2.3.0 |
---|
string
The status to be set.
boolean
Whether the setting of status was successful.sql_condition_from_php_value(mixed $php_value) : string
Examples:
Input: null
Output: IS NULL
Input: 'foo'
Output: = 'foo'
Input: 1
or '1'
Output: = 1
since | 1.0.0 |
---|
mixed
The PHP value to convert to conditions.
string
SQL conditions.sql_from_conditions($conditions)
sql_from_order($order_by, $order_how = ''
)
sql_limit_for_paging($page, $per_page = null
)
translations()
update($data, $where = null
)
array associative array with fields as keys and updated values as values
validate()
value(string $query, mixed $args) : string | null
since | 1.0.0 |
---|---|
since | 3.0.0 Added spread operator and require `$query` argument to be set. |
see | |
see |
string
Query statement with optional sprintf()-like placeholders.
mixed
Optional arguments to pass to the GP_Thing::prepare() function.
string
null
Database query result (as string), or false on failure._no_map(string $name, mixed $args) : mixed
since | 1.0.0 |
---|
string
Method name.
mixed
Method-dependent arguments.
mixed
$class
$date_added : string
$date_modified : string
$default_conditions
$errors
array()
$field_names : array
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
array()
$found_rows : integer
$id : integer
inherited_from | \GP_Thing::id |
---|
$id
$int_fields : array
array('id', 'original_id', 'translation_set_id', 'user_id', 'user_id_last_modified')
inherited_from | \GP_Thing::int_fields |
---|
$int_fields
array()
$map_results
true
$non_db_field_names
array()
$non_updatable_attributes : array
array('id')
inherited_from | \GP_Thing::non_updatable_attributes |
---|
$non_updatable_attributes
$number_of_plural_translations : integer
6
static |
---|
$original_id : integer
$per_page : integer
15
inherited_from | \GP_Thing::per_page |
---|
$per_page
30
$static
array()
$static_by_class
array()
$status : string
$statuses : array
array('current', 'waiting', 'rejected', 'fuzzy', 'old', 'changesrequested')
static |
---|
$table
null
$table_basename : string
'gp_translations'
inherited_from | \GP_Thing::table_basename |
---|
$table_basename
$translation_0 : string
$translation_1 : string
$translation_2 : string
$translation_3 : string
$translation_4 : string
$translation_5 : string
$translation_set_id : integer
$user_id : integer
$user_id_last_modified : integer
since | 2.1.0 |
---|
$validation_rules
null
$validation_rules_by_class
array()
$warnings : array