Rename group iterator accessors

[chaz/p5-File-KDBX] / lib / File / KDBX / Group.pm

diff --git a/lib/File/KDBX/Group.pm b/lib/File/KDBX/Group.pm
index 0e8f1abe506d4e6b59326e490e1cd442a4165a00..9ef603b891c58bc286c0b7e96126f2ae1b15b22e 100644 (file)
--- a/lib/File/KDBX/Group.pm
+++ b/lib/File/KDBX/Group.pm
@@ -21,10 +21,6 @@ extends 'File::KDBX::Object';
 
 our $VERSION = '999.999'; # VERSION
 
 
 our $VERSION = '999.999'; # VERSION
 

-=attr uuid
-
-128-bit UUID identifying the group within the database.
-

 =attr name
 
 The human-readable name of the group.
 =attr name
 
 The human-readable name of the group.


@@ -33,18 +29,6 @@ The human-readable name of the group.
 
 Free form text string associated with the group.
 
 
 Free form text string associated with the group.
 

-=attr tags
-
-Text string with arbitrary tags which can be used to build a taxonomy.
-
-=attr icon_id
-
-Integer representing a default icon. See L<File::KDBX::Constants/":icon"> for valid values.
-
-=attr custom_icon_uuid
-
-128-bit UUID identifying a custom icon within the database.
-

 =attr is_expanded
 
 Whether or not subgroups are visible when listed for user selection.
 =attr is_expanded
 
 Whether or not subgroups are visible when listed for user selection.


@@ -65,15 +49,6 @@ Whether or not entries within the group can show up in search results, inheritab
 
 The UUID of the entry visible at the top of the list.
 
 
 The UUID of the entry visible at the top of the list.
 

-=attr custom_data
-
-A set of key-value pairs used to store arbitrary data, usually used by software to keep track of state rather
-than by end users (who typically work with the strings and binaries).
-
-=attr previous_parent_group
-
-128-bit UUID identifying a group within the database.
-

 =attr entries
 
 Array of entries contained within the group.
 =attr entries
 
 Array of entries contained within the group.


@@ -82,34 +57,6 @@ Array of entries contained within the group.
 
 Array of subgroups contained within the group.
 
 
 Array of subgroups contained within the group.
 

-=attr last_modification_time
-
-Date and time when the entry was last modified.
-
-=attr creation_time
-
-Date and time when the entry was created.
-
-=attr last_access_time
-
-Date and time when the entry was last accessed.
-
-=attr expiry_time
-
-Date and time when the entry expired or will expire.
-
-=attr expires
-
-Boolean value indicating whether or not an entry is expired.
-
-=attr usage_count
-
-TODO
-
-=attr location_changed
-
-Date and time when the entry was last moved to a different parent group.
-

 =cut
 
 # has uuid                        => sub { generate_uuid(printable => 1) };
 =cut
 
 # has uuid                        => sub { generate_uuid(printable => 1) };


@@ -160,7 +107,7 @@ sub uuid {
 
     \@entries = $group->entries;
 
 
     \@entries = $group->entries;
 

-Get an array of direct entries within a group.
+Get an array of direct child entries within a group.

 
 =cut
 
 
 =cut
 


@@ -174,9 +121,9 @@ sub entries {
     return $entries;
 }
 
     return $entries;
 }
 

-=method entries_deeply
+=method all_entries

 
 

-    \&iterator = $kdbx->entries_deeply(%options);
+    \&iterator = $kdbx->all_entries(%options);

 
 Get an L<File::KDBX::Iterator> over I<entries> within a group. Supports the same options as L</groups>,
 plus some new ones:
 
 Get an L<File::KDBX::Iterator> over I<entries> within a group. Supports the same options as L</groups>,
 plus some new ones:


@@ -188,7 +135,7 @@ plus some new ones:
 
 =cut
 
 
 =cut
 

-sub entries_deeply {
+sub all_entries {

     my $self = shift;
     my %args = @_;
 
     my $self = shift;
     my %args = @_;
 


@@ -196,7 +143,7 @@ sub entries_deeply {
     my $auto_type   = delete $args{auto_type};
     my $history     = delete $args{history};
 
     my $auto_type   = delete $args{auto_type};
     my $history     = delete $args{history};
 

-    my $groups = $self->groups_deeply(%args);
+    my $groups = $self->all_groups(%args);

     my @entries;
 
     return File::KDBX::Iterator->new(sub {
     my @entries;
 
     return File::KDBX::Iterator->new(sub {


@@ -282,9 +229,9 @@ sub groups {
     return $groups;
 }
 
     return $groups;
 }
 

-=method groups_deeply
+=method all_groups

 
 

-    \&iterator = $group->groups_deeply(%options);
+    \&iterator = $group->all_groups(%options);

 
 Get an L<File::KDBX::Iterator> over I<groups> within a groups, deeply. Options:
 
 
 Get an L<File::KDBX::Iterator> over I<groups> within a groups, deeply. Options:
 


@@ -294,7 +241,7 @@ Get an L<File::KDBX::Iterator> over I<groups> within a groups, deeply. Options:
 
 =cut
 
 
 =cut
 

-sub groups_deeply {
+sub all_groups {

     my $self = shift;
     my %args = @_;
 
     my $self = shift;
     my %args = @_;
 


@@ -381,9 +328,9 @@ sub remove_group {
 
 ##############################################################################
 
 
 ##############################################################################
 

-=method objects_deeply
+=method all_objects

 
 

-    \&iterator = $groups->objects_deeply(%options);
+    \&iterator = $groups->all_objects(%options);

 
 Get an L<File::KDBX::Iterator> over I<objects> within a group, deeply. Groups and entries are considered
 objects, so this is essentially a combination of L</groups> and L</entries>. This won't often be useful, but
 
 Get an L<File::KDBX::Iterator> over I<objects> within a group, deeply. Groups and entries are considered
 objects, so this is essentially a combination of L</groups> and L</entries>. This won't often be useful, but


@@ -391,7 +338,7 @@ it can be convenient for maintenance tasks. This method takes the same options a
 
 =cut
 
 
 =cut
 

-sub objects_deeply {
+sub all_objects {

     my $self = shift;
     my %args = @_;
 
     my $self = shift;
     my %args = @_;
 


@@ -399,7 +346,7 @@ sub objects_deeply {
     my $auto_type   = delete $args{auto_type};
     my $history     = delete $args{history};
 
     my $auto_type   = delete $args{auto_type};
     my $history     = delete $args{history};
 

-    my $groups = $self->groups_deeply(%args);
+    my $groups = $self->all_groups(%args);

     my @entries;
 
     return File::KDBX::Iterator->new(sub {
     my @entries;
 
     return File::KDBX::Iterator->new(sub {


@@ -561,7 +508,7 @@ sub is_recycle_bin {
 
     $bool = $group->is_entry_templates;
 
 
     $bool = $group->is_entry_templates;
 

-Get whether or not a group is the group containing entry template of its connected database.
+Get whether or not a group is the group containing entry template in its connected database.

 
 =cut
 
 
 =cut
 


@@ -686,4 +633,7 @@ There is also some metadata associated with a group. Each group in a database is
 a UUID. An entry can also have an icon associated with it, and there are various timestamps. Take a look at
 the attributes to see what's available.
 
 a UUID. An entry can also have an icon associated with it, and there are various timestamps. Take a look at
 the attributes to see what's available.
 

+A B<File::KDBX::Group> is a subclass of L<File::KDBX::Object>. View its documentation to see other attributes
+and methods available on groups.
+

 =cut
 =cut