tmdinosaurcenter
/
tainacan
mirror of https://github.com/tainacan/tainacan
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Cleaning up old methods #261

This commit is contained in:
Leo Germani 2019-09-13 16:49:59 -03:00
parent 3535217df7
commit c3f97cf61b
3 changed files with 47 additions and 212 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

234
src/classes/repositories/class-tainacan-logs.php
View File

@ -32,7 +32,7 @@ class Logs extends Repository {
protected function __construct() { protected function __construct() {
parent::__construct(); parent::__construct();
add_action( 'tainacan-pre-insert', array( $this, 'prepare_entity_diff' ) ); add_action( 'tainacan-pre-insert', array( $this, 'pre_insert_entity' ) );
add_action( 'tainacan-insert', array( $this, 'insert_entity' ) ); add_action( 'tainacan-insert', array( $this, 'insert_entity' ) );
add_action( 'tainacan-deleted', array( $this, 'delete_entity' ), 10, 2 ); add_action( 'tainacan-deleted', array( $this, 'delete_entity' ), 10, 2 );
@ -59,13 +59,6 @@ class Logs extends Repository {
'type' => 'string', 'type' => 'string',
'description' => __( 'The log date', 'tainacan' ), 'description' => __( 'The log date', 'tainacan' ),
], ],
// 'parent' => [
// 'map' => 'parent',
// 'title' => __( 'Parent', 'tainacan' ),
// 'type' => 'string',
// 'description' => __( 'Log order' ),
// 'validation' => ''
// ],
'description' => [ 'description' => [
'map' => 'post_content', 'map' => 'post_content',
'title' => __( 'Description', 'tainacan' ), 'title' => __( 'Description', 'tainacan' ),
@ -230,7 +223,11 @@ class Logs extends Repository {
public function update( $object, $new_values = null ) { public function update( $object, $new_values = null ) {
return $this->insert( $object ); return $this->insert( $object );
} }
/**
* Feth most recent log
* @return Entities\Log The most recent Log entity
*/
public function fetch_last() { public function fetch_last() {
$args = [ $args = [
'post_type' => Entities\Log::get_post_type(), 'post_type' => Entities\Log::get_post_type(),
@ -244,18 +241,18 @@ class Logs extends Repository {
return array_pop( $logs ); return array_pop( $logs );
} }
/**
* Callback to generate log when attachments are added to any Tainacan entity
*/
public function insert_attachment( $post_ID ) { public function insert_attachment( $post_ID ) {
$attachment = get_post( $post_ID ); $attachment = get_post( $post_ID );
$post = $attachment->post_parent; $post = $attachment->post_parent;
if ( $post ) { if ( $post ) { // attached to a post
// was added attachment on a tainacan object
$entity = Repository::get_entity_by_post( $post ); $entity = Repository::get_entity_by_post( $post );
if ( $entity ) { if ( $entity ) { // attached to a tainacan entity
// was added a normal attachment
$log = new Entities\Log(); $log = new Entities\Log();
@ -302,6 +299,9 @@ class Logs extends Repository {
} }
/**
* Callback to generate log when attachments attached to any Tainacan entity are deleted
*/
public function pre_delete_attachment($attachment_id) { public function pre_delete_attachment($attachment_id) {
$attachment_post = get_post($attachment_id); $attachment_post = get_post($attachment_id);
@ -309,13 +309,11 @@ class Logs extends Repository {
$entity_post = get_post($attachment_post->post_parent); $entity_post = get_post($attachment_post->post_parent);
if ( $entity_post ) { if ( $entity_post ) {
// was added attachment on a tainacan object
$entity = Repository::get_entity_by_post( $entity_post ); $entity = Repository::get_entity_by_post( $entity_post );
if ( $entity ) { if ( $entity ) {
$collection_id = method_exists($entity, 'get_collection_id') ? $entity->get_collection_id() : 'default'; $collection_id = method_exists($entity, 'get_collection_id') ? $entity->get_collection_id() : 'default';
$log = new Entities\Log(); $log = new Entities\Log();
@ -351,6 +349,9 @@ class Logs extends Repository {
} }
} }
/**
* Callback to generate log when attachments attached to any Tainacan entity are deleted
*/
public function delete_attachment($attachment_id) { public function delete_attachment($attachment_id) {
if ( isset($this->current_attachment_delete_log) && $this->current_attachment_delete_log instanceof Entities\Log ) { if ( isset($this->current_attachment_delete_log) && $this->current_attachment_delete_log instanceof Entities\Log ) {
$log = $this->current_attachment_delete_log; $log = $this->current_attachment_delete_log;
@ -361,95 +362,6 @@ class Logs extends Repository {
} }
} }
private function prepare_attachments($attachments) {
$attachments_prepared = [];
if ( is_array($attachments) ) {
foreach ( $attachments as $attachment ) {
$prepared = [
'id' => $attachment->ID,
'title' => $attachment->post_title,
'description' => $attachment->post_content,
'mime_type' => $attachment->post_mime_type,
'url' => wp_get_attachment_url($attachment->ID),
];
array_push( $attachments_prepared, $prepared );
}
}
return $attachments_prepared;
}
/**
* Insert a log when a new entity is inserted
*
* @param Entity $value
* @param array $diffs
* @param bool $is_update
*
* @param bool $is_delete
* @param bool $is_trash
*
* @return Entities\Log|bool new created log
*/
public function insert_log( $value, $diffs = [], $is_update = false, $is_delete = false, $is_trash = false ) {
$title = null;
$description = null;
if ( is_object( $value ) ) {
// do not log a log
if ( ( method_exists( $value, 'get_post_type' ) && $value->get_post_type() === 'tainacan-log' ) || $value->get_status() === 'auto-draft' ) {
return false;
}
if ( $value instanceof Entities\Metadatum ) {
$type = $value->get_metadata_type();
if ( $type === 'Tainacan\Metadata_Types\Core_Title' || $type === 'Tainacan\Metadata_Types\Core_Description' ) {
return false;
}
}
$type = get_class( $value );
$class_name = explode( '\\', $type )[2];
$name = method_exists( $value, 'get_name' ) ? $value->get_name() :
( method_exists( $value, 'get_title' ) ? $value->get_title() : $value->get_metadatum()->get_name() );
if ( ! $name ) {
$name = $value->get_status();
}
if ( $is_update ) {
// entity was delete
$title = $this->prepare_event_title( $value, $name, $class_name, 'updated' );
$description = $title;
} elseif ( $is_delete ) {
// entity was deleted
$title = $this->prepare_event_title( $value, $name, $class_name, 'deleted' );
$description = $title;
} elseif ( ! empty( $diffs ) ) {
// entity was created
$title = $this->prepare_event_title( $value, $name, $class_name, 'created' );
$description = $title;
} elseif ( $is_trash ) {
// entity was trashed
$title = $this->prepare_event_title( $value, $name, $class_name, 'trashed' );
$description = $title;
}
$title = apply_filters( 'tainacan-insert-log-message-title', $title, $type, $value );
$description = apply_filters( 'tainacan-insert-log-description', $description, $type, $value );
}
if ( !empty( $diffs ) || $is_delete || $is_trash) {
return Entities\Log::create( $title, $description, $value, $diffs );
}
}
/** /**
* Compare two repository entities and sets the current_diff property to be used in the insert hook * Compare two repository entities and sets the current_diff property to be used in the insert hook
* *
@ -457,7 +369,7 @@ class Logs extends Repository {
* *
* @return void * @return void
*/ */
public function prepare_entity_diff( Entities\Entity $unsaved ) { public function pre_insert_entity( Entities\Entity $unsaved ) {
if ( ! $unsaved->get_repository()->use_logs ) { if ( ! $unsaved->get_repository()->use_logs ) {
return; return;
@ -465,8 +377,6 @@ class Logs extends Repository {
if ( $unsaved instanceof Entities\Item_Metadata_Entity ) { if ( $unsaved instanceof Entities\Item_Metadata_Entity ) {
return $this->prepare_item_metadata_diff($unsaved); return $this->prepare_item_metadata_diff($unsaved);
} elseif ( $unsaved instanceof Entities\Term ) {
return $this->prepare_term_diff($unsaved);
} }
// do not log a log // do not log a log
@ -475,7 +385,12 @@ class Logs extends Repository {
} }
$creating = true; $creating = true;
$old = $unsaved->get_repository()->fetch( $unsaved->get_id() );
if ( $unsaved instanceof Entities\Term ) {
$old = $unsaved->get_repository()->fetch( $unsaved->get_id(), $unsaved->get_taxonomy() );
} else {
$old = $unsaved->get_repository()->fetch( $unsaved->get_id() );
}
if ( $old instanceof Entities\Entity ) { if ( $old instanceof Entities\Entity ) {
@ -496,7 +411,6 @@ class Logs extends Repository {
$map = $unsaved->get_repository()->get_map(); $map = $unsaved->get_repository()->get_map();
foreach ( $map as $prop => $mapped ) { foreach ( $map as $prop => $mapped ) {
// I can't verify differences on item, because it attributes are added when item is a auto-draft
if ( $old->get( $prop ) != $unsaved->get( $prop ) ) { if ( $old->get( $prop ) != $unsaved->get( $prop ) ) {
$diff['old'][$prop] = $old->get( $prop ); $diff['old'][$prop] = $old->get( $prop );
@ -513,46 +427,6 @@ class Logs extends Repository {
} }
private function prepare_term_diff( Entities\Term $unsaved ) {
$creating = true;
$old = $unsaved->get_repository()->fetch( $unsaved->get_id(), $unsaved->get_taxonomy() );
if ( $old instanceof Entities\Entity ) {
if ( $old->get_status() !== 'auto-draft' ) {
$creating = false;
}
}
$diff = [
'old' => [],
'new' => []
];
if ( $creating ) {
$diff['new'] = $unsaved->_toArray();
} else {
$map = $unsaved->get_repository()->get_map();
foreach ( $map as $prop => $mapped ) {
// I can't verify differences on item, because it attributes are added when item is a auto-draft
if ( $old->get( $prop ) != $unsaved->get( $prop ) ) {
$diff['old'][$prop] = $old->get( $prop );
$diff['new'][$prop] = $unsaved->get( $prop );
}
}
}
$diff = apply_filters( 'tainacan-entity-diff', $diff, $unsaved, $old );
$this->current_diff = $diff;
$this->current_action = $creating ? 'create' : 'update';
}
private function prepare_item_metadata_diff( Entities\Entity $unsaved ) { private function prepare_item_metadata_diff( Entities\Entity $unsaved ) {
@ -576,6 +450,9 @@ class Logs extends Repository {
} }
/**
* Callback to generate log when Tainacan entities are edited
*/
public function insert_entity( Entities\Entity $entity ) { public function insert_entity( Entities\Entity $entity ) {
if ( ! $entity->get_repository()->use_logs ) { if ( ! $entity->get_repository()->use_logs ) {
@ -584,9 +461,7 @@ class Logs extends Repository {
if ( $entity instanceof Entities\Item_Metadata_Entity ) { if ( $entity instanceof Entities\Item_Metadata_Entity ) {
return $this->insert_item_metadata($entity); return $this->insert_item_metadata($entity);
} elseif ( $entity instanceof Entities\Term ) { }
//return $this->insert_term($entity);
}
// do not log a log // do not log a log
if ( ( method_exists( $entity, 'get_post_type' ) && $entity->get_post_type() === 'tainacan-log' ) || $entity->get_status() === 'auto-draft' ) { if ( ( method_exists( $entity, 'get_post_type' ) && $entity->get_post_type() === 'tainacan-log' ) || $entity->get_status() === 'auto-draft' ) {
@ -700,12 +575,6 @@ class Logs extends Repository {
return; return;
} }
if ( $entity instanceof Entities\Item_Metadata_Entity ) {
//return $this->insert_item_metadata($entity);
} elseif ( $entity instanceof Entities\Term ) {
//return $this->insert_term($entity);
}
// do not log a log // do not log a log
if ( ( method_exists( $entity, 'get_post_type' ) && $entity->get_post_type() === 'tainacan-log' ) || $entity->get_status() === 'auto-draft' ) { if ( ( method_exists( $entity, 'get_post_type' ) && $entity->get_post_type() === 'tainacan-log' ) || $entity->get_status() === 'auto-draft' ) {
return false; return false;
@ -722,12 +591,6 @@ class Logs extends Repository {
return; return;
} }
if ( $entity instanceof Entities\Item_Metadata_Entity ) {
//return $this->insert_item_metadata($entity);
} elseif ( $entity instanceof Entities\Term ) {
//return $this->insert_term($entity);
}
// do not log a log // do not log a log
if ( ( method_exists( $entity, 'get_post_type' ) && $entity->get_post_type() === 'tainacan-log' ) || $entity->get_status() === 'auto-draft' ) { if ( ( method_exists( $entity, 'get_post_type' ) && $entity->get_post_type() === 'tainacan-log' ) || $entity->get_status() === 'auto-draft' ) {
return false; return false;
@ -869,47 +732,6 @@ class Logs extends Repository {
} }
/**
* This will prepare the event title for objects
*
* @param $object
* @param $name
* @param $class_name
*
* @param $action_message
*
* @return string
*/
private function prepare_event_title( $object, $name, $class_name, $action_message ) {
// translators: 1=Object name, 2=Object type, 3=Action. e.g. The "Subject" taxonomy has been created
$title_format = __( '"%1$s" %2$s has been %3$s', 'tainacan' );
if ( $object instanceof Entities\Metadatum || $object instanceof Entities\Item || $object instanceof Entities\Filter ) {
$collection = $object->get_collection();
if ( $collection ) {
$parent = sprintf( __('(collection: %s)', 'tainacan'), $collection->get_name() );
} else {
$parent = __('(on repository level)', 'tainacan');
}
$title = sprintf( $title_format, $name, strtolower( $class_name ), $action_message );
$title .= ' ' . $parent . '.';
} elseif($object instanceof Entities\Item_Metadata_Entity) {
$title = sprintf(
$title_format,
$name,
__('item metadatum', 'tainacan'),
$action_message
) . ' ' . sprintf( __('(item: %s)', 'tainacan'), $object->get_item()->get_title() ) . '.';
} else {
$title = sprintf( $title_format, $name, strtolower( $class_name ), $action_message ) . '.';
}
return $title;
}
/** /**
* *
* @param Entities\Log $log * @param Entities\Log $log

10
src/classes/repositories/class-tainacan-taxonomies.php
View File

@ -208,7 +208,7 @@ class Taxonomies extends Repository {
* @param array $args WP_Query args plus disabled_metadata * @param array $args WP_Query args plus disabled_metadata
* @param string $output The desired output format (@see \Tainacan\Repositories\Repository::fetch_output() for possible values) * @param string $output The desired output format (@see \Tainacan\Repositories\Repository::fetch_output() for possible values)
* *
* @return array Entities\Metadatum * @return array Entities\Taxonomy
* @throws \Exception * @throws \Exception
*/ */
public function fetch_by_collection( Entities\Collection $collection, $args = [], $output = null ) { public function fetch_by_collection( Entities\Collection $collection, $args = [], $output = null ) {
@ -241,6 +241,14 @@ class Taxonomies extends Repository {
} }
/**
* fetch taxonomies by DB Identifier
*
* @param string $db_identifier The db Identifier of the taxonomy. This is the internal WordPress taxonomy slug, something like tnc_123_tax
*
* @return Entities\Taxonomy|Array The entity when found. An empty array when nothing was found
* @throws \Exception
*/
public function fetch_by_db_identifier($db_identifier) { public function fetch_by_db_identifier($db_identifier) {
$id = $this->get_id_by_db_identifier($db_identifier); $id = $this->get_id_by_db_identifier($db_identifier);
if ($id) { if ($id) {

15
src/classes/repositories/class-tainacan-terms.php
View File

@ -250,18 +250,23 @@ class Terms extends Repository {
/** /**
* @param Entities\Term $term * @param Entities\Term $term
* @param bool $permanent this parameter is not used by Terms repository * @param bool $permanent this parameter is not used by Terms repository. Delete is always permanent
* *
* @return bool|int|mixed|\WP_Error * @return bool|int|mixed|\WP_Error
*/ */
public function delete( Entities\Entity $term, $permanent = true ) { public function delete( Entities\Entity $term, $permanent = true ) {
$deleted = $term; $deleted = $term;
$permanent = true; // there is no such option for terms
do_action( 'tainacan-pre-delete', $deleted, $permanent );
do_action( 'tainacan-pre-delete-term', $deleted, $permanent );
$return = wp_delete_term( $term->get_id(), $term->get_taxonomy() ); $return = wp_delete_term( $term->get_id(), $term->get_taxonomy() );
if ( $deleted && $this->use_logs ) { if ( $deleted ) {
$this->logs_repository->insert_log( $deleted, [], false, true ); do_action( 'tainacan-deleted', $deleted, $permanent );
do_action( 'tainacan-deleted', $deleted ); do_action( 'tainacan-deleted-term', $deleted, $permanent );
do_action( 'tainacan-deleted-term', $deleted );
} }
return $return; return $return;