Core class used to implement the glossaries.

since 1.0.0
package GlotPress
inherited_from \GP_Thing

 Methods

__construct()

__construct($fields = array()
Inherited

Parameters

$fields

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

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

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

by_set_id()

by_set_id($set_id) 

Parameters

$set_id

Get the glossary by set/project.

by_set_or_parent_project(\GP_Translation_Set $translation_set, \GP_Project $project) : \GP_Glossary | boolean

If there's no glossary for this specific project, get the nearest parent glossary

Parameters

$translation_set

\GP_Translation_Set

$project

\GP_Project

Returns

\GP_Glossaryboolean

coerce()

coerce($thing) 
Inherited

Parameters

$thing

Copies glossary items from a glossary to the current one This function does not merge then, just copies unconditionally. If a translation already exists, it will be duplicated.

copy_glossary_items_from(integer $source_glossary_id) : mixed

Parameters

$source_glossary_id

integer

Returns

mixed

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 glossary and all of it's entries.

delete() : boolean
since 2.0.0
inherited_from \GP_Thing::delete()

Returns

boolean

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

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

Retrieves entries and cache them.

get_entries() : array
since 2.3.0

Returns

arrayArray of Glossary_Entry.

Get the virtual Locale Glossary project

get_locale_glossary_project() : \GP_Project
since 2.3.0

Returns

\GP_ProjectThe project

get_static()

get_static($name, $default = null
Inherited

Parameters

$name

$default

has_static()

has_static($name) 
Inherited

Parameters

$name

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

Merges entries of a glossary with another one.

merge_with_glossary(\GP_Glossary $merge) : array
since 2.3.0

Parameters

$merge

\GP_Glossary

The Glossary to merge into the current one.

Returns

arrayArray of Glossary_Entry.

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

Get the path to the glossary.

path() : string

Returns

string

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

Parameters

$args

Performs a database query.

query() : mixed
Inherited
since 1.0.0

Returns

mixed

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_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

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

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

 

$default_conditions

$default_conditions 

Default

 

$description

$description 

Default

 

$errors

$errors 

Default

array()
 

$field_names

$field_names 

Default

array('id', 'translation_set_id', 'description')
inherited_from \GP_Thing::field_names
 

$field_names

$field_names 

Default

array()
 

$id

$id 

Default

inherited_from \GP_Thing::id
 

$id

$id 

Default

 

$int_fields

$int_fields 

Default

array('id', 'translation_set_id')
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()
 

$non_updatable_attributes

$non_updatable_attributes 

Default

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

$non_updatable_attributes

$non_updatable_attributes 

Default

 

$per_page

$per_page 

Default

30
 

$static

$static 

Default

array()
 

$static_by_class

$static_by_class 

Default

array()
Static
 

$table

$table 

Default

null
 

$table_basename

$table_basename 

Default

'gp_glossaries'
inherited_from \GP_Thing::table_basename
 

$table_basename

$table_basename 

Default

 

$translation_set_id

$translation_set_id 

Default

 

$validation_rules

$validation_rules 

Default

null
 

$validation_rules_by_class

$validation_rules_by_class 

Default

array()
Static
 

Caches the array of Glossary_Entry objects.

$entries : \entries

Default

array()
since 2.3.0