Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
S
syncEnrollments
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Yeray Santana Hualde
syncEnrollments
Commits
3ac22873
Commit
3ac22873
authored
Aug 14, 2011
by
Taylor Otwell
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
fixing API comments.
parent
ee373db5
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
31 additions
and
32 deletions
+31
-32
arr.php
system/arr.php
+4
-4
asset.php
system/asset.php
+18
-19
auth.php
system/auth.php
+9
-9
No files found.
system/arr.php
View file @
3ac22873
...
@@ -10,11 +10,11 @@ class Arr {
...
@@ -10,11 +10,11 @@ class Arr {
* in multiple arrays is also supported.
* in multiple arrays is also supported.
*
*
* <code>
* <code>
*
// Returns "taylor"
*
// Returns "taylor"
*
$item = Arr::get(array('name' => 'taylor'), 'name', $default);
*
$item = Arr::get(array('name' => 'taylor'), 'name', $default);
*
*
*
// Returns "taylor"
*
// Returns "taylor"
*
$item = Arr::get(array('name' => array('is' => 'taylor')), 'name.is');
*
$item = Arr::get(array('name' => array('is' => 'taylor')), 'name.is');
* </code>
* </code>
*
*
* @param array $array
* @param array $array
...
...
system/asset.php
View file @
3ac22873
...
@@ -21,14 +21,14 @@ class Asset {
...
@@ -21,14 +21,14 @@ class Asset {
* expressive code and a clean API.
* expressive code and a clean API.
*
*
* <code>
* <code>
*
// Get the default asset container
*
// Get the default asset container
*
$container = Asset::container();
*
$container = Asset::container();
*
*
*
// Get the "footer" asset contanier
*
// Get the "footer" asset contanier
*
$container = Asset::container('footer');
*
$container = Asset::container('footer');
*
*
*
// Add an asset to the "footer" container
*
// Add an asset to the "footer" container
*
Asset::container('footer')->add('jquery', 'js/jquery.js');
*
Asset::container('footer')->add('jquery', 'js/jquery.js');
* </code>
* </code>
*
*
* @param string $container
* @param string $container
...
@@ -46,14 +46,13 @@ class Asset {
...
@@ -46,14 +46,13 @@ class Asset {
/**
/**
* Magic Method for calling methods on the default Asset container.
* Magic Method for calling methods on the default Asset container.
* This allows a convenient API for working with the default container.
*
*
* <code>
* <code>
*
// Add jQuery to the default container
*
// Add jQuery to the default container
*
Asset::script('jquery', 'js/jquery.js');
*
Asset::script('jquery', 'js/jquery.js');
*
*
*
// Equivalent call using the container method
*
// Equivalent call using the container method
*
Asset::container()->script('jquery', 'js/jquery.js');
*
Asset::container()->script('jquery', 'js/jquery.js');
* </code>
* </code>
*/
*/
public
static
function
__callStatic
(
$method
,
$parameters
)
public
static
function
__callStatic
(
$method
,
$parameters
)
...
@@ -98,8 +97,8 @@ class Asset_Container {
...
@@ -98,8 +97,8 @@ class Asset_Container {
* extension, you may use the style or script methods to register assets.
* extension, you may use the style or script methods to register assets.
*
*
* <code>
* <code>
*
// Register a jQuery asset
*
// Register a jQuery asset
*
Asset::add('jquery', 'js/jquery.js');
*
Asset::add('jquery', 'js/jquery.js');
* </code>
* </code>
*
*
* You may also specify asset dependencies. This will instruct the class to
* You may also specify asset dependencies. This will instruct the class to
...
@@ -107,11 +106,11 @@ class Asset_Container {
...
@@ -107,11 +106,11 @@ class Asset_Container {
* For example, you may wish to make jQuery UI dependent on jQuery.
* For example, you may wish to make jQuery UI dependent on jQuery.
*
*
* <code>
* <code>
*
// Register jQuery UI as dependent on jQuery
*
// Register jQuery UI as dependent on jQuery
*
Asset::add('jquery-ui', 'js/jquery-ui.js', 'jquery');
*
Asset::add('jquery-ui', 'js/jquery-ui.js', 'jquery');
*
*
*
// Register jQuery UI with multiple dependencies
*
// Register jQuery UI with multiple dependencies
*
Asset::add('jquery-ui', 'js/jquery-ui.js', array('jquery', 'fader'));
*
Asset::add('jquery-ui', 'js/jquery-ui.js', array('jquery', 'fader'));
* </code>
* </code>
*
*
* @param string $name
* @param string $name
...
@@ -227,7 +226,7 @@ class Asset_Container {
...
@@ -227,7 +226,7 @@ class Asset_Container {
* Get the link to a single registered CSS asset.
* Get the link to a single registered CSS asset.
*
*
* <code>
* <code>
*
echo $container->get_style('common');
*
echo $container->get_style('common');
* </code>
* </code>
*
*
* @param string $name
* @param string $name
...
@@ -242,7 +241,7 @@ class Asset_Container {
...
@@ -242,7 +241,7 @@ class Asset_Container {
* Get the link to a single registered JavaScript asset.
* Get the link to a single registered JavaScript asset.
*
*
* <code>
* <code>
*
echo $container->get_script('jquery');
*
echo $container->get_script('jquery');
* </code>
* </code>
*
*
* @param string $name
* @param string $name
...
...
system/auth.php
View file @
3ac22873
...
@@ -31,10 +31,10 @@ class Auth {
...
@@ -31,10 +31,10 @@ class Auth {
* Determine if the current user of the application is authenticated.
* Determine if the current user of the application is authenticated.
*
*
* <code>
* <code>
*
if (Auth::check())
*
if (Auth::check())
*
{
*
{
* // The user is logged in...
*
// The user is logged in...
*
}
*
}
* </code>
* </code>
*
*
* @return bool
* @return bool
...
@@ -53,7 +53,7 @@ class Auth {
...
@@ -53,7 +53,7 @@ class Auth {
* of the closure will be cached and returned.
* of the closure will be cached and returned.
*
*
* <code>
* <code>
*
$email = Auth::user()->email;
*
$email = Auth::user()->email;
* </code>
* </code>
*
*
* @return object
* @return object
...
@@ -79,10 +79,10 @@ class Auth {
...
@@ -79,10 +79,10 @@ class Auth {
* by the Hash class when authenticating.
* by the Hash class when authenticating.
*
*
* <code>
* <code>
*
if (Auth::login('test@gmail.com', 'secret'))
*
if (Auth::login('test@gmail.com', 'secret'))
*
{
*
{
* // The credentials are valid...
*
// The credentials are valid...
*
}
*
}
* </code>
* </code>
*
*
* @param string $username
* @param string $username
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment