Core API - Revision history

Jy2e08@ecs.soton.ac.uk at 14:22, 27 March 2017

2017-03-27T14:22:28Z

← Older revision		Revision as of 14:22, 27 March 2017
Line 7:		Line 7:

	=== Overview ===		=== Overview ===
			<source lang="perl">
	use EPrints;		use EPrints;
	my $ep = EPrints->new();		my $ep = EPrints->new();
	my $repo = $ep->repository( "myrepo" );		my $repo = $ep->repository( "myrepo" );
	my $an_eprint = $repo->eprint( 23 );		my $an_eprint = $repo->eprint( 23 );
			</source>

	=== EPrints ===		=== EPrints ===
			<source lang="perl">
	$ep = EPrints->new();		$ep = EPrints->new();
	@ids = $ep->repository_ids; # list active repository ids		@ids = $ep->repository_ids; # list active repository ids
Line 18:		Line 21:
	$repo = $ep->current_repository(); # from Apache::Request URI		$repo = $ep->current_repository(); # from Apache::Request URI
	EPrints->abort( $message );		EPrints->abort( $message );
			</source>
	=== Repository ===		=== Repository ===
	<source lang="perl">		<source lang="perl">
Line 37:		Line 40:

	=== Dataset ===		=== Dataset ===
			<source lang="perl">
	$dataset = $repo->dataset( "eprint" )		$dataset = $repo->dataset( "eprint" )
	$string = $dataset->base_id; # eprint		$string = $dataset->base_id; # eprint
Line 59:		Line 63:
	$ids = $dataset->search->ids;		$ids = $dataset->search->ids;
	$list = $dataset->list( \@ids );		$list = $dataset->list( \@ids );
			</source>
	=== list ===		=== list ===
			<source lang="perl">
	$n = $list->count;		$n = $list->count;
	$list->map( sub {		$list->map( sub {
Line 70:		Line 75:
	@dataobjs = $list->slice( $offset, $length );		@dataobjs = $list->slice( $offset, $length );
	\@ids = $list->ids;		\@ids = $list->ids;
			</source>
	=== XML ===		=== XML ===
			<source lang="perl">
	$doc = $xml->parse_string( $string );		$doc = $xml->parse_string( $string );
	$doc = $xml->parse_file( $filename );		$doc = $xml->parse_file( $filename );
Line 92:		Line 98:

	$xml->dispose( $dom_node );		$xml->dispose( $dom_node );
			</source>
	=== XHTML ===		=== XHTML ===
			<source lang="perl">
	$xhtml = $repo->xhtml;		$xhtml = $repo->xhtml;

Line 106:		Line 113:

	$page = $xhtml->page( $map, %opts );		$page = $xhtml->page( $map, %opts );
			</source>
	=== Page ===		=== Page ===
			<source lang="perl">
	$page->send( %options );		$page->send( %options );
	$page->write_to_file( $filename );		$page->write_to_file( $filename );
			</source>
	=== DataObj ===		=== DataObj ===
			<source lang="perl">
	$dataobj = $dataset->dataobj( $id );		$dataobj = $dataset->dataobj( $id );
	$dataobj->delete;		$dataobj->delete;
Line 134:		Line 142:
	$string = $dataobj->export( $plugin_id, %opts );		$string = $dataobj->export( $plugin_id, %opts );
	$dataobj = $dataobj->create_subobject( $fieldname, $epdata );		$dataobj = $dataobj->create_subobject( $fieldname, $epdata );
			</source>
	=== MetaField ===		=== MetaField ===
	Now has a handle on both it's repository/session AND dataset.		Now has a handle on both it's repository/session AND dataset.
			<source lang="perl">
	my $field = $dataset->field( $fieldname );		my $field = $dataset->field( $fieldname );

Line 155:		Line 163:
	$values = $field->all_values( %opts );		$values = $field->all_values( %opts );
	$sorted_list = $field->sort_values( $unsorted_list );		$sorted_list = $field->sort_values( $unsorted_list );
			</source>

Pm705: /* Repository */

2016-04-18T13:29:17Z

Repository

← Older revision		Revision as of 13:29, 18 April 2016
Line 21:		Line 21:
	=== Repository ===		=== Repository ===
	<source lang="perl">		<source lang="perl">
	$xml = $repo->xml;		$xml = $repo->xml;
	$dataset = $repo->dataset( "user" );		$dataset = $repo->dataset( "user" );
	$user = $repo->current_user;		$user = $repo->current_user;
	$query = $repo->query;		$query = $repo->query;
	$current_page_url = $repo->current_url( host => 1, path => 1, query => 1, etc. );		$current_page_url = $repo->current_url( host => 1, path => 1, query => 1, etc. );
	$config_element = $repo->config( $key, [@subkeys] );		$config_element = $repo->config( $key, [@subkeys] );
	$repository->log( $message );		$repository->log( $message );
	$string = $repo->query->param( "X" );		$string = $repo->query->param( "X" );
	$repo->redirect( $url );		$repo->redirect( $url );
	$eprint = $repo->eprint( 23 );		$eprint = $repo->eprint( 23 );
	$user = $repo->user( 23 );		$user = $repo->user( 23 );
	$user = $repo->user_by_username( "cjg" );		$user = $repo->user_by_username( "cjg" );
	$user = $repo->user_by_email( 'cjg@ecs.soton.ac.uk' );		$user = $repo->user_by_email( 'cjg@ecs.soton.ac.uk' );
	</source>		</source>

Pm705: /* Repository */

2016-04-18T13:28:54Z

Repository

← Older revision		Revision as of 13:28, 18 April 2016
Line 20:		Line 20:

	=== Repository ===		=== Repository ===
	<source lang="eg">		<source lang="perl">
	$xml = $repo->xml;		$xml = $repo->xml;
	$dataset = $repo->dataset( "user" );		$dataset = $repo->dataset( "user" );

Pm705: /* Repository */

2016-04-18T13:27:47Z

Repository

← Older revision		Revision as of 13:27, 18 April 2016
Line 20:		Line 20:

	=== Repository ===		=== Repository ===
			<source lang="eg">
	$xml = $repo->xml;		$xml = $repo->xml;
	$dataset = $repo->dataset( "user" );		$dataset = $repo->dataset( "user" );
Line 33:		Line 34:
	$user = $repo->user_by_username( "cjg" );		$user = $repo->user_by_username( "cjg" );
	$user = $repo->user_by_email( 'cjg@ecs.soton.ac.uk' );		$user = $repo->user_by_email( 'cjg@ecs.soton.ac.uk' );
			</source>

	=== Dataset ===		=== Dataset ===

Pm705: /* Dataset */

2016-04-13T14:11:04Z

Dataset

← Older revision		Revision as of 14:11, 13 April 2016
Line 44:		Line 44:
	$eprint = $dataset->dataobj( 23 );		$eprint = $dataset->dataobj( 23 );

			%options = (filters => [ { meta_fields => [ 'contributors_id' ], value => "13249", match=>"EX" } ]);
	$search = $dataset->prepare_search( %options );		$search = $dataset->prepare_search( %options );
	$list = $dataset->search( %options ); # prepare_search( %options )->execute		$list = $dataset->search( %options ); # prepare_search( %options )->execute

Pm705: /* Dataset */

2016-01-05T12:56:17Z

Dataset

← Older revision		Revision as of 12:56, 5 January 2016
Line 42:		Line 42:

	$dataobj = $dataset->create_dataobj( $data );		$dataobj = $dataset->create_dataobj( $data );
	$~~user~~ = $dataset->dataobj( 23 );		$eprint = $dataset->dataobj( 23 );

	$search = $dataset->prepare_search( %options );		$search = $dataset->prepare_search( %options );

Pm705: /* list */

2016-01-03T22:37:37Z

list

← Older revision		Revision as of 22:37, 3 January 2016
Line 61:		Line 61:
	$list->map( sub {		$list->map( sub {
	my ( $repository, $dataset, $dataobj, $ctx ) = @_;		my ( $repository, $dataset, $dataobj, $ctx ) = @_;
			# do something to the dataobj here
	}, $ctx );		}, $ctx );
	$dataobj = $list->item( $offset );		$dataobj = $list->item( $offset );

Pm705: /* list */

2016-01-03T22:36:44Z

list

← Older revision		Revision as of 22:36, 3 January 2016
Line 59:		Line 59:
	=== list ===		=== list ===
	$n = $list->count;		$n = $list->count;
	$list->map( sub {}, $ctx );		$list->map( sub {
			my ( $repository, $dataset, $dataobj, $ctx ) = @_;
			}, $ctx );
	$dataobj = $list->item( $offset );		$dataobj = $list->item( $offset );
	\@all_dataobjs = $list->slice		@all_dataobjs = $list->slice
	\@dataobjs = $list->slice( $offset, $length );		@dataobjs = $list->slice( $offset, $length );
	\@ids = $list->ids;		\@ids = $list->ids;

Pm705: /* list */

2016-01-03T17:38:18Z

list

← Older revision		Revision as of 17:38, 3 January 2016
Line 61:		Line 61:
	$list->map( sub {}, $ctx );		$list->map( sub {}, $ctx );
	$dataobj = $list->item( $offset );		$dataobj = $list->item( $offset );
	@dataobjs = $list->slice( $offset, $length );		\@all_dataobjs = $list->slice
			\@dataobjs = $list->slice( $offset, $length );
	\@ids = $list->ids;		\@ids = $list->ids;

Pm705: /* list */

2016-01-03T13:03:21Z

list

← Older revision		Revision as of 13:03, 3 January 2016
Line 60:		Line 60:
	$n = $list->count;		$n = $list->count;
	$list->map( sub {}, $ctx );		$list->map( sub {}, $ctx );
	$dataobj = $list->item( offset );		$dataobj = $list->item( $offset );
	@dataobjs = $list->slice( offset, length );		@dataobjs = $list->slice( $offset, $length );
	\@ids = $list->ids;		\@ids = $list->ids;