Table des matières

Action

Description : Class representing pages, variables sended to templates and allows to manage scripts, css, etc.
Php : 5.3
Implements : ArrayAccess, Iterator, Countable
Category : Routing
Package : Core
Author : Tavm@n <tavman@gmail.com>
License : http://creativecommons.org/licenses/by-nc/2.0/
Link : none
See : All
Version : I-Radian v2.0.alpha 1
Since : 2010/01/27


Haut de page

setTitle

Description : Sets page title.
Signature : public static function setTitle ($sTitle)
Param : $sTitle (String) : Page title.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
        {
            
Action::setTitle('Accueil du site');
        }
}

Haut de page

getTitle

Description : Page title accessor.
Signature : public static function getTitle ()
Return : String Page title.
Usage :


<?php echo Action::getTitle() ?>


Haut de page

getHTML_TITLE

Description : Tag TITLE accessor.
Signature : public static function getHTML_TITLE ()
Return : String Tag TITLE
Usage :


<html>
<head>
<?php echo Action::getHTML_TITLE() ?>
</head>
<body>
[...]
</body>
</html>

Haut de page

setBase

Description : Sets base link to the page.
Signature : public static function setBase ($sBase)
Param : $sBase (String) : Base link.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::setBase('http://localhost/monsite/');
    }
}

Haut de page

getBase

Description : Base link to the page accessor.
Signature : public static function getBase ()
Return : String Base link.
Usage :


<?php echo Action::getBase() ?>


Haut de page

getHTML_BASE

Description : Tag BASE accessor.
Signature : public static function getHTML_BASE ()
Return : String Tag BASE.
Usage :


<html>
<head>
<?php echo Action::getHTML_BASE() ?>
</head>
<body>
[...]
</body>
</html>

Haut de page

setMeta

Description : Sets metatags.
Signature : public static function setMeta ($aMeta)
Param : $aMeta (Array) : Metatags list
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::setMeta(array('name' => array(
            
'autor' => 'I-Radian'
        
)));
    }
}

Haut de page

getMeta

Description : Metatags accessor.
Signature : public static function getMeta ()
Return : Array Metatags list.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        echo
'<pre>';print_r(Action::getMeta());echo'</pre>';
    }
}

Haut de page

addMeta

Description : Add a metatag.
Signature : public static function addMeta ($sName, $sContent, $sType='name')
Param : $sName (String) : Metatag name
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::addMeta('autor''I-Radian');
    }
}

Haut de page

getHTML_META

Description : Tags META accessor.
Signature : public static function getHTML_META ()
Return : String Tags META.
Usage :


<html>
<head>
<?php echo Action::getHTML_META() ?>
</head>
<body>
[...]
</body>
</html>

Haut de page

setJavascript

Description : Sets scripts files list.
Signature : public static function setJavascript ($aJavascript)
Param : $aJavascript (Array) : Scripts files list.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::setJavascript(array(
            
'fichier_1.js',
            
'fichier_2.js',
            
'fichier_3.js',
        ));
    }
}

Haut de page

getHTML_SCRIPT

Description : Scripts files list tags accessor.
Signature : public static function getHTML_SCRIPT ()
Return : String Scripts tags.
Usage :


<html>
<head>
<?php echo Action::getHTML_SCRIPT() ?>
</head>
<body>
[...]
</body>
</html>

Haut de page

getJavascript

Description : Scripts files list accessor.
Signature : public static function getJavascript ()
Return : Array Scripts files list.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        echo
'<pre>';print_r(Action::getJavascript());echo'</pre>';
    }
}

Haut de page

addJavascript

Description : Add a script file.
Signature : public static function addJavascript ($sSrc, $sType='text/javascript')
Param : $sSrc (String) : Script file link.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::addJavascript('fichier_js.js');
    }
}

Haut de page

setCSS

Description : Sets style files list.
Signature : public static function setCSS ($aCSS)
Param : $aCSS (Array) : Style files list.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::setCSS(array(
            
'fichier_1.css',
            
'fichier_2.css',
            
'fichier_3.css',
        ));
    }
}

Haut de page

getCSS

Description : Style files list accessor.
Signature : public static function getCSS ()
Return : Array Style files list.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        echo
'<pre>';print_r(Action::getCSS());echo'</pre>';
    }
}

Haut de page

addCSS

Description : Add a style file.
Signature : public static function addCSS ($sHref)
Param : $sHref (String) : Style file link.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::addCSS('fichier_css.css');
    }
}

Haut de page

getHTML_CSS

Description : Style files tags accessor.
Signature : public static function getHTML_CSS ()
Return : String Style files tags.
Usage :


<html>
<head>
<?php echo Action::getHTML_CSS() ?>
</head>
<body>
[...]
</body>
</html>

Haut de page

addInternalJavascript

Description : Add a page internal script.
Signature : public static function addInternalJavascript ($sScript, $sType='text/javascript')
Param : $sScript (String) : Script content.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
$sScript = <<<SCRIPT_TEXT
alert('toto');
SCRIPT_TEXT;
        
Action::addInternalJavascript($sScript);
    }
}

Haut de page

getHTMLInternalJavascript

Description : Page internal scripts accessor (footer, etc.).
Signature : public static function getHTMLInternalJavascript ()
Return : String Le script interne a la page
Usage :


<?php echo Action::getHTMLInternalJavascript(); ?>


Haut de page

addAfterHTML

Description : Add HTML code after the page.
Signature : public static function addAfterHTML ($sAfterHTML)
Param : $sAfterHTML (String) : HTML code.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::addAfterHTML('<div class="footer">Footer</div>');
    }
}

Haut de page

getAfterHTML

Description : After page HTML code accessor.
Signature : public static function getAfterHTML ()
Return : String Code HTML a ajouter
Usage :


<?php echo Action::getAfterHTML() ?>


Haut de page

Description : Create a relative link from the actual page to a other (page, file etc.)
Signature : public static function makeDirectLink ($sLinkTo)
Param : $sLinkTo (String) : Absolut link.
Return : String Relative link.
Note : It is important to use this methode for create internals links, images, script or css files.
Usage :


<a href="<?php Action::makeDirectLink(HTML_ROOT_PATH .'site/action/method'?> alt="link">Lien</a>

Haut de page

setTemplateClass

Description : Define the template class used.
Signature : public static function setTemplateClass ( $sTemplateclass )
Param : $sTemplateclass (String) : Template class.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::setTemplateClass('TemplateClass');
    }
}

Haut de page

getTemplateClass

Description : Template class accessor.
Signature : public static function getTemplateClass ()
Return : String Nom de la classe de templating
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
$sTempClass Action::getTemplateClass();
        
$oTemplate = new $sTempClass();
    }
}

Haut de page

helper

Description : Load a helper file.
Version : I-Radian v2.0.beta
Since : 2010/10/05
Signature : public static function helper ($sFile)
Param : $sFile (String) : Helper name.
Return : String Results of the include.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::helper('url');
    }
}

Haut de page

helpers

Description : Load a list of helpers.
Version : I-Radian v2.0.beta
Since : 2010/10/05
Signature : public static function helpers ($aFile)
Param : $aFile (Array) : Helpers list.
Return : String List of includes.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::helpers(array('url''partial'));
    }
}

Haut de page

getActualAction

Description : Actual action accessor.
Version : I-Radian v2.0.beta
Since : 2010/10/05
Signature : public static function getActualAction ()
Return : Object Actual action.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        echo 
Action::getActualAction();
    }
}

Haut de page

run

Description : Execute an action.
Signature : public function run ($bIsRedirection=false)
Param : [$bIsRedirection=false] (Bool) : TRUE when the action is a redirection, else FALSE (default: FAlSE).
Updated : 2010/02/03 Tavm@n <tavman@gmail.com> Vue dev / files developpeur.
Usage :


<?php
$oAction 
= new Action();
$oAction->run();

Haut de page

setLayout

Description : Sets the layout.
Signature : public function setLayout ($sLayout)
Param : $sLayout (String) : Template layout name.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
$this->setLayout('popup_layout');
        
// OR
        
$this->setLayout(null); // for no layout (using for AJAX).
    
}
}

Haut de page

getLayout

Description : Action layout accessor.
Signature : public function getLayout ()
Return : String Layout template name.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
// [...]
        
if ( Action::getLayout()==null ) {
            exit;
        }
    }
}

Haut de page

setTpl

Description : Sets the action template.
Version : I-Radian v2.0.beta 1
Since : 2010/08/31
Signature : public function setTpl ($sTpl)
Param : $sTpl (String) : Action template name.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
$this->setTpl('any_template_in_the_action_path');
    }
}

Haut de page

getTpl

Description : Action template accessor.
Version : I-Radian v2.0.beta 1
Since : 2010/08/31
Signature : public function getTpl ()
Return : String Action template name.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        echo 
Action::getTpl();
    }
}

Haut de page

setTplObject

Description : Sets the action template object.
Version : I-Radian v2.0.beta 1
Since : 2010/08/31
Signature : public function setTplObject ($oTpl)
Param : $oTpl (Object) : Action template object.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
$oTemplate = new TemplateClass();
        
$this->setTplObject$oTemplate );
    }
}

Haut de page

getTplObject

Description : Action template object accessor.
Version : I-Radian v2.0.beta 1
Since : 2010/08/31
Signature : public function getTplObject ()
Return : Object Action template object.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
$oTemplate $this->getTplObject();
        
$oTemplate->setVars(array(
            [...]
        ));
    }
}

Haut de page

getTemplateVars

Description : Action template variables accessor.
Signature : public function getTemplateVars ()
Return : Array List of Action template variables.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
Action::setTitle('Accueil du site');
    }
}

Haut de page

redirect

Description : Redirect actual action to another.
Signature : public function redirect ($sAction, $sMethod)
Param : $sAction (String) : Action.
Usage :


<?php
class AccueilAction extends Action
{
    public function 
doindex ($aParams=array())
    {
        
$this->redirect('action''method');
    }
}