[LON-CAPA-cvs] cvs: loncom /interface lonnavmaps.pm

[bowersj2]

This is a MIME encoded message

--bowersj21034106647
Content-Type: text/plain

bowersj2		Tue Oct  8 15:50:47 2002 EDT

  Modified files:              
    /loncom/interface	lonnavmaps.pm 
  Log:
  * Dropped ill-conceived "skipMap" solution to suppressing maps chosen
    to be hidden in a randomout situation.
  * Updated the documentation and changed the ordering of some of the methods
    to match the documentation.
  
  
--bowersj21034106647
Content-Type: text/plain
Content-Disposition: attachment; filename="bowersj2-20021008155047.txt"

Index: loncom/interface/lonnavmaps.pm
diff -u loncom/interface/lonnavmaps.pm:1.69 loncom/interface/lonnavmaps.pm:1.70
--- loncom/interface/lonnavmaps.pm:1.69	Tue Oct  8 14:54:39 2002
+++ loncom/interface/lonnavmaps.pm	Tue Oct  8 15:50:47 2002
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Navigate Maps Handler
 #
-# $Id: lonnavmaps.pm,v 1.69 2002/10/08 18:54:39 bowersj2 Exp $
+# $Id: lonnavmaps.pm,v 1.70 2002/10/08 19:50:47 bowersj2 Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -1316,10 +1316,6 @@
 
 package Apache::lonnavmaps::navmap;
 
-# LEFT:
-# * Actual handler code (multi-part)
-# * Branches (aieee!) (and conditionals)
-
 =pod
 
 lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, and also provides the Apache handler for the "Navigation Map" button.
@@ -1336,7 +1332,7 @@
 
 =over 4
 
-=item * B<new>(filename, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled course representation and parmHashFile. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.
+=item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.
 
 =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
 
@@ -1712,25 +1708,32 @@
 
 =over 4
 
-=item B<getIterator>(nav_map, firstResource, finishResource, filterHash, condition): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). It is your responsibility to ensure that the iterator will actually get there. filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0, which is to say, do not recurse unless explicitly asked to.
+=item B<getIterator>(firstResource, finishResource, filterHash, condition): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0, which is to say, do not recurse unless explicitly asked to.
 
-Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples.
+Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples: By default, the condition is 0 and all folders are closed unless explicitly opened. Clicking "Show All Resources" will use a condition of 1 and an empty filterHash, resulting in all resources being shown.
 
 The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:
 
 =over 4
 
-=item * some list of tokens here
+=item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned.
+
+=item * END_MAP: The map is now done.
+
+=item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch.
+
+=item * END_BRANCH: The branch is now done.
 
 =back
 
-The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_NAV_MAP. (Perl will automatically optimize these into constants.
+The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.
+
+=back
 
 =cut
 
 # Here are the tokens for the iterator:
 
-sub END_NAV_MAP { return 0; }  # Represents end of entire nav map
 sub BEGIN_MAP { return 1; }    # begining of a new map
 sub END_MAP { return 2; }      # end of the map
 sub BEGIN_BRANCH { return 3; } # beginning of a branch
@@ -1796,30 +1799,11 @@
     return $self;
 }
 
-# FIXME: Document this.
-sub cancelTopRecursion {
-    my $self = shift;
-    
-    if (!$self->{RECURSIVE_ITERATOR_FLAG}) {return;}
-
-    # is this the iterator we want to kill?
-    if ($self->{RECURSIVE_ITERATOR_FLAG} && 
-        !$self->{RECURSIVE_ITERATOR}->{RECURSIVE_ITERATOR_FLAG}) {
-        $self->{RECURSIVE_ITERATOR_FLAG} = 0;
-        undef $self->{RECURSIVE_ITERATOR};
-        return;
-    }
-    
-    $self->{RECURSIVE_ITERATOR}->cancelTopRecursion();
-}
-
 # Note... this function is *touchy*. I strongly recommend tracing
 # through it with the debugger a few times on a non-trivial map before
 # modifying it. Order is *everything*.
-# FIXME: Doc that skipMap will prevent the recursion, if any.
 sub next {
     my $self = shift;
-    my $skipMap = shift;
     
     # Iterator logic goes here
 
@@ -1904,12 +1888,6 @@
     # remember that we've seen this.
     $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
     
-    # Are we at the utter end? If so, return the END_NAV_MAP marker.
-    if ($self->{HERE} == $self->{NAV_MAP}->finishResource() ) {
-        $self->{FORCE_NEXT} = $self->END_NAV_MAP;
-        return $self->{HERE};
-    }
-    
     # Get the next possible resources
     my $nextUnfiltered = $self->{HERE}->getNext();
     my $next = [];
@@ -1952,7 +1930,7 @@
     }
 
     # If this is a map and we want to recurse down it... (not filtered out)
-    if ($self->{HERE}->is_map() && !$skipMap && 
+    if ($self->{HERE}->is_map() && 
          (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) { 
         $self->{RECURSIVE_ITERATOR_FLAG} = 1;
         my $firstResource = $self->{HERE}->map_start();
@@ -2019,7 +1997,9 @@
 
 =over 4
 
-=item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. 
+=item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. Very rarely, if ever, called directly. Use the nav map->getByID() method.
+
+=back
 
 =cut
 
@@ -2046,20 +2026,6 @@
     return $self;
 }
 
-=pod
-
-=item * B<is_map>: Returns true if this is a map, false otherwise.
-
-=item * B<title>: Returns title.
-
-=item * B<type>: Returns the type of the resource, "start", "normal", or "finish". 
-
-=item * B<problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field.)
-
-=back
-
-=cut
-
 # private function: simplify the NAV_HASH lookups we keep doing
 # pass the name, and to automatically append my ID, pass a true val on the
 # second param
@@ -2070,15 +2036,43 @@
     return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};
 }
 
+=pod
+
+B<Metadata Retreival>
+
+These are methods that help you retrieve metadata about the resource:
+
+=over 4
+
+=item * B<ext>: Returns true if the resource is external.
+
+=item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
+
+=item * B<kind>: Returns the kind of the resource from the compiled nav map.
+
+=item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature.
+
+=item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)
+
+=item * B<src>: Returns the source for the resource.
+
+=item * B<symb>: Returns the symb for the resource.
+
+=item * B<title>: Returns the title of the resource.
+
+=item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
+
+=item * B<type>: Returns the type of the resource, "start", "normal", or "finish". 
+
+=back
+
+=cut
+
 # These info functions can be used directly, as they don't return
 # resource information.
-sub title { my $self=shift; return $self->navHash("title_", 1); }
-sub type { my $self=shift; return $self->navHash("type_", 1); }
+sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
 sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
-# "to" can return a comma seperated list for branches
-sub to { my $self=shift; return $self->navHash("to_", 1); }
 sub kind { my $self=shift; return $self->navHash("kind_", 1); }
-sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
 sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
 sub randompick { 
     my $self = shift;
@@ -2097,30 +2091,59 @@
          $self->navHash('map_id_'.$first)) 
         . '___' . $second . '___' . $symbSrc;
 }
-sub is_problem {
+sub title { my $self=shift; return $self->navHash("title_", 1); }
+sub to { my $self=shift; return $self->navHash("to_", 1); }
+sub type { my $self=shift; return $self->navHash("type_", 1); }
+
+=pod
+
+B<Predicate Testing the Resource>
+
+These methods are shortcuts to deciding if a given resource has a given property.
+
+=over 4
+
+=item * B<is_map>: Returns true if the resource is a map type.
+
+=item * B<is_problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field; might need more to work correctly.)
+
+=item * B<is_page>: Returns true if the resource is a page.
+
+=item * B<is_problem>: Returns true if the resource is a problem.
+
+=item * B<is_sequence>: Returns true if the resource sequence.
+
+=back
+
+=cut
+
+
+sub is_html {
     my $self=shift;
     my $src = $self->src();
-    return ($src =~ /problem$/);
+    return ($src =~ /html$/);
 }
-sub is_html {
+sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
+sub is_page {
     my $self=shift;
     my $src = $self->src();
-    return ($src =~ /html$/);
+    return ($src =~ /page$/);
 }
-sub is_sequence {
+sub is_problem {
     my $self=shift;
     my $src = $self->src();
-    return ($src =~ /sequence$/);
+    return ($src =~ /problem$/);
 }
-sub is_page {
+sub is_sequence {
     my $self=shift;
     my $src = $self->src();
-    return ($src =~ /page$/);
+    return ($src =~ /sequence$/);
 }
 
 
 
 
+
 # Move this into POD: In order to use these correctly, courseopt
 # and useropt need to be generated
 sub parmval {
@@ -2130,14 +2153,26 @@
     return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
 }
 
-#####
-# Map Queries
-#####
+=pod
 
-# These methods relate to whether or not the resource is a map, and the 
-# attributes of that map.
+B<Map Methods>
+
+These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>).
+
+=over 4
+
+=item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map.
+
+=item * B<map_pc>: Returns the pc value of the map, which is the first number that appears in the resource ID of the resources in the map, and is the number that appears around the middle of the symbs of the resources in that map.
+
+=item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map.
+
+=item * B<map_type>: Returns a string with the type of the map in it.
+
+=back
+
+=cut
 
-sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
 sub map_finish {
     my $self = shift;
     my $src = $self->src();
@@ -2145,6 +2180,11 @@
     $res = $self->{NAV_MAP}->getById($res);
     return $res;
 }
+sub map_pc {
+    my $self = shift;
+    my $src = $self->src();
+    return $self->navHash("map_pc_$src", 0);
+}
 sub map_start {
     my $self = shift;
     my $src = $self->src();
@@ -2152,11 +2192,6 @@
     $res = $self->{NAV_MAP}->getById($res);
     return $res;
 }
-sub map_pc {
-    my $self = shift;
-    my $src = $self->src();
-    return $self->navHash("map_pc_$src", 0);
-}
 sub map_type {
     my $self = shift;
     my $pc = $self->map_pc();
@@ -2179,7 +2214,7 @@
 
 =head2 Resource Parameters
 
-In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to "part 0", but can be directed to another part by passing the part as the second parameter.
+In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to part "0", but can be directed to another part by passing the part as the parameter.
 
 These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)
 
@@ -2201,6 +2236,8 @@
 
 =item * B<tol>: Get the tolerance for the problem.
 
+=item * B<tries>: Get the number of tries the user has already used on the problem.
+
 =item * B<type>: Get the question type for the problem.
 
 =item * B<weight>: Get the weight for the problem.
@@ -2246,14 +2283,6 @@
     (my $self, my $part) = @_;
     return $self->parmval("tol", $part);
 }
-sub type {
-    (my $self, my $part) = @_;
-    return $self->parmval("type", $part);
-}
-sub weight {
-    (my $self, my $part) = @_;
-    return $self->parmval("weight", $part);
-}
 sub tries {
     my $self = shift;
     my $part = shift;
@@ -2266,6 +2295,14 @@
     if (!defined($tries)) {return '0';}
     return $tries;
 }
+sub type {
+    (my $self, my $part) = @_;
+    return $self->parmval("type", $part);
+}
+sub weight {
+    (my $self, my $part) = @_;
+    return $self->parmval("weight", $part);
+}
 
 # Multiple things need this
 sub getReturnHash {
@@ -2323,9 +2360,9 @@
 
 =pod
 
-=item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. You may or may not wish to filter out part 0.)
+=item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. Filtering part 0 if you want it is up to you.)
 
-=item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0.
+=item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0. Thus, B<parts> may return an array with fewer parts in it then countParts might lead you to believe.
 
 =back
 
@@ -2399,12 +2436,16 @@
     my $dateStatus = $resource->getDateStatus($_);
     my $completionStatus = $resource->getCompletionStatus($_);
 
+    or
+
+    my $status = $resource->status($_);
+
     ... use it here ...
  }
 
 =over 4
 
-=item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. You should still check to see if there is a due date at all, if you care about that. The possible return values are:
+=item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are:
 
 =back
 
@@ -2542,29 +2583,29 @@
 
 =over 4
 
-=item * NETWORK_FAILURE: The network has failed and the information is not available.
+=item * B<NETWORK_FAILURE>: The network has failed and the information is not available.
 
-=item * NOTHING_SET: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)
+=item * B<NOTHING_SET>: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)
 
-=item * CORRECT: For any reason at all, the part is considered correct.
+=item * B<CORRECT>: For any reason at all, the part is considered correct.
 
-=item * EXCUSED: For any reason at all, the problem is excused.
+=item * B<EXCUSED>: For any reason at all, the problem is excused.
 
-=item * PAST_DUE_NO_ANSWER: The problem is past due, not considered correct, and no answer date is set.
+=item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set.
 
-=item * PAST_DUE_ANSWER_LATER: The problem is past due, not considered correct, and an answer date in the future is set.
+=item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set.
 
-=item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available.
+=item * B<ANSWER_OPEN>: The problem is past due, not correct, and the answer is now available.
 
-=item * OPEN_LATER: The problem is not yet open.
+=item * B<OPEN_LATER>: The problem is not yet open.
 
-=item * TRIES_LEFT: The problem is open, has been tried, is not correct, but there are tries left.
+=item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left.
 
-=item * INCORRECT: The problem is open, and all tries have been used without getting the correct answer.
+=item * B<INCORRECT>: The problem is open, and all tries have been used without getting the correct answer.
 
-=item * OPEN: The item is open and not yet tried.
+=item * B<OPEN>: The item is open and not yet tried.
 
-=item * ATTEMPTED: The problem has been attempted.
+=item * B<ATTEMPTED>: The problem has been attempted.
 
 =back
 

--bowersj21034106647--