dbix::class::helper::row::subclass(3pm) [debian man page]

DBIx::Class::Helper::Row::SubClass(3pm) 		User Contributed Perl Documentation		   DBIx::Class::Helper::Row::SubClass(3pm)

NAME

       DBIx::Class::Helper::Row::SubClass - Convenient subclassing with DBIx::Class

VERSION

       version 2.013002

SYNOPSIS

	# define parent class
	package ParentSchema::Result::Bar;

	use strict;
	use warnings;

	use parent 'DBIx::Class';

	__PACKAGE__->load_components('Core');

	__PACKAGE__->table('Bar');

	__PACKAGE__->add_columns(qw/ id foo_id /);

	__PACKAGE__->set_primary_key('id');

	__PACKAGE__->belongs_to( foo => 'ParentSchema::Result::Foo', 'foo_id' );

	# define subclass
	package MySchema::Result::Bar;

	use strict;
	use warnings;

	use parent 'ParentSchema::Result::Bar';

	__PACKAGE__->load_components(qw{Helper::Row::SubClass Core});

	__PACKAGE__->subclass;

       or with DBIx::Class::Candy:

	# define subclass
	package MySchema::Result::Bar;

	use DBIx::Class::Candy
	   -base => 'ParentSchema::Result::Bar',
	   -components => ['Helper::Row::SubClass'];

	subclass;

DESCRIPTION

       This component is to allow simple subclassing of DBIx::Class Result classes.

METHODS

   subclass
       This is probably the method you want.  You call this in your child class and it imports the definitions from the parent into itself.

   generate_relationships
       This is where the cool stuff happens.  This assumes that the namespace is laid out in the recommended "MyApp::Schema::Result::Foo" format.
       If the parent has "Parent::Schema::Result::Foo" related to "Parent::Schema::Result::Bar", and you inherit from
       "Parent::Schema::Result::Foo" in "MyApp::Schema::Result::Foo", you will automatically get the relationship to "MyApp::Schema::Result::Bar".

   set_table
       This is a super basic method that just sets the current classes' table to the parent classes' table.

CANDY EXPORTS

       If used in conjunction with DBIx::Class::Candy this component will export:

       join_table
       subclass
       generate_relationships
       set_table

NOTE

       This Component is mostly aimed at those who want to subclass parts of a schema, maybe for sharing a login system in a few different
       projects.  Do not confuse it with DBIx::Class::DynamicSubclass, which solves an entirely different problem.  DBIx::Class::DynamicSubclass
       is for when you want to store a few very similar classes in the same table (Employee, Person, Boss, etc) whereas this component is merely
       for reusing an existing schema.

AUTHOR

       Arthur Axel "fREW" Schmidt <frioux+cpan@gmail.com>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 by Arthur Axel "fREW" Schmidt.

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

perl v5.14.2							    2012-06-18				   DBIx::Class::Helper::Row::SubClass(3pm)

Check Out this Related Man Page

DBIx::Class::Helper::Row::ProxyResultSetMethod(3pm)	User Contributed Perl Documentation    DBIx::Class::Helper::Row::ProxyResultSetMethod(3pm)

NAME

       DBIx::Class::Helper::Row::ProxyResultSetMethod - Efficiently reuse ResultSet methods from results

VERSION

       version 2.013002

SYNOPSIS

       ResultSet:

	package MyApp::Schema::ResultSet::Foo;

	use base 'DBIx::Class::ResultSet';

	__PACKAGE__->load_components(qw(
	   Helper::ResultSet::CorrelateRelationship
	));

	...;

	sub with_friend_count {
	   shift->search(undef, {
	      '+columns' => {
		 'friend_count' => $self->correlate('friends')->count_rs->as_query,
	      },
	   })
	}

       Result:

	package MyApp::Schema::Result::Foo;

	use base 'DBIx::Class::Core';

	__PACKAGE__->load_components(qw( Helper::Row::ProxyResultSetMethod ));

	__PACKAGE__->proxy_resultset_method('friend_count');

       or with DBIx::Class::Candy:

	package MyApp::Schema::Result::Foo;

	use DBIx::Class::Candy -components => ['Helper::Row::ProxyResultSetMethod'];

	proxy_resultset_method 'friend_count';

       Elsewhere:

	my $row = $foo_rs->first;
	say $row->friend_count . ' friends';

DESCRIPTION

       This module makes reusing resultset methods from a result trivially easy.  You should be using it.

METHODS

   proxy_resultset_method
	__PACKAGE__->proxy_resultset_method( $name => {
	   slot 	    => $slot,
	   resultset_method => $rs_method
	});

       "proxy_resultset_method"'s first argument is the name of the method to generate and is required.  The other two arguments, $slot, and
       $resultset_method are optional.	If unspecified $slot will default to $name and $resultset_method will default to "with_$name".	$slot is
       the column that the data being retrieved is stored as in the ResultSet method being proxied to.	$resultset_method is (duh) the ResultSet
       method being proxied to.

CANDY EXPORTS

       If used in conjunction with DBIx::Class::Candy this component will export:

       proxy_resultset_method

DEDICATION

       This module is dedicated to Ray Bradbury, who wrote Something Wicked This Way Comes, Dandelion Wine, and numerous short stories, plays, etc
       etc.  Read this author's books.

AUTHOR

       Arthur Axel "fREW" Schmidt <frioux+cpan@gmail.com>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 by Arthur Axel "fREW" Schmidt.

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

perl v5.14.2							    2012-06-18		       DBIx::Class::Helper::Row::ProxyResultSetMethod(3pm)

Linux and UNIX Man Pages

dbix::class::helper::row::subclass(3pm) [debian man page]

Check Out this Related Man Page