From ad8d8568b683e6935bec64abe88f79bf31706dd7 Mon Sep 17 00:00:00 2001 From: Silvio Date: Wed, 18 Aug 2010 15:22:43 -0300 Subject: Adding audit and finder classes, cleanup and organization --- classes/BiblioIsisDb.php | 418 ----------------------------------------------- 1 file changed, 418 deletions(-) delete mode 100644 classes/BiblioIsisDb.php (limited to 'classes/BiblioIsisDb.php') diff --git a/classes/BiblioIsisDb.php b/classes/BiblioIsisDb.php deleted file mode 100644 index 9db0145..0000000 --- a/classes/BiblioIsisDb.php +++ /dev/null @@ -1,418 +0,0 @@ -format = $schema; - - // Setup $fdt. - foreach ($schema['fields'] as $field => $info) { - $this->fdt[$field] = $info['name']; - } - - // Create a perl instance. - $this->perl = new Perl(); - } - - /** - * Class logger. - * - * @param $message - * Log message. - */ - function logger($message) { - $this->log[] = $message; - } - - /** - * Send requests to the perl backend. - * - * @param $method - * Backend method name to invoke. - * - * @param $args - * Backend method arguments. - * - * @return - * Backend return value. - */ - function backend($method = 'count', $args = NULL) { - // Setup the database. - $name = $this->format['db']['name']; - $db = CinisisDb::file("$name/$name", 'db'); - - // Setup arguments. - if ($args != NULL) { - $args = '('. $args .')'; - } - - try { - // Call backend. - return $this->perl->eval(' - use Biblio::Isis; - - my $isis = new Biblio::Isis( - isisdb => "'. $db .'", - ); - - return $isis->'. $method . $args .';'); - } - catch (PerlException $exception) { - echo __CLASS__ .': Perl error: ' . $exception->getMessage(); - return FALSE; - } - } - - /** - * Read an entry. - * - * @param $id - * Record Id. - * - * @param $method - * Database read method. - * - * @see IsisDb::read() - */ - public function read($id, $method = 'fetch') { - // Database query. - $results = $this->backend($method, $id); - - if ($results) { - // Tag results. - $data = $this->tag($results, $method); - - // Charset conversion. - if (is_array($data)) { - array_walk_recursive($data, array(__CLASS__, 'charset')); - } - - // Return the result. - return $data; - } - } - - /** - * Return number of entries in the database. - * - * @see IsisDb::entries() - */ - public function entries() { - return $this->backend('count'); - } - - /** - * Return an example schema. - * - * @see IsisDb::example() - */ - public function example() { - return SchemaDb::example(); - } - - /** - * Check configuration. - * - * @see IsisDb::check() - */ - static function check($schema, $section = NULL) { - // Check API availability. - if (!class_exists('Perl')) { - throw new Exception('Could not find Perl class. Please check your php-perl installation.'); - return FALSE; - } - - // Check schema configuration. - return SchemaDb::check($schema, $section); - } - - /** - * Tag results of a db query. - * - * This function converts the keys of query result from field numbers - * to names. - * - * @param $results - * Database query results. - * - * @param $method - * Database read method. - * - * @return - * Tagged database result. - */ - function tag($results, $method = 'fetch') { - foreach ($results as $key => $value) { - // Key '000' used to hold MFN. - if ($key != '000') { - if (!isset($this->format['fields'][$key])) { - continue; - } - - // Format, repetition and subfield handling. - $name = $this->format['fields'][$key]['name']; - $data[$name] = $this->repetition($key, $value); - $data[$name] = $this->subfields($data[$name], $key, $method); - } - } - - return $data; - } - - /** - * Checks whether a field has subfields. - * - * @param $key - * Field key. - * - * @return - * True if has subfields, false otherwise. - */ - function has_subfields($key) { - if (isset($this->format['fields'][$key]['subfields'])) { - return TRUE; - } - - return FALSE; - } - - /** - * Switch keys on subfields. - * - * @param $key - * Field key. - * - * @param $value - * Dataset. - */ - function subfields_switch($key, &$value) { - if (!is_array($value)) { - return; - } - - foreach ($value as $subkey => $subvalue) { - if (isset($this->format['fields'][$key]['subfields'][$subkey])) { - $subname = $this->format['fields'][$key]['subfields'][$subkey]; - } else { - $subname = $subkey; - } - - $value[$subname] = $subvalue; - - if ($subkey != $subname) { - unset($value[$subkey]); - } - } - } - - /** - * Makes subfield substitution in a dataset. - * - * @param $name - * Dataset. - * - * @param $key - * Field key. - * - * @param $method - * Database read method. - * - * @return - * Data with processed subfields. - */ - function subfields($name, $key, $method) { - if ($this->has_subfields($key) && is_array($name)) { - $method = 'subfields_from_'. $method; - return $this->{$method}($name, $key); - } - else { - foreach ($name as $value) { - $data[] = array(CinisisDb::main_field_name($this->format, $key) => $value); - } - } - - return $data; - } - - /** - * Subfield handling for data read by 'to_hash' method. This method - * is not fully supported and therefore not recommended. - * - * It does not deal very well when data has "main" fields and - * subfields (like "data1^adata2^bdata3") and doesn't deal with - * advanced configuration such as 'join_subfields'. - * - * @param $name - * Dataset. - * - * @param $key - * Field key. - * - * @return - * Data with processed subfields. - */ - function subfields_from_to_hash($name, $key) { - if ($this->is_repetitive($key, $name)) { - foreach ($name as $entry => $value) { - $this->subfields_switch($key, $value); - $name[$entry] = $value; - } - } - else { - $this->subfields_switch($key, $name); - } - - return $name; - } - - /** - * Subfield handling for data read by 'from_fetch' method. - * - * @param $name - * Dataset. - * - * @param $key - * Field key. - * - * @return - * Data with processed subfields. - */ - function subfields_from_fetch($name, $key) { - // Check if entry has repetitions. - $this->is_repetitive($key, $name); - - // Iterate over all values. - foreach ($name as $entry => $value) { - if (substr($value, 0, 1) != '^') { - $field = preg_replace('/\^.*/', '', $value); - $subfields = substr($value, strlen($field) + 1); - $subfields = (!empty($subfields)) ? $subfields = explode('^', $subfields) : array(); - - if (isset($field)) { - $data[$entry]['field'] = $field; - } - } - else { - $subfields = explode('^', substr($value, 1)); - } - - // Subfield tagging. - foreach ($subfields as $subfield => $subvalue) { - $subkey = substr($subvalue, 0, 1); - if (isset($this->format['fields'][$key]['subfields'][$subkey])) { - $subkey = $this->format['fields'][$key]['subfields'][$subkey]; - } - $data[$entry]['subfields'][$subkey] = substr($subvalue, 1); - } - - // Join subfields and main field if needed. - if (CinisisDb::join_subfields($this->format)) { - if (isset($data[$entry]['subfields'])) { - $data[$entry] = $data[$entry]['subfields']; - } - - if (isset($field)) { - unset($data[$entry]['field']); - $data[$entry][CinisisDb::main_field_name($this->format, $key)] = $field; - } - } - } - - return $data; - } - - /** - * Deals with repetition. - * - * As Biblio::Isis always return field values as arrays, we - * have to check the database schema to see if we want to - * convert then to a single value. - * - * @param $field - * Database field. - * - * @param $value - * Data (with or without repetition). - * - * @return - * True if repetitive, false otherwise. - */ - function is_repetitive($field, $value) { - if (isset($this->format['fields'][$field]['repeat']) && - $this->format['fields'][$field]['repeat'] == FALSE) { - if (is_array($value) && count($value) > 1) { - $this->logger("Field $field is configured as non repetitive but data shows a repetition for value."); - } - return FALSE; - } - - return TRUE; - } - - /** - * Deals with repetition. - * - * As Biblio::Isis always return field values as arrays, we - * have to check the database schema to see if we want to - * convert then to a single value. The current implementation - * is just a placeholder as no conversion is done. - * - * @param $key - * Database key. - * - * @param $value - * Query field result. - * - * @return - * The value according to the repetition config. - */ - function repetition($key, $value) { - return $value; - } - - /** - * Charset conversion. - * - * Converts a string from the database charset to UTF-8. - * - * @param $data - * String to be converted. - * - * @return - * String converted to UTF-8. - */ - function charset(&$data) { - $data = iconv($this->format['db']['charset'], 'UTF-8', $data); - } -} -- cgit v1.2.3