singularitygs 1.1.2 → 1.8.0

data/stylesheets/singularitygs/api/_float.scss

@@ -1,160 +1,98 @@
-@mixin output-float($span, $location, $columns, $gutter, $options: false) {
+@function output-float($Span-Map) {
+  // Set up Left/Right maps
+  $Return: ();
 
-  $location-holder: $location;
+  $Span: map-get($Span-Map, 'span');
+  $Location: map-get($Span-Map, 'location');
 
-  @if type-of($location) == string {
-    @if end-row($span, $location, $columns) {
-      $grid-length: length(find-grid($columns));
-      $location-holder: $grid-length - $span;
-    }
-    @else {
-      $location-holder: 1;
-    }
-  }
+  $Grid: map-get($Span-Map, 'grid');
+  $Gutter: map-get($Span-Map, 'gutter');
+  $Style: map-get($Span-Map, 'style');
 
-  $gutter: find-gutter($gutter);
-  $gutter-span: gutter-span($gutter, $columns);
-  $end-row: end-row($span, $location, $columns);
-  $start-row: start-row($location);
-
-  $gutter-style: find-gutter-style();
-  $fixed-gutter: fixed-gutter($columns, $gutter);
-  $gutter-property: gutter-property($columns, $gutter);
-
-  width: column-span($span, $location-holder, $columns, $gutter, $gutter-style);
-
-  @if $direction == 'ltr' or $direction == 'both' {
-    // Set the CSS direction to ltr
-    $cssdir: 'ltr';
-    // Find the CSS named direction and opposite direction
-    $dir: named-direction($cssdir);
-    $opp: opposite-direction($dir);
-
-    clear: $opp;
-
-    @if $end-row {
-      float: $opp;
-      @if index($gutter-style, split) and not $fixed-gutter {
-	#{$gutter-property}-#{$dir}: 0;
-	#{$gutter-property}-#{$opp}: $gutter-span / 2;
-      }
-      @else if not $fixed-gutter {
-	#{$gutter-property}-#{$opp}: 0;
-      }
-    }
-    @else {
-      float: $dir;
-
-      @if $start-row {
-	@if index($gutter-style, split) and not $fixed-gutter {
-	  #{$gutter-property}-#{$dir}: $gutter-span / 2;
-	  #{$gutter-property}-#{$opp}: $gutter-span / 2;
-	}
-	@else if not $fixed-gutter {
-	  #{$gutter-property}-#{$dir}: 0;
-	  #{$gutter-property}-#{$opp}: $gutter-span;
-	}
+  $Start-Row: map-get($Span-Map, 'start row');
+  $End-Row: map-get($Span-Map, 'end row');
 
-      }
-    }
+  $Fixed-Gutter: map-get($Span-Map, 'fixed gutter');
+  $Split-Gutter: map-get($Span-Map, 'split gutter');
+  $Gutter-Property: map-get($Span-Map, 'gutter property');
 
-    @if $fixed-gutter {
-      @if index($gutter-style, split) {
-	#{$gutter-property}-#{$dir}: $gutter-span / 2;
-	#{$gutter-property}-#{$opp}: $gutter-span / 2;
-      }
-      @else {
-	#{$gutter-property}-#{$opp}: $gutter-span;
-      }
-    }
-  }
+  $Direction: map-get($Span-Map, 'direction');
+  $Options: map-get($Span-Map, 'options');
 
-  @if $direction == 'rtl' or $direction == 'both' {
-    // Set the CSS direction to ltr
-    $cssdir: 'rtl';
-    // Find the CSS named direction and opposite direction
-    $dir: named-direction($cssdir);
-    $opp: opposite-direction($dir);
-
-
-    [dir="#{$cssdir}"] & {
-      clear: $opp;
-
-      @if $end-row {
-        float: $opp;
-	@if index($gutter-style, split) and not $fixed-gutter {
-	  #{$gutter-property}-#{$dir}: 0;
-	  #{$gutter-property}-#{$opp}: $gutter-span / 2;
-	}
-	@else if not $fixed-gutter {
-	  #{$gutter-property}-#{$opp}: 0;
-	}
-      }
-      @else {
-        float: $dir;
-
-        @if $start-row {
-	  @if index($gutter-style, split) and not $fixed-gutter {
-	    #{$gutter-property}-#{$dir}: $gutter-span / 2;
-	    #{$gutter-property}-#{$opp}: $gutter-span / 2;
-	  }
-	  @else if not $fixed-gutter {
-	    #{$gutter-property}-#{$dir}: 0;
-	    #{$gutter-property}-#{$opp}: $gutter-span;
-	  }
-	}
-      }
-
-      @if $fixed-gutter {
-	@if $direction == 'rtl' {
-	  @if index($gutter-style, split) {
-	    #{$gutter-property}-#{$dir}: $gutter-span / 2;
-	    #{$gutter-property}-#{$opp}: $gutter-span / 2;
-	  }
-	  @else {
-	    #{$gutter-property}-#{$opp}: $gutter-span;
-	  }
-	}
-	@else if not index($gutter-style, split) {
-	  #{$gutter-property}-#{$opp}: $gutter-span;
-        }
-      }
-    }
+  @if $Start-Row {
+    $Location: 1;
+  }
+  @else if $End-Row {
+    $Location: column-count($Grid) - $Span + 1;
   }
 
-  @include span-shared;
-}
-
-@mixin push-float($span, $location, $columns: false, $gutter: false) {
+  $Width: column-span($Span, $Location, $Grid, $Gutter, $Style);
+  $Margin-Span: column-span(($Location - 1), 1, $Grid, $Gutter, $Style);
+  $Gutter-Span: gutter-span($Gutter, $Grid);
 
-  @if type-of($location) == string {
-    $location: 1;
+  // Backwards Compatibility for Options
+  @if type-of($Options) != 'map' and $Options != null {
+    $Options: ('clear': unquote(nth($Options, 1)));
   }
 
-  // Find the columns and gutters
-  $columns: find-grid($columns);
-  $gutter: find-gutter($gutter);
+  $Dir: $Direction;
+  $Opp: opposite-direction($Dir);
 
-  // Combine the columns and gutters
-  $gutter: column-span($span, $location, $columns, $gutter) + gutter-span($gutter, $columns);
+  $Return: map-merge($Return, ('width': $Width));
+  $Return: map-merge($Return, ('clear': $Opp));
 
-  margin-left: $gutter;
-}
+  @if ($End-Row) {
+    $Return: map-merge($Return, ('float': $Opp));
 
-@mixin pull-float($span, $location, $columns: false, $gutter: false) {
+    @if $Split-Gutter and not $Fixed-Gutter {
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Dir}': 0));
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': $Gutter-Span / 2));
+    }
+    @else if not $Fixed-Gutter {
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': 0));
+    }
+  }
+  @else {
+    $Return: map-merge($Return, ('float': $Dir));
 
-  @if type-of($location) == string {
-    $location: 1;
+    @if $Split-Gutter and not $Fixed-Gutter {
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Dir}': $Gutter-Span / 2));
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': $Gutter-Span / 2));
+    }
+    @else if not $Fixed-Gutter {
+      @if $Start-Row {
+        $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Dir}': 0));
+      }
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': $Gutter-Span));
+    }
+  }
+  // If options are set, we merge them in!
+  @if ($Options) {
+    $Return: map-merge($Return, $Options);
   }
 
-  // Find the columns and gutters
-  $columns: find-grid($columns);
-  $gutter: find-gutter($gutter);
+  // If CLear isn't already available, set it!
+  @if not map-has-key($Return, 'clear') {
+    $Return: map-merge($Return, ('clear': none));
+  }
 
-  // Combine the columns and gutters
-  $gutter: (column-span($span, $location, $columns, $gutter) + gutter-span($gutter, $columns)) * -1;
+  // Left Fixed Gutters
+  @if $Fixed-Gutter {
+    @if index($Style, 'split') {
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Dir}': $Gutter-Span / 2));
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': $Gutter-Span / 2));
+    }
+    @else {
+      @if not $End-Row {
+        $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': $Gutter-Span));
+      }
+      @else {
+        $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': 0));
+      }
+    }
+  }
 
-  margin-left: $gutter;
+  @return $Return;
 }
 
 //////////////////////////////
@@ -162,11 +100,13 @@
 //
 // Makes working with Float easier, as it allows you to walk the grid for symmetric grids and easy applying of 'last' and 'first', as well as automatically building the verbose grid-span mixin call
 //////////////////////////////
-@mixin float-span($span, $location: false, $grid: false, $gutter: false) {
+@mixin float-span($Span, $Location: false, $grid: false, $gutter: false, $gutter-style: false, $from: false) {
   $grid: find-grid($grid);
   $gutter: find-gutter($gutter);
   $row: false;
 
+  $Options: if($from, ('from': $from), null);
+
   // Working around SASS treating a number like a list with one element
   @if type-of($grid) == 'list' and length($grid) == 1 {
     $grid: nth($grid, 1);
@@ -175,27 +115,27 @@
   // Working with a symmetric grid
   @if type-of($grid) == 'number' {
     // Special treatment for non-numeric location
-    @if type-of($location) != 'number' {
-      @if $location == 'last' or $location == 'omega' {
-        $location: $grid - $span + 1;
+    @if type-of($Location) != 'number' {
+      @if $Location == 'last' or $Location == 'omega' {
+        $Location: $grid - $Span + 1;
       }
       @else {
-        @if $location == 'first' or $location == 'alpha' {
+        @if $Location == 'first' or $Location == 'alpha' {
           $row: true;
         }
-        $location: 1;
+        $Location: 1;
       }
     }
 
-    @include grid-span($span, $location, $grid, $gutter, 'float');
+    @include grid-span($Span, $Location, $grid, $gutter, 'float', $gutter-style, $Options);
 
     @if $row {
       clear: both;
     }
   }
   // Working with an asymmetric grid, should have location provided
-  @else if type-of($grid) == 'list' and $location != false {
-    @include grid-span($span, $location, $grid, $gutter, 'float');
+  @else if type-of($grid) == 'list' and $Location != false {
+    @include grid-span($Span, $Location, $grid, $gutter, 'float', $gutter-style, $Options);
   }
   @else {
     @warn 'Asymmetric Grids need a Location value as well as a span value in order to know where on the grid you are! Please include a location value!';

data/stylesheets/singularitygs/api/_isolation.scss

@@ -1,168 +1,135 @@
-@mixin output-isolation($span, $location, $columns, $gutter, $options: false) {
+@function output-isolation($Span-Map) {
+  // Set up Left/Right maps
+  $Return: ();
 
-  $gutter: find-gutter($gutter);
-  $gutter-span: gutter-span($gutter, $columns);
-  $end-row: end-row($span, $location, $columns);
-  $start-row: start-row($location);
+  $Span: map-get($Span-Map, 'span');
+  $Location: map-get($Span-Map, 'location');
 
-  $gutter-style: find-gutter-style();
-  $fixed-gutter: fixed-gutter($columns, $gutter);
-  $gutter-property: gutter-property($columns, $gutter);
-  $split: index($gutter-style, split);
+  $Grid: map-get($Span-Map, 'grid');
+  $Gutter: map-get($Span-Map, 'gutter');
+  $Style: map-get($Span-Map, 'style');
 
-  $margin-span: column-span(($location - 1), 1, $columns, $gutter, $gutter-style);
+  $Start-Row: map-get($Span-Map, 'start row');
+  $End-Row: map-get($Span-Map, 'end row');
 
-  @if not $fixed-gutter {
-    $margin-span: $margin-span + $gutter-span;
+  $Fixed-Gutter: map-get($Span-Map, 'fixed gutter');
+  $Split-Gutter: map-get($Span-Map, 'split gutter');
+  $Gutter-Property: map-get($Span-Map, 'gutter property');
+
+  $Direction: map-get($Span-Map, 'direction');
+  $Options: map-get($Span-Map, 'options');
+
+  $Width: column-span($Span, $Location, $Grid, $Gutter, $Style);
+  $Margin-Span: column-span(($Location - 1), 1, $Grid, $Gutter, $Style);
+  $Gutter-Span: gutter-span($Gutter, $Grid);
+
+  // Backwards Compatibility for Options
+  @if type-of($Options) != 'map' and $Options != null {
+    $Options: ('clear': unquote(nth($Options, 1)));
   }
 
+  $Dir: $Direction;
+  $Opp: opposite-direction($Dir);
 
-  @if $direction == 'ltr' or $direction == 'both' {
-    // Set the CSS direction to ltr
-    $cssdir: 'ltr';
-    // Find the CSS named direction and opposite direction
-    $dir: named-direction($cssdir);
-    $opp: opposite-direction($dir);
+  $Return: map-merge($Return, ('width': $Width));
 
-    width: column-span($span, $location, $columns, $gutter, $gutter-style);
+  @if ($End-Row) {
+    $Return: map-merge($Return, ('float': $Opp));
+    $Return: map-merge($Return, ('margin-#{$Dir}': 0));
 
-    // If we are at the last item in the row, we float it the opposite direction
-    @if ($end-row) {
-      float: $opp;
-      margin-#{$dir}: 0;
-      @if $split and not $fixed-gutter {
-	#{$gutter-property}-#{$opp}: $gutter-span / 2;
-      }
-      @else {
-	margin-#{$opp}: 0;
-      }
+    @if $Split-Gutter and not $Fixed-Gutter {
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': $Gutter-Span / 2));
     }
     @else {
-      float: $dir;
-      margin-#{$opp}: -100%;
-
-      @if $start-row {
-	@if $split and not $fixed-gutter {
-	  margin-#{$dir}: $gutter-span / 2;
-	}
-	@else {
-	  margin-#{$dir}: 0%;
-	}
-      }
-      @else {
-	@if $split and not $fixed-gutter {
-	  margin-#{$dir}: $margin-span + $gutter-span / 2;
-	}
-	@else {
-	  margin-#{$dir}: $margin-span;
-	}
-
-      }
+      $Return: map-merge($Return, ('margin-#{$Opp}': 0));
     }
+  }
+  @else {
+    $Return: map-merge($Return, ('float': $Dir));
+    $Return: map-merge($Return, ('margin-#{$Opp}': -100%));
 
-    // If options are set, we clear to that option, otherwise no clear!
-    @if ($options) {
-      clear: unquote($options);
+    @if $Start-Row {
+      @if $Split-Gutter and not $Fixed-Gutter {
+        $Return: map-merge($Return, ('margin-#{$Dir}': $Gutter-Span / 2));
+      }
+      @else if not $Fixed-Gutter {
+        $Return: map-merge($Return, ('margin-#{$Dir}': 0));
+      }
     }
     @else {
-      clear: none;
-    }
-
-    @if $fixed-gutter {
-      @if index($gutter-style, split) {
-	#{$gutter-property}-#{$dir}: $gutter-span / 2;
-	#{$gutter-property}-#{$opp}: $gutter-span / 2;
+      @if $Split-Gutter and not $Fixed-Gutter {
+        $Return: map-merge($Return, ('margin-#{$Dir}': $Margin-Span + $Gutter-Span + $Gutter-Span / 2));
+      }
+      @else if not $Fixed-Gutter {
+        $Return: map-merge($Return, ('margin-#{$Dir}': $Margin-Span + $Gutter-Span));
       }
       @else {
-	#{$gutter-property}-#{$opp}: $gutter-span;
+        $Return: map-merge($Return, ('margin-#{$Dir}': $Margin-Span));
       }
     }
   }
+  // If options are set, we merge them in!
+  @if ($Options) {
+    $Return: map-merge($Return, $Options);
+  }
 
-  @if $direction == 'rtl' or $direction == 'both' {
-    // Set the CSS direction to ltr
-    $cssdir: 'rtl';
-    // Find the CSS named direction and opposite direction
-    $dir: named-direction($cssdir);
-    $opp: opposite-direction($dir);
-
-    [dir="#{$cssdir}"] & {
-      // If we are at the last item in the row, we float it the opposite direction
-      @if ($end-row) {
-        float: $opp;
-	margin-#{$dir}: 0;
-	@if $split and not $fixed-gutter {
-	  #{$gutter-property}-#{$opp}: $gutter-span / 2;
-	}
-	@else {
-	  margin-#{$opp}: 0;
-	}
-      }
-      @else {
-        float: $dir;
-        margin-#{$opp}: -100%;
-
-        @if $start-row {
-	  @if $split and not $fixed-gutter {
-	    margin-#{$dir}: $gutter-span / 2;
-	  }
-	  @else {
-	    margin-#{$dir}: 0%;
-	  }
-        }
-        @else {
-	  @if $split and not $fixed-gutter {
-	    margin-#{$dir}: $margin-span + $gutter-span / 2;
-	  }
-	  @else {
-	    margin-#{$dir}: $margin-span;
-	  }
-
-        }
-      }
+  // If CLear isn't already available, set it!
+  @if not map-has-key($Return, 'clear') {
+    $Return: map-merge($Return, ('clear': none));
+  }
 
-      // If options are set, we clear to that option, otherwise no clear!
-      @if ($options) {
-        clear: unquote($options);
+  // Left Fixed Gutters
+  @if $Fixed-Gutter {
+    @if index($Style, 'split') {
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Dir}': $Gutter-Span / 2));
+      $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': $Gutter-Span / 2));
+    }
+    @else {
+      @if not $End-Row {
+        $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': $Gutter-Span));
       }
       @else {
-        clear: none;
-      }
-
-      @if $fixed-gutter {
-	@if $direction == 'rtl' {
-	  @if index($gutter-style, split) {
-	    #{$gutter-property}-#{$dir}: $gutter-span / 2;
-	    #{$gutter-property}-#{$opp}: $gutter-span / 2;
-	  }
-	  @else {
-	    #{$gutter-property}-#{$opp}: $gutter-span;
-	  }
-	}
-	@else if not index($gutter-style, split) {
-	  #{$gutter-property}-#{$opp}: $gutter-span;
-	}
+        $Return: map-merge($Return, ('#{$Gutter-Property}-#{$Opp}': 0));
       }
     }
   }
 
-  @include span-shared;
-
+  @return $Return;
 }
 
-@mixin push-isolation($span, $location, $columns: false, $gutter: false) {
-  @include push-float($span, $location, $columns, $gutter);
-}
+//////////////////////////////
+// Happy Syntax for Isolation
+//
+// Makes working with Isolation easier, as it moves Clear to a 1st class citizen of the mixin, and automatically builds the verbose grid-span mixin call
+//////////////////////////////
+@mixin isolation-span($Span, $Location, $clear: false, $grid: false, $gutter: false, $gutter-style: false, $from: false) {
+  $Options: ();
+  @if $clear {
+    $Options: map-merge($Options, ('clear': unquote($clear)));
+  }
+  @if $from {
+    $Options: map-merge($Options, ('from': $from));
+  }
 
-@mixin pull-isolation($span, $location, $columns: false, $gutter: false) {
-  @include pull-float($span, $location, $columns, $gutter);
+  $Options: if(length($Options) > 0, $Options, null);
+  @include grid-span($Span, $Location, $grid, $gutter, 'isolation', $gutter-style, $Options);
 }
 
 //////////////////////////////
-// Happy Syntax for Isolation
+// Happy Syntax of Asymmetric Grids
 //
-// Makes working with Isolation easier, as it moves Clear to a 1st class citizen of the mixin, and automatically builds the verbose grid-span mixin call
+// Makes working with asymmetric grids easier!
 //////////////////////////////
-@mixin isolation-span($span, $location, $clear: false, $grid: false, $gutter: false) {
-  @include grid-span($span, $location, $grid, $gutter, 'isolation', $clear);
+@mixin asymmetric-span($Location, $Span: false, $grid: false, $gutter: false, $gutter-style: false, $from: false, $output-style: false) {
+
+  $Span: if($Span != false, $Span, 1);
+  $output-style: if($output-style != false, $output-style, sgs-get('asymmetric output'));
+
+  $Options: ();
+  @if $from {
+    $Options: map-merge($Options, ('from': $from));
+  }
+  $Options: if(length($Options) > 0, $Options, null);
+
+  @include grid-span($Span, $Location, $grid, $gutter, $output-style, $gutter-style, $Options);
 }

data/stylesheets/singularitygs/grids/_add.scss

@@ -8,28 +8,46 @@
 //                                    https://github.com/Team-Sass/Singularity/wiki/Creating-Grids
 // - $append-to-list  : [list]        A list to append to.
 //                                    Defaults to $grids if none is specified.
-@function add-grid($grid-definition, $append-to-list: $grids) {
-  $parsed:      parse-add($grid-definition); // Converts the definiton to a temporary format:
-                                             // either `((<grid>))` or `((<grid>) (<breakpoint>))`
-  $grid:        nth($parsed, 1); // E. g. `(<grid>)`.
-  $breakpoint:  nth($parsed, 2); // Either `(<breakpoint>)` or false.
-  $list-length: length($append-to-list);
-  
+@function add-grid($grid-definition, $custom-map: false) {
+  $Parsed:      parse-add($grid-definition); // Parses grid definition to grid/breakpoint
+  $Grid:        nth($Parsed, 1); // E. g. `(<grid>)`.
+  $Breakpoint:  nth($Parsed, 2); // Either `(<breakpoint>)` or false.
+  $Mobile-First: sgs-get('mobile first');
+  $Grid-Map: ();
+
+  // Determine if a custom map or the default maps should be used.
+  @if $custom-map {
+    $Grid-Map: $custom-map;
+  }
+  @else {
+    @if sgs-has('grids') {
+      $Grid-Map: sgs-get('grids');
+    }
+  }
+  $Grid-Key-Length: length(map-keys($Grid-Map));
+
   // Check whether the definition will be the first one in the list
   // and whether it has no breakpoint specified.
-  @if $breakpoint == false and $list-length == 0 {
+  @if $Breakpoint == null {
     // Returns the first item of the list, e. g. `(<grid>)`
-    @return $grid;
+    $Grid-Map: map-merge($Grid-Map, (-1px: $Grid));
   }
   // IF the list is initiated with a list of grid columns need to start off
   // a comma seprated list.
-  @elseif $list-length > 1 and length(nth($append-to-list, 2)) == 1 {
-    // Seed the first value and grid + breakpoint seperated by a comma.
-    @return $append-to-list, ($grid $breakpoint);
-  }
   @else {
-    // Appends to a comma-separated list of definitions in the internal format
-    // and returns it, e. g. `(<grid>), (<grid> <breakpoint>), (<grid> <breakpoint>)`
-    @return append($append-to-list, ($grid $breakpoint), 'comma');
+    @if not (map-has-key($Grid-Map, -1px)) {
+      $Grid-Map: map-merge($Grid-Map, map-get($Singularity-Settings, 'grids'));
+    }
+    $Grid-Map: map-merge($Grid-Map, ($Breakpoint: $Grid));
   }
+
+  $Grid-Map: sort-map($Grid-Map, not $Mobile-First);
+
+  @return $Grid-Map;
 }
+
+
+@mixin add-grid($grid-definition) {
+  $Add-Grid: add-grid($grid-definition);
+  $HOLDER: sgs-set('grids', $Add-Grid);
+}

data/stylesheets/singularitygs/grids/_find.scss

@@ -5,19 +5,17 @@
 // From Singularity
 // Must be using Breakpoint to work properly
 //////////////////////////////
-@function find-grid($user-columns: false) {
+@function find-grid($user-columns: null) {
 
   // We supply a default if the user hasn't set any grids and hasn't passed in a custom column set
   // The default supplied is based on original Susy options
-  @if length($grids) == 0 and $user-columns == false {
-    $user-columns: 12;
-  }
+  $Grids: sgs-get('grids');
 
-  $found: find-object($grids, $user-columns);
+  $Found: find-object($Grids, $user-columns);
 
-  @if length($found) == 1 {
-    $found: nth($found, 1);
+  @if length($Found) == 1 {
+    $Found: nth($Found, 1);
   }
 
-  @return $found;
+  @return $Found;
 }