mscherer 3 years ago
parent
commit
15f8b10bb9

+ 1 - 1
docs/Helper/Common.md

@@ -5,7 +5,7 @@ A CakePHP helper to handle some common topics.
 ### Setup
 ### Setup
 Include helper in your AppView class as
 Include helper in your AppView class as
 ```php
 ```php
-$this->addHelper('Tools.Common', [
+$this->loadHelper('Tools.Common', [
     ...
     ...
 ]);
 ]);
 ```
 ```

+ 1 - 1
docs/Helper/Format.md

@@ -5,7 +5,7 @@ A CakePHP helper to handle some common format topics.
 ## Setup
 ## Setup
 Include helper in your AppView class as
 Include helper in your AppView class as
 ```php
 ```php
-$this->addHelper('Tools.Format', [
+$this->loadHelper('Tools.Format', [
     ...
     ...
 ]);
 ]);
 ```
 ```

+ 1 - 1
docs/Helper/Icon.md

@@ -5,7 +5,7 @@ A CakePHP helper to handle most common font icons. Contains convenience wrappers
 ## Setup
 ## Setup
 Include helper in your AppView class as
 Include helper in your AppView class as
 ```php
 ```php
-$this->addHelper('Tools.Icon', [
+$this->loadHelper('Tools.Icon', [
     ...
     ...
 ]);
 ]);
 ```
 ```

+ 1 - 1
docs/Helper/Meter.md

@@ -14,7 +14,7 @@ Note: The `<meter>` tag should not be used to indicate progress (as in a progres
 ## Setup
 ## Setup
 Include helper in your AppView class as
 Include helper in your AppView class as
 ```php
 ```php
-$this->addHelper('Tools.Meter', [
+$this->loadHelper('Tools.Meter', [
     ...
     ...
 ]);
 ]);
 ```
 ```

+ 5 - 5
docs/Helper/Progress.md

@@ -16,7 +16,7 @@ Note: The `<progress>` tag is not suitable for representing a gauge (e.g. disk s
 ## Setup
 ## Setup
 Include helper in your AppView class as
 Include helper in your AppView class as
 ```php
 ```php
-$this->addHelper('Tools.Progress', [
+$this->loadHelper('Tools.Progress', [
     ...
     ...
 ]);
 ]);
 ```
 ```
@@ -36,7 +36,7 @@ Display a text-based progress bar with the progress in percentage as title.
 ```php
 ```php
 echo $this->Progress->progressBar(
 echo $this->Progress->progressBar(
     $percentage // Value 0...1
     $percentage // Value 0...1
-    $length, // Char length >= 3 
+    $length, // Char length >= 3
     $attributes
     $attributes
 );
 );
 ```
 ```
@@ -46,7 +46,7 @@ Display a text-based progress bar as raw bar.
 ```php
 ```php
 echo $this->Progress->draw(
 echo $this->Progress->draw(
     $percentage // Value 0...1
     $percentage // Value 0...1
-    $length // Char length >= 3 
+    $length // Char length >= 3
 );
 );
 ```
 ```
 This can be used if you want to customize the usage.
 This can be used if you want to customize the usage.
@@ -55,7 +55,7 @@ This can be used if you want to customize the usage.
 
 
 This method is responsible for the main percentage calculation.
 This method is responsible for the main percentage calculation.
 It can be also used standalone.
 It can be also used standalone.
-```php 
+```php
 $percentage = $this->Progress->calculatePercentage($total, $is);
 $percentage = $this->Progress->calculatePercentage($total, $is);
 echo $this->Number->toPercentage($percentage, 0, ['multiply' => true]);
 echo $this->Number->toPercentage($percentage, 0, ['multiply' => true]);
 ```
 ```
@@ -64,7 +64,7 @@ echo $this->Number->toPercentage($percentage, 0, ['multiply' => true]);
 
 
 This method is responsible for the above min/max handling.
 This method is responsible for the above min/max handling.
 It can be also used standalone.
 It can be also used standalone.
-```php 
+```php
 $percentage = $this->Progress->roundPercentage($value);
 $percentage = $this->Progress->roundPercentage($value);
 echo $this->Number->toPercentage($percentage, 0, ['multiply' => true]);
 echo $this->Number->toPercentage($percentage, 0, ['multiply' => true]);
 ```
 ```

+ 7 - 7
docs/Helper/Tree.md

@@ -13,7 +13,7 @@ then use all properties and getters on that object.
 ### Basic usage
 ### Basic usage
 Include helper in your AppView class as
 Include helper in your AppView class as
 ```php
 ```php
-$this->addHelper('Tools.Tree', [
+$this->loadHelper('Tools.Tree', [
     ...
     ...
 ]);
 ]);
 ```
 ```
@@ -70,12 +70,12 @@ So the current entity object is available as `$data` variable inside this snippe
 - $activePathElement : string
 - $activePathElement : string
 - $isSibling : bool
 - $isSibling : bool
 
 
-plus all config values. 
+plus all config values.
 
 
 ### Callback usage
 ### Callback usage
 
 
 Here the same keys are available on the first argument (`$data` array). So the above `$data` would actually be
 Here the same keys are available on the first argument (`$data` array). So the above `$data` would actually be
-`$data['data']` and usually be the entity. 
+`$data['data']` and usually be the entity.
 If you are passing entities, it helps to inline annotate in this case:
 If you are passing entities, it helps to inline annotate in this case:
 ```php
 ```php
     $closure = function(array $data) {
     $closure = function(array $data) {
@@ -87,7 +87,7 @@ If you are passing entities, it helps to inline annotate in this case:
 ```
 ```
 
 
 ### Active path
 ### Active path
-When using the TreeHelper for navigation structures, you would usually want to set the active path as class elements ("active") 
+When using the TreeHelper for navigation structures, you would usually want to set the active path as class elements ("active")
 on the `<li>` elements.
 on the `<li>` elements.
 You can do that by passing in the current path.
 You can do that by passing in the current path.
 ```php
 ```php
@@ -96,15 +96,15 @@ $tree = $this->Table->find('threaded')->toArray();
 
 
 // The current active element in the tree (/view/6)
 // The current active element in the tree (/view/6)
 $id = 6;
 $id = 6;
-        
+
 // We need to get the current path for this element
 // We need to get the current path for this element
 $nodes = $this->Table->find('path', ['for' => $id]);
 $nodes = $this->Table->find('path', ['for' => $id]);
 $path = $nodes->extract('id')->toArray();
 $path = $nodes->extract('id')->toArray();
 
 
 // In your view
 // In your view
 $options = [
 $options = [
-    'autoPath' => [$current->lft, $current->rght], 
-    'treePath' => $path, 
+    'autoPath' => [$current->lft, $current->rght],
+    'treePath' => $path,
     'element' => 'tree', // src/Template/Element/tree.ctp
     'element' => 'tree', // src/Template/Element/tree.ctp
 ];
 ];
 echo $this->Tree->generate($tree, $options);
 echo $this->Tree->generate($tree, $options);

+ 1 - 1
docs/Helper/Typography.md

@@ -13,7 +13,7 @@ Upon output one can the decide to re-apply localization here.
 #### Basic usage
 #### Basic usage
 Include helper in your AppView class as
 Include helper in your AppView class as
 ```php
 ```php
-$this->addHelper('Tools.Typography', [
+$this->loadHelper('Tools.Typography', [
     ...
     ...
 ]);
 ]);
 ```
 ```