From: Jess Robinson Date: Wed, 7 Mar 2012 17:10:18 +0000 (+0000) Subject: Minor messing with syntactically incorrect POD (no =headX blocks inside =begin, and... X-Git-Tag: v0.08197~100 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=a807d012;p=dbsrgits%2FDBIx-Class.git Minor messing with syntactically incorrect POD (no =headX blocks inside =begin, and =for is a one-paragraph block) --- diff --git a/lib/DBIx/Class/DB.pm b/lib/DBIx/Class/DB.pm index 804ff67..acdb5e6 100644 --- a/lib/DBIx/Class/DB.pm +++ b/lib/DBIx/Class/DB.pm @@ -33,15 +33,19 @@ instead; DBIx::Class::DB will not undergo new development and will be moved to being a CDBICompat-only component before 1.0. In order to discourage further use, documentation has been removed as of 0.08000 -=begin HIDE_BECAUSE_THIS_CLASS_IS_DEPRECATED - =head1 METHODS -=head2 storage +Hidden. + +=begin hidden head2 storage Sets or gets the storage backend. Defaults to L. -=head2 class_resolver +=end hidden + +=cut + +=begin hidden head2 class_resolver ****DEPRECATED**** @@ -49,18 +53,22 @@ Sets or gets the class to use for resolving a class. Defaults to L, which returns whatever you give it. See resolve_class below. +=end hidden + =cut __PACKAGE__->mk_classdata('class_resolver' => 'DBIx::Class::ClassResolver::PassThrough'); -=head2 connection +=begin hidden head2 connection __PACKAGE__->connection($dsn, $user, $pass, $attrs); Specifies the arguments that will be passed to DBI->connect(...) to instantiate the class dbh when required. +=end hidden + =cut sub connection { @@ -69,7 +77,7 @@ sub connection { $class->schema_instance->connection(@info); } -=head2 setup_schema_instance +=begin hidden head2 setup_schema_instance Creates a class method ->schema_instance which contains a DBIx::Class::Schema; all class-method operations are proxies through to this object. If you don't @@ -77,6 +85,8 @@ call ->connection in your DBIx::Class::DB subclass at load time you *must* call ->setup_schema_instance in order for subclasses to find the schema and register themselves with it. +=end hidden + =cut sub setup_schema_instance { @@ -86,36 +96,44 @@ sub setup_schema_instance { $class->mk_classdata('schema_instance' => $schema); } -=head2 txn_begin +=begin hidden head2 txn_begin Begins a transaction (does nothing if AutoCommit is off). +=end hidden + =cut sub txn_begin { shift->schema_instance->txn_begin(@_); } -=head2 txn_commit +=begin hidden head2 txn_commit Commits the current transaction. +=end hidden + =cut sub txn_commit { shift->schema_instance->txn_commit(@_); } -=head2 txn_rollback +=begin hidden head2 txn_rollback Rolls back the current transaction. +=end hidden + =cut sub txn_rollback { shift->schema_instance->txn_rollback(@_); } -=head2 txn_do +=begin hidden head2 txn_do Executes a block of code transactionally. If this code reference throws an exception, the transaction is rolled back and the exception is rethrown. See L for more details. +=end hidden + =cut sub txn_do { shift->schema_instance->txn_do(@_); } @@ -129,22 +147,26 @@ sub txn_do { shift->schema_instance->txn_do(@_); } } } -=head2 resultset_instance +=begin hidden head2 resultset_instance Returns an instance of a resultset for this class - effectively mapping the L connection-as-classdata paradigm into the native L system. +=end hidden + =cut sub resultset_instance { $_[0]->result_source_instance->resultset } -=head2 result_source_instance +=begin hidden head2 result_source_instance Returns an instance of the result source for this class +=end hidden + =cut __PACKAGE__->mk_classdata('_result_source_instance' => []); @@ -195,24 +217,30 @@ sub result_source_instance { return $source; } -=head2 resolve_class +=begin hidden head2 resolve_class ****DEPRECATED**** See L -=head2 dbi_commit +=end hidden + +=begin hidden head2 dbi_commit ****DEPRECATED**** Alias for L -=head2 dbi_rollback +=end hidden + +=begin hidden head2 dbi_rollback ****DEPRECATED**** Alias for L +=end hidden + =end HIDE_BECAUSE_THIS_CLASS_IS_DEPRECATED =head1 AUTHORS diff --git a/lib/DBIx/Class/Storage.pm b/lib/DBIx/Class/Storage.pm index e317d1f..d72840f 100644 --- a/lib/DBIx/Class/Storage.pm +++ b/lib/DBIx/Class/Storage.pm @@ -460,27 +460,29 @@ sub svp_rollback { $exec->($self, $name); } -=for comment +=begin comment -=head2 txn_scope_guard + =head2 txn_scope_guard -An alternative way of transaction handling based on -L: + An alternative way of transaction handling based on + L: - my $txn_guard = $storage->txn_scope_guard; + my $txn_guard = $storage->txn_scope_guard; - $row->col1("val1"); - $row->update; + $row->col1("val1"); + $row->update; - $txn_guard->commit; + $txn_guard->commit; -If an exception occurs, or the guard object otherwise leaves the scope -before C<< $txn_guard->commit >> is called, the transaction will be rolled -back by an explicit L call. In essence this is akin to -using a L/L pair, without having to worry -about calling L at the right places. Note that since there -is no defined code closure, there will be no retries and other magic upon -database disconnection. If you need such functionality see L. + If an exception occurs, or the guard object otherwise leaves the scope + before C<< $txn_guard->commit >> is called, the transaction will be rolled + back by an explicit L call. In essence this is akin to + using a L/L pair, without having to worry + about calling L at the right places. Note that since there + is no defined code closure, there will be no retries and other magic upon + database disconnection. If you need such functionality see L. + +=end comment =cut