CRM-16995: Documentation improvements.
authorFrank J. Gómez <frank@ginkgostreet.com>
Wed, 12 Aug 2015 19:00:33 +0000 (15:00 -0400)
committerFrank J. Gómez <frank@ginkgostreet.com>
Wed, 12 Aug 2015 19:00:33 +0000 (15:00 -0400)
Civi/Angular/Page/Main.php

index c06d52f55f3a5cf840be1bed51509efcdf515f5b..09ccf0cab95eb583e2d00698fd338990e3ad2bae 100644 (file)
@@ -32,6 +32,13 @@ class Main extends \CRM_Core_Page {
    */
   public $angular;
 
+  /**
+   * The region of the page into which JavaScript will be loaded.
+   *
+   * @var String
+   */
+  public $region;
+
   /**
    * @param string $title
    *   Title of the page.
@@ -110,8 +117,8 @@ class Main extends \CRM_Core_Page {
     }
 
     // If trying to load an Angular page via AJAX, the route must be passed as a
-    // URL parameter, since PHP doesn't know about URL fragments (i.e, what
-    // comes after the #).
+    // URL parameter, since the server doesn't receive information about
+    // URL fragments (i.e, what comes after the #).
     \CRM_Core_Resources::singleton()->addSetting(array(
       'angularRoute' => \CRM_Utils_Request::retrieve('route', 'String'),
     ));