MCMS
[ class tree: MCMS ] [ index: MCMS ] [ all elements ]

Class: Component

Source Location: /lib/model/Component.php

Class Overview

PEAR
   |
   --Component

Interfaccia per la gestione degi componenti opzionali dei siti gestiti da MCMS.


Author(s):

Version:

  • 2

Methods


Child classes:

sitemap
Classe per la creazione della mappa di un sito gestito da MCMS.
rss
Classe per l'aggiunta di un feed RSS 2 al sito.
search
Classe per la creazione della mappa di un sito gestito da MCMS.

Class Details

[line 56]
Interfaccia per la gestione degi componenti opzionali dei siti gestiti da MCMS.

Classe astratta che descrive i metodi obbligatori che devono essere implementati da qualsiasi componente opzionale per Component. NOTE IMPORTANTI SULLA COSTRUZIONE DEI COMPONENTI: Ogni componente dovrà estendere questa classe e dovrà essere memorizzato in un file con lo stesso nome della classe. Inoltre tale file deve essere salvato nella cartella Components, altrimenti MCMS non riuscirà a integrarlo correttamente. I nomi dei componenti devono essere univoci, e in sole lettere minuscole.




Tags:

author:  Silvio Moioli <at moioli dot net silvio at moioli dot net>
version:  2


[ Top ]


Class Methods


constructor Component [line 62]

Component Component( )

Costruttore di default.



[ Top ]

method applyComponent [line 108]

void applyComponent( &$contents, &$menuEntries, &$title, &$description, Site $site, string $contents, array $menuEntries, string $title, string $description)

Questo metodo è "astratto" pertanto dovrebbe essere implementato da tutte le classi che estendono questa classe.

Applica questo componente alla pagina corrente apportando modifiche ai contenuti, al menu e al titolo.




Overridden in child classes as:

sitemap::applyComponent()
Aggiunge la voce di menu per la mappa del sito (a tutte le pagine).
rss::applyComponent()
Aggiunge la voce di menu per la mappa del sito (a tutte le pagine).
search::applyComponent()
Aggiunge la voce di menu per la mappa del sito (a tutte le pagine).

Parameters:

string   $contents   i contenuti della pagina da modificare
array   $menuEntries   il menu della pagina
string   $title   il titolo della pagina da modificare
string   $description   la descrizione della pagina da modificare
Site   $site   il sito corrente
   &$contents  
   &$menuEntries  
   &$title  
   &$description  

[ Top ]

method getName [line 74]

string getName( )

Questo metodo è "astratto" pertanto dovrebbe essere implementato da tutte le classi che estendono questa classe.

Ritorna il nome di questo componente.




Tags:

return:  il nome del componente


Overridden in child classes as:

sitemap::getName()
Ritorna il nome di questo componente.
rss::getName()
Ritorna il nome di questo componente.
search::getName()
Ritorna il nome di questo componente.

[ Top ]

method init [line 91]

void init( Engine $engine)

Questo metodo è "astratto" pertanto dovrebbe essere implementato da tutte le classi che estendono questa classe.

Inizializza il componente. Questo metodo viene richiamato da Engine quando vengono create le tabelle del DB per MCMS. Se il componente ha bisogno di tabelle permanenti proprie per il suo funzionamento, dovrebbe crearle all'interno di questo metodo. Il parametro $engine sarà fornito dal sistema per poter interagire con il database.




Overridden in child classes as:

sitemap::init()
Questo componente non ha bisogno di inizializzazione, perciò questo metodo è vuoto.
rss::init()
Questo componente non ha bisogno di inizializzazione, perciò questo metodo è vuoto.
search::init()
Questo componente non ha bisogno di inizializzazione, perciò questo metodo è vuoto.

Parameters:

Engine   $engine   il motore di MCMS

[ Top ]

method saveFiles [line 124]

void saveFiles( Site $site, Compiler $compiler)

Questo metodo è "astratto" pertanto dovrebbe essere implementato da tutte le classi che estendono questa classe.

Se il plugin deve creare o aggiornare dei propri file, può farlo qui. Questo metodo viene richiamato ad ogni modifica di ogni sito, e viene passata un'istanza di Compiler per il salvataggio dei file.




Overridden in child classes as:

sitemap::saveFiles()
Salva la pagina XHTML della mappa del sito.
rss::saveFiles()
Salva il feed RSS 2.0 del sito
search::saveFiles()
Questo componente non ha file esterni da salvare

Parameters:

Site   $site   il sito corrente
Compiler   $compiler   l'oggetto per il salvataggio dei file

[ Top ]


Documentation generated on Wed, 26 Jul 2006 21:44:52 +0200 by phpDocumentor 1.3.0RC6