Age | Commit message (Collapse) | Author | Files | Lines |
|
* Rename "ID" property of the Item class to "id"
* Rename "customID" constructor parameter to "id"
* Rename "resourceURL" property of the Resource class to "url"
* Rename "resourceURL" constructor parameter to "url"
|
|
|
|
Class BigPipe\BigPipe:
* addPhaseDoneJS
Class BigPipe\Pagelet:
* addHTML
* addResource
* addJSCode
* addDependency
* setTagName
* setPlaceholderHTML
|
|
Split up the "enabled" method of the BigPipe class into two methods, one
to check if the pipelining mode is currently enabled ("isEnabled") and
another one to enable/disable the pipelining mode ("setEnabled").
This change prevents that a single method has two different jobs, which
can be confusing for programmers who didn't wrote the code but only use
them. Now there are two clearly named methods for exactly one job.
|
|
|
|
Rename the "tagname" property and the "setTagname" method of the Pagelet
class to the lowerCamelCase variant "tagName" because it are two words.
|
|
Rename the second parameter for the "addPhaseDoneJS" method of the Item
class from the misleading name "callback" to "code" because that method
doesn't expect a real JS (or PHP) callback but rather simple JS code.
|
|
The first parameter for the constructor of the Resource classes should
not be optional if the next parameters obviously are non-optional. The
optional parameters (if any) must come after the required parameters.
|
|
Remove the unnecessary PHP closing tags and ensure that
*all* non-binary files ending with an LF character.
|
|
This commit replaces the function call of "removeLineBreaksAndTabs" from "Pagelet::flush()" with the direct call of the "str_replace" function. Therefore, you don't need to include the external function "removeLineBreaksAndTabs" (which was located outside the BigPipe namespace) into your project anymore.
|
|
This commit removes the superflous function calls "removeLineBreaksAndTabs" from the "Pagelet::getStructure()" and "Item::addPhaseDoneJS()" method. If it bothers you when some properties of the JSON-encoded pagelet object contain line breaks and tabs (visible as "\r", "\n" and "\t"), then you'll need to remove them before you pass the string of javascript code to the corresponding methods:
* $Pagelet->addJSCode(removeLineBreaksAndTabs($javascript_code));
* $Pagelet->addPhaseDoneJS(0, removeLineBreaksAndTabs($javascript_code));
|
|
|
|
|
|
|
|
|
|
This commit is a preparation for a few further commits and changes the mechanism how the BigPipe javascript library detects the last flushed pagelet from server. Previously, there was a "IS_LAST:true" property in the JSON encoded pagelet object. However, this meant that when the pagelet was sent to the client, the server already needed to know at this point that this is the last pagelet. This can no longer be reliably determined in the future due to smaller restructuring.
Instead of sending "IS_LAST:true" within the JSON encoded pagelet object of the last pagelet, the BigPipe::render() method on the server will display a <script> element which calls "BigPipe.onLastPageletArrived()" after all pagelets have been flushed. This call informs the javascript library that the last pagelet has been flushed and arrived at the client. This is required because the BigPipe javascript library otherwise doesn't know that the last pagelet has been arrived (the javascript library waits for all pagelets to be flushed and displayed until it begins to execute the external javascript resources of every pagelet).
|
|
The debug mechanism has been changed. Instead of keeping the debug mechanism hardcoded within the core classes, it's now possible and recommended to use the seperate debugging classes which you can modify like you want. Those classes inherit their associated core classes and can add some debugging stuff. This has the advantage of having a clean core code without any debugging stuff. If the debug classes are not used then they shall not be included and their code will not be initialized.
|
|
|
|
Item class.
|
|
shorthand syntax, you can abstract the Pagelet class and use your own extended class which is more flexible and will keep the BigPipe main classes as small as possible.
|
|
must now pass an existing Pagelet instance to the method!
|
|
implemented methods "enqueue" and "dequeue" for the new queueing mechanism. The "dequeue" method is currently unused but will be used in the future. The changes in this commit are partially preparations for further commits.
|
|
priority of the corresponding Pagelet instance.
|
|
display custom HTML content immediately while the pagelet is still processing.
|
|
"Stylesheet" and "Javascript" to make it more consistent with the other class names (instead of using the abbreviations).
|
|
"Stylesheet" and "Javascript" to make it more consistent with the other class names (instead of using the abbreviations).
|
|
|
|
dependencies (either with the instance of the dependency Pagelet or the unique ID as string as argument).
|
|
|
|
|
|
+ New classes have been added: "BigPipe\Resource", "BigPipe\Resource\CSS", "BigPipe\Resource\JS". If you wan't to add a resource to a Pagelet, you can now built a new resource object with the "CSS" or "JS" class (the "Resource" class is abstract and the parent class of "CSS" and "JS") and can add PhaseDoneJS callbacks for this resources with "Resource::addPhaseDoneJS()" similar to "Pagelet::addPhaseDoneJS()". To add the resource to your pagelet: "$Pagelet->addResource($Resource)". Of course, you can still use the two SHORT methods "Pagelet::addCSS()" and "Pagelet::addJS()" which needs only one parameter with the resource URL.
+ Each resource has now PhaseDoneJS callbacks for 3 phases (Object initializied [INIT], Loading started [LOAD], Loading complete [DONE]).
+ Check your usage of the PhaseDoneJS callback constants of the Pagelet class: These constants have been renamed.
+ Debugging mode: Just set BigPipe::debugging(TRUE) and each pagelet and resource will be pass through a function which adds PhaseDoneJS callbacks with debug informations (Look now at the Javascript console and enjoy the beautiful colors which makes the debug informations better readable for your eyes. \(o_o)/).
+ Several code improvements on almost all files.
|
|
+ All pagelets are now executed immediately on arrive.
+ A "Display Dependency" feature was added. If you give a pagelet an dependency, it will first be executed if all pagelets, who registered as dependency, are displayed.
+ If BigPipe.reset() is called, the function loops through each Resource and executes Resource.abortLoading(). This removes the <link> or <script> element from DOM and removes the onload callbacks. This is to prevent that an onload callback from a previous page are executed while the user has already changes the page asynchronously and a resource from the previous page wasn't already loaded.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|