PHPXRef 0.6 : Akelos Framework : Detail view of url

No description

Returns the URL for the set of +$options+ provided. This takes the same options
as url_for. For a list, see the documentation for AKActionController::urlFor.
Note that it'll set ('only_path' => true) so you'll get /controller/action instead of the
http://example.com/controller/action part (makes it harder to parse httpd log files)

modify_current_url($options_to_add = array() X-Ref

No description

link_to($name = null, $options = array() X-Ref

Creates a link tag of the given +name+ using an URL created by the set of +options+. See the valid options in
the documentation for ActionController::urlFor. It's also possible to pass a string instead of an array of options
to get a link tag that just points without consideration. If null is passed as a name, the link itself will become
the name.

The html_options has three special features. One for creating javascript confirm alerts where if you pass
'confirm' => 'Are you sure?', the link will be guarded with a JS popup asking that question.
If the user accepts, the link is processed, otherwise not.

Another for creating a popup window, which is done by either passing 'popup' with true or the options of the window in
Javascript form.

And a third for making the link do a POST request (instead of the regular GET) through a dynamically added form
element that is instantly submitted. Note that if the user has turned off Javascript, the request will fall back on
the GET. So its your responsibility to determine what the action should be once it arrives at the controller.
The POST form is turned on by passing 'post' as true. Note, it's not possible to use POST requests and popup targets
at the same time (an exception will be thrown).

Examples:
$url_helper->link_to('Delete this page', array('action' => 'destroy', 'id' => $page->id ), array('confirm' => 'Are you sure?'));
$url_helper->link_to('Help', array('action' => 'help'), array('popup' => true));
$url_helper->link_to('Busy loop', array('action' => 'busy'), array('popup' => array('new_window', 'height=300,width=600')));
$url_helper->link_to('Destroy account', array('action' => 'destroy'), array('confirm' => 'Are you sure?'), array('post' => true));

button_to($name, $options = array() X-Ref

Generates a form containing a sole button that submits to the
URL given by _$options_.  Use this method instead of +link_to+
for actions that do not have the safe HTTP GET semantics
implied by using a hypertext link.

The parameters are the same as for +link_to+.  Any _html_options_
that you pass will be applied to the inner +input+ element.
In particular, pass

'disabled' => true/false

as part of _html_options_ to control whether the button is
disabled.  The generated form element is given the class
'button-to', to which you can attach CSS styles for display
purposes.

Example 1:

// inside of controller for "feeds"
$url_helper->button_to('Edit', array('action' => 'edit', 'id' => 3));

Generates the following HTML (sans formatting):

<form method="post" action="/feeds/edit/3" class="button-to">
<div><input type="submit" value="Edit"  /></div>
</form>

Example 2:

$url_helper->button_to('Destroy', array('action' => 'destroy', 'id' => 3 , 'confirm' => 'Are you sure?'));

Generates the following HTML (sans formatting):

<form method="post" action="/feeds/destroy/3" class="button-to">
<div><input onclick="return confirm('Are you sure?');" value="Destroy" type="submit" /></div>
</form>

Note: This method generates HTML code that represents a form.
Forms are "block" content, which means that you should not try to
insert them into your HTML where only inline content is expected.
For example, you can legally insert a form inside of a <div> or
<td> element or in between <p> elements, but not in the middle of
a run of text, nor can you place a form within another form.
(Bottom line: Always validate your HTML before going public.)

link_to_unless_current($name, $options = array() X-Ref

Creates a link tag of the given +$name+ using an URL created by the set of +$options+, unless the current
request uri is the same as the link's, in which case only the name is returned.
This is useful for creating link bars where you don't want to link
to the page currently being viewed.

link_to_unless($condition, $name, $options = array() X-Ref

Create a link tag of the given +$name+ using an URL created by the set of +options+, unless +condition+
is true, in which case only the name is returned.

link_to_if($condition, $name, $options = array() X-Ref

Create a link tag of the given +name+ using an URL created by the set of +$options+, if +$condition+
is true, in which case only the name is returned.

current_page($options) X-Ref

Returns true if the current page uri is generated by the options passed (in url_for format).

mail_to($email_address, $name = null, $html_options = array() X-Ref

Creates a link tag for starting an email to the specified <tt>email_address</tt>, which is also used as the name of the
link unless +$name+ is specified. Additional HTML options, such as class or id, can be passed in the
<tt>$html_options</tt> array.

You can also make it difficult for spiders to harvest email address by obfuscating them.
Examples:
$url_helper->mail_to('me@domain.com', 'My email', array('encode' => 'javascript')) =>
<script type="text/javascript" language="javascript">eval(unescape('%64%6f%63%75%6d%65%6e%74%2e%77%72%69%74%65%28%27%3c%61%20%68%72%65%66%3d%22%6d%61%69%6c%74%6f%3a%6d%65%40%64%6f%6d%61%69%6e%2e%63%6f%6d%22%3e%4d%79%20%65%6d%61%69%6c%3c%2f%61%3e%27%29%3b'))</script>

$url_helper->mail_to('me@domain.com', 'My email', array('encode' => 'hex')) =>
<a href="mailto:%6d%65@%64%6f%6d%61%69%6e.%63%6f%6d">My email</a>

You can also specify the cc address, bcc address, subject, and body parts of the message header to create a complex e-mail
using the corresponding +cc+, +bcc+, +subject+, and +body+ <tt>html_options</tt> keys. Each of these options are URI escaped
and then appended to the <tt>email_address</tt> before being output. <b>Be aware that javascript keywords will not be
escaped and may break this feature when encoding with javascript.</b>

Examples:
$url_helper->mail_to("me@domain.com", "My email", array('cc' => "ccaddress@domain.com", 'bcc' => "bccaddress@domain.com", 'subject' => "This is an example email", 'body' => "This is the body of the message.")) # =>
<a href="mailto:me@domain.com?cc="ccaddress@domain.com"&bcc="bccaddress@domain.com"&body="This%20is%20the%20body%20of%20the%20message."&subject="This%20is%20an%20example%20email">My email</a>

convert_options_to_javascript(&$html_options) X-Ref

No description

_confirm_javascript_function($confirm) X-Ref

No description

_popup_javascript_function($popup) X-Ref

No description

_post_javascript_function() X-Ref

No description

_convert_boolean_attributes(&$html_options, $boolean_attributes) X-Ref

processes the _html_options_ array, converting the boolean
attributes from true/false form into the form required by
html/xhtml.  (an attribute is considered to be boolean if
its name is listed in the given _$boolean_attributes_ array.)

more specifically, for each boolean attribute in _$html_option_
given as:

"attr" => bool_value

if the associated _bool_value_ evaluates to true, it is
replaced with the attribute's name; otherwise the attribute is
removed from the _html_options_ array.  (see the xhtml 1.0 spec,
section 4.5 "attribute minimization" for more:
http://www.w3.org/tr/xhtml1/    *h-4.5)

returns the updated _$html_options_ array, which is also modified
in place.

example:

$url_helper->convert_boolean_attributes( $html_options,
array('checked','disabled','readonly' ) );

File Size:	371 lines (17 kb)
Included or required:	1 time
Referenced:	0 times
Includes or requires:	1 file AkActionView/helpers/javascript_helper.php

PHP Cross Reference of Akelos Framework

/AkActionView/helpers/ -> url_helper.php (summary)

Defines 1 class