Helpers¶

Usando Helpers¶

Você usa helpers no CakePHP criando-os dentro do controller. Cada controller tem uma propriedade $helpers que lista os helpers que estarão disponíveis na view. Para habilitar um helper na sua view, coloque o nome do helper dentro do array $helpers.

<?php
class BakeriesController extends AppController {
    var $helpers = array('Form', 'Html', 'Javascript', 'Time');
}
?>

Você pode adicionar um helper também dentro de sua action, então ele só estará disponível para essa determinada action e não estará disponível para as outras actions. Isso ajuda no processamento de potência para as outras ações que não usam o helper e a manter o controller melhor organizado.

<?php
class BakeriesController extends AppController {
    function bake {
        $this->helpers[] = 'Time';
    }
    function mix {
        // O helper Time não está disponivel para esta action.
    }
}
?>

Criando Helpers¶

Se os helpers já disponíveis por padrão no CakePHP (ou alguns dos outros disponíveis no Cakeforge ou no Bakery) não atenderem às suas necessidades, saiba que os helpers são fáceis de se criar.

Digamos, p.ex., que você queira criar um helper que possa ser usado para exibir um link especificamente estilizado com CSS e que você precisa exibir em vários locais de sua aplicação. Para fazer com que sua lógica corresponda a estrurura existente para helpers do CakePHP você vai precisar criar uma nova classe em /app/views/helpers. Vamos chamar nosso novo helper de LinkHelper. O arquivo autal da classe PHP deve ser algo parecido com isto:

<?php
/* /app/views/helpers/link.php */

class LinkHelper extends AppHelper {
    function makeEdit($title, $url) {
        // A lógica para criar um link especialmente formatado vai aqui...
    }
}

?>

Há uns poucos métodos incluídos na classe Helper do CakePHP e que você eventualmente possa querer utilizar:

output(string $string)

Utilize este método para manipular quaisquer dados de volta para sua view.

<?php
function makeEdit($title, $url) {
    // Usa o método de saída dos helpers para manipular
    // os dados formatados de volta para a view:
    return $this->output(
        "<div class=\"editOuter\">
         <a href=\"$url\" class=\"edit\">$title</a>
         </div>"
    );
}
?>

<?php
/* /app/views/helpers/link.php (using other helpers) */
class LinkHelper extends AppHelper {
    var $helpers = array('Html');

    function makeEdit($title, $url) {
        // Usa o HtmlHelper para exibir
        // dados formatados:

        $link = $this->Html->link($title, $url, array('class' => 'edit'));

        return $this->output("<div class=\"editOuter\">$link</div>");
    }
}
?>

<!-- faz um link utilizando o novo helper -->
<?php echo $link->makeEdit('Modifique esta Receita', '/recipes/edit/5') ?>

Criando Funcioanlidade para Todos os Helpers¶

Todos os helpers herdam de uma classe especial, AppHelper (tal como os models herdam de AppModel e os controllers de AppController). Para incluir uma nova funcionalidade que deva estar disponível para todos os helpers, crie o arquivo /app/app_helper.php.

<?php
class AppHelper extends Helper {
    function customMethod () {
    }
}
?>

Helpers Disponíveis por Padrão¶

O CakePHP já inclui alguns helpers que ajudam na criação de suas visões. Eles facilitam na criação de marcações bem-formadas (incluindo formulários), facilitam a formatação de textos, horários e números e ainda agilizam o desenvolvimento de funcionalidades com Ajax. Abaixo segue um resumo dos helpers já disponíveis no CakePHP por padrão. Para mais informações, não deixe de ler sobre os Core Helpers.