Commit efed3b6e authored by Taylor Otwell's avatar Taylor Otwell

added comments to html class.

parent 122dff97
...@@ -16,7 +16,15 @@ class HTML { ...@@ -16,7 +16,15 @@ class HTML {
} }
/** /**
* Generate a JavaScript reference. * Generate a link to a JavaScript file.
*
* <code>
* // Generate a link to a JavaScript file
* echo HTML::script('js/jquery.js');
*
* // Generate a link to a JavaScript file and add some attributes
* echo HTML::script('js/jquery.js', array('defer'));
* </code>
* *
* @param string $url * @param string $url
* @param array $attributes * @param array $attributes
...@@ -30,10 +38,18 @@ class HTML { ...@@ -30,10 +38,18 @@ class HTML {
} }
/** /**
* Generate a CSS reference. * Generate a link to a CSS file.
* *
* If no media type is selected, "all" will be used. * If no media type is selected, "all" will be used.
* *
* <code>
* // Generate a link to a CSS file
* echo HTML::style('css/common.css');
*
* // Generate a link to a CSS file and add some attributes
* echo HTML::style('css/common.css', array('media' => 'print'));
* </code>
*
* @param string $url * @param string $url
* @param array $attributes * @param array $attributes
* @return string * @return string
...@@ -62,6 +78,14 @@ class HTML { ...@@ -62,6 +78,14 @@ class HTML {
/** /**
* Generate a HTML link. * Generate a HTML link.
* *
* <code>
* // Generate a link to a location within the application
* echo HTML::link('user/profile', 'User Profile');
*
* // Generate a link to a location outside of the application
* echo HTML::link('http://google.com', 'Google');
* </code>
*
* @param string $url * @param string $url
* @param string $title * @param string $title
* @param array $attributes * @param array $attributes
...@@ -122,6 +146,14 @@ class HTML { ...@@ -122,6 +146,14 @@ class HTML {
* *
* An array of parameters may be specified to fill in URI segment wildcards. * An array of parameters may be specified to fill in URI segment wildcards.
* *
* <code>
* // Generate a link to the "profile" named route
* echo HTML::link_to_route('profile', 'Profile');
*
* // Generate a link to the "profile" route and add some parameters
* echo HTML::link_to_route('profile', 'Profile', array('taylor'));
* </code>
*
* @param string $name * @param string $name
* @param string $title * @param string $title
* @param array $parameters * @param array $parameters
...@@ -248,7 +280,7 @@ class HTML { ...@@ -248,7 +280,7 @@ class HTML {
{ {
$html = array(); $html = array();
foreach ($attributes as $key => $value) foreach ((array) $attributes as $key => $value)
{ {
// Assume numeric-keyed attributes to have the same key and value. // Assume numeric-keyed attributes to have the same key and value.
// Example: required="required", autofocus="autofocus", etc. // Example: required="required", autofocus="autofocus", etc.
...@@ -269,7 +301,7 @@ class HTML { ...@@ -269,7 +301,7 @@ class HTML {
* @param string $value * @param string $value
* @return string * @return string
*/ */
public static function obfuscate($value) protected static function obfuscate($value)
{ {
$safe = ''; $safe = '';
...@@ -300,6 +332,17 @@ class HTML { ...@@ -300,6 +332,17 @@ class HTML {
* Magic Method for handling dynamic static methods. * Magic Method for handling dynamic static methods.
* *
* This method primarily handles dynamic calls to create links to named routes. * This method primarily handles dynamic calls to create links to named routes.
*
* <code>
* // Generate a link to the "profile" named route
* echo HTML::link_to_profile('Profile');
*
* // Generate a link to the "profile" route and add some parameters
* echo HTML::link_to_profile('Profile', array('taylor'));
*
* // Generate a link to the "profile" named route using HTTPS
* echo HTML::link_to_secure_profile('Profile');
* </code>
*/ */
public static function __callStatic($method, $parameters) public static function __callStatic($method, $parameters)
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment