changed POD formatting
This commit is contained in:
JT Smith
parent
bf5a0145ae
commit
2b6eb201a9
55 changed files with 1188 additions and 3220 deletions
|
|
@ -81,14 +81,10 @@ sub _create {
|
|||
|
||||
Adds groups to this group.
|
||||
|
||||
=over
|
||||
|
||||
=item groups
|
||||
=head3 groups
|
||||
|
||||
An array reference containing the list of group ids to add to this group.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub addGroups {
|
||||
|
|
@ -101,14 +97,10 @@ sub addGroups {
|
|||
|
||||
Returns an boolean stating whether users can add themselves to this group.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, the autoAdd is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub autoAdd {
|
||||
|
|
@ -130,14 +122,10 @@ sub autoAdd {
|
|||
|
||||
Returns an boolean stating whether users can delete themselves from this group.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, the autoDelete is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub autoDelete {
|
||||
|
|
@ -186,14 +174,10 @@ sub delete {
|
|||
|
||||
Deletes groups from this group.
|
||||
|
||||
=over
|
||||
|
||||
=item groups
|
||||
=head3 groups
|
||||
|
||||
An array reference containing the list of group ids to delete from this group.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub deleteGroups {
|
||||
|
|
@ -207,14 +191,10 @@ sub deleteGroups {
|
|||
|
||||
Returns the number of days after the expiration to delete the grouping.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, deleteOffset is set to this value. Defaults to "-14".
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub deleteOffset {
|
||||
|
|
@ -236,14 +216,10 @@ sub deleteOffset {
|
|||
|
||||
Returns the description of this group.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, the description is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub description {
|
||||
|
|
@ -265,14 +241,10 @@ sub description {
|
|||
|
||||
Returns a boolean value whether or not to notify the user of the group expiry.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, expireNotify is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub expireNotify {
|
||||
|
|
@ -294,14 +266,10 @@ sub expireNotify {
|
|||
|
||||
Returns the message to send to the user about expiration.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, expireNotifyMessage is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub expireNotifyMessage {
|
||||
|
|
@ -324,14 +292,10 @@ sub expireNotifyMessage {
|
|||
|
||||
Returns the number of days after the expiration to notify the user.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, expireNotifyOffset is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub expireNotifyOffset {
|
||||
|
|
@ -353,14 +317,10 @@ sub expireNotifyOffset {
|
|||
|
||||
Returns the number of seconds any grouping with this group should expire after.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, expireOffset is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub expireOffset {
|
||||
|
|
@ -382,14 +342,10 @@ sub expireOffset {
|
|||
|
||||
An alternative to the constructor "new", use find as a constructor by name rather than id.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the group you wish to instanciate.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub find {
|
||||
|
|
@ -417,14 +373,10 @@ sub groupId {
|
|||
|
||||
Returns the amount of karma required to be in this group.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, the karma threshold is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub karmaThreshold {
|
||||
|
|
@ -446,14 +398,10 @@ sub karmaThreshold {
|
|||
|
||||
Returns the ip address range(s) the user must be a part of to belong to this group.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, the ipFilter is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub ipFilter {
|
||||
|
|
@ -475,14 +423,10 @@ sub ipFilter {
|
|||
|
||||
Returns a boolean value indicating whether the group should be managable from the group manager. System level groups and groups autocreated by wobjects would use this parameter.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, isEditable is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub isEditable {
|
||||
|
|
@ -517,14 +461,10 @@ sub lastUpdated {
|
|||
|
||||
Returns the name of this group.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, the name is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub name {
|
||||
|
|
@ -546,14 +486,10 @@ sub name {
|
|||
|
||||
Constructor.
|
||||
|
||||
=over
|
||||
|
||||
=item groupId
|
||||
=head3 groupId
|
||||
|
||||
The groupId of the group you're creating an object reference for. If specified as "new" then a new group will be created and assigned the next available groupId. If left blank then the object methods will just return default values for everything.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
|
|
@ -583,14 +519,10 @@ sub new {
|
|||
|
||||
Returns the name of this group.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, the name is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub scratchFilter {
|
||||
|
|
@ -611,14 +543,10 @@ sub scratchFilter {
|
|||
|
||||
Returns a boolean value indicating whether the group should show in forms that display a list of groups. System level groups and groups autocreated by wobjects would use this parameter.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, showInForms is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub showInForms {
|
||||
|
|
@ -642,14 +570,10 @@ sub showInForms {
|
|||
|
||||
Returns the dbQuery for this group.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, the dbQuery is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub dbQuery {
|
||||
|
|
@ -670,14 +594,10 @@ sub dbQuery {
|
|||
|
||||
Returns the databaseLinkId for this group.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, the databaseLinkId is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub databaseLinkId {
|
||||
|
|
@ -698,14 +618,10 @@ sub databaseLinkId {
|
|||
|
||||
Returns the dbCacheTimeout for this group.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
If specified, the dbCacheTimeout is set to this value.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub dbCacheTimeout {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue