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::ResultSet::AutoRemoveColumns(3pm)	User Contributed Perl Documentation DBIx::Class::Helper::ResultSet::AutoRemoveColumns(3pm)

NAME

       DBIx::Class::Helper::ResultSet::AutoRemoveColumns - Automatically remove columns from a ResultSet

VERSION

       version 2.013002

SYNOPSIS

	package MySchema::Result::Bar;

	use strict;
	use warnings;

	use parent 'DBIx::Class::Core';

	__PACKAGE__->table('KittenRobot');
	__PACKAGE__->add_columns(
	   id => {
	      data_type 	=> 'integer',
	      is_auto_increment => 1,
	   },
	   kitten => {
	      data_type 	=> 'integer',
	   },
	   robot => {
	      data_type 	=> 'text',
	      is_nullable	=> 1,
	   },
	   your_mom => {
	      data_type 	=> 'blob',
	      is_nullable	=> 1,
	      remove_column	=> 0,
	   },
	);

	1;

	package MySchema::ResultSet::Bar;

	use strict;
	use warnings;

	use parent 'DBIx::Class::ResultSet';

	__PACKAGE__->load_components('Helper::ResultSet::AutoRemoveColumns');

DESCRIPTION

       This component automatically removes "heavy-weight" columns.  To be specific, columns of type "text", "ntext", "blob", "clob", or "bytea".
       You may use the "remove_column" key in the column info to specify directly whether or not to remove the column automatically. See "NOTE" in
       DBIx::Class::Helper::ResultSet for a nice way to apply it to your entire schema.

METHODS

   _should_column_fetch
	$self->_should_column_fetch('kitten')

       returns true if a column should be fetched or not.  This fetches a column if it is not of type "text", "ntext", "blob", "clob", or "bytea"
       or the "remove_column" is set to true.  If you only wanted to explicitly state which columns to remove you might override this method like
       this:

	sub _should_column_fetch {
	   my ( $self, $column ) = @_;

	   my $info = $self->column_info($column);

	   return !defined $info->{remove_column} || $info->{remove_column};
	}

   fetchable_columns
       simply returns a list of columns that are fetchable.

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::ResultSet::AutoRemoveColumns(3pm)

Linux and UNIX Man Pages

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

Check Out this Related Man Page