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

Class: Site

Source Location: /lib/model/Site.php

Class Overview

PEAR
   |
   --Site

Interfaccia per la gestione dei siti gestiti da MCMS.


Author(s):

Version:

  • 2

Variables

Methods



Class Details

[line 65]
Interfaccia per la gestione dei siti gestiti da MCMS.

Permette di gestire un sito con tutto il suo contenuto informativo in maniera trasparente rispetto al Database sottostante.




Tags:

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


[ Top ]


Class Variables

$engine =  NULL

[line 75]



Tags:

var:  il motore del database sottostante per questo sito.

Type:   Engine


[ Top ]

$ID =  0

[line 71]



Tags:

var:  ID del database sottostante per questo sito.

Type:   int


[ Top ]



Class Methods


constructor Site [line 95]

mixed Site( int $ID, Engine $engine)

Costruttore di lettura

Costruttore "di lettura" (costruisce un sito da un record del database già esistente). Nota: non può essere creato una nuovo sito da qui, ma solo dal Factory Method nella classe Engine. Per i costruttori "di scrittura", quindi, vedere la classe Engine nel file Engine.php.




Tags:

return:  la pagina se la costruzione è andata a buon fine, altrimenti un PEAR_Error
see:  Engine


Parameters:

int   $ID   l'ID del database sottostante
Engine   $engine   un motore per interagire con il database sottostante

[ Top ]

method addArticle [line 355]

mixed addArticle( Author $author, string $contents, string $title, string $keywords, Category $category, string $description, array $correlatedArticles)

Aggiunge un articolo agli articoli memorizzati in questo Database (Factory Method).

Crea un nuovo articolo e lo memorizza nel Database sottostante. Questo è l'unico modo per creare un articolo!




Tags:

return:  l'articolo se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Category
see:  Article
see:  Author


Parameters:

Author   $author   l'autore dell'articolo.
string   $contents   il contenuto HTML di questa pagina.
string   $title   il titolo di questa pagina.
string   $keywords   l'elenco separato da virgole e spazi (per esempio "case, amici") delle parole chiave della pagina.
Category   $category   la categoria di appartenenza di questo articolo
string   $description   una breve descrizione dei contenuti
array   $correlatedArticles   un array di Article correlati a questo articolo

[ Top ]

method addCategory [line 530]

mixed addCategory( string $name, string $description)

Aggiunge una categoria alle categorie memorizzate in questo Database (Factory Method).

Crea una nuova categoria e la memorizza nel Database sottostante. Questo è l'unico modo per creare un categoria!




Tags:

return:  la categoria se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Category


Parameters:

string   $name   il nome della categoria
string   $description   breve descrizione del tipo di articoli nella categoria

[ Top ]

method addNews [line 191]

mixed addNews( Author $author, string $contents, string $title, string $keywords, string $source, array $correlatedArticles)

Aggiunge una notizia alle notizie memorizzate in questo Database (Factory Method).

Crea una nuova notizia e la memorizza nel Database sottostante. Questo è l'unico modo per creare un notizia!




Tags:

return:  la notizia se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Article
see:  News
see:  Author


Parameters:

Author   $author   l'autore della notizia (di questo sito)
string   $contents   il contenuto HTML di questa pagina.
string   $title   il titolo di questa pagina.
string   $keywords   l'elenco separato da virgole e spazi (per esempio "case, amici") delle parole chiave della pagina.
string   $source   l'URL della fonte principale di questa notizia o NULL
array   $correlatedArticles   un array di Article correlati a questo articolo.

[ Top ]

method addPage [line 766]

mixed addPage( Author $author, string $contents, string $title, string $keywords)

Aggiunge una pagina alle quelle memorizzate in questo Database (Factory Method).

Crea una nuova pagina e la memorizza nel Database sottostante. Questo è l'unico modo per creare un pagina! Questo metodo dovrebbe essere invocato SOLO dalle classi interne di MCMS, per la costruzione di Articoli, Notizie e Homepages.




Tags:

return:  la pagina se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Page
access:  private


Parameters:

Author   $author   l'autore della nuova pagina
string   $contents   il contenuto HTML della pagina
string   $title   il titolo della pagina
string   $keywords   l'elenco separato da virgole e spazi (per esempio "case, amici") delle parole chiave della pagina.

[ Top ]

method changeComponents [line 614]

mixed changeComponents( array $components)

Sostituisce i componenti attivati in questo sito con quelli specificati nell'array passato.



Tags:

return:  true se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Component


Parameters:

array   $components   i componenti aggiuntivi.

[ Top ]

method dropAllNews [line 262]

mixed dropAllNews( )

Cancella tutte le notizie di questo sito.

Cancella tutte le notizie memorizzate nel Database sottostante, per questo sito, incluso tutto il suo contenuto.




Tags:

return:  true se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  News


[ Top ]

method dropArticle [line 397]

mixed dropArticle( Article $article)

Cancella uno degli articoli tra quelli memorizzati in questo Database.

Cancella un articolo memorizzato nel Database sottostante, incluso tutto il suo contenuto.




Tags:

return:  true se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Article


Parameters:

Article   $article   l'articolo da cancellare.

[ Top ]

method dropArticles [line 431]

mixed dropArticles( )

Cancella tutti gli articoli di questo sito.

Cancella tutti gli articoli memorizzati nel Database sottostante per questo sito, incluso tutto il loro contenuto.




Tags:

return:  true se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Article


[ Top ]

method dropCategory [line 561]

mixed dropCategory( Category $category)

Cancella una delle categorie tra quelle memorizzate in questo Database.

Cancella una categoria memorizzata nel Database sottostante, inclusi tutti gli articoli in essa contenuti.




Tags:

return:  true se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Category


Parameters:

Category   $category   la categoria da cancellare.

[ Top ]

method dropNews [line 230]

mixed dropNews( News $news)

Cancella una delle notizie tra quelle memorizzate in questo Database.

Cancella una notizia memorizzata nel Database sottostante, incluso tutto il suo contenuto.




Tags:

return:  true se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  News


Parameters:

News   $news   la notizia da cancellare.

[ Top ]

method dropPage [line 804]

mixed dropPage( Page $page)

Cancella una delle pagine memorizzate in questo Database.

Cancella una pagina memorizzata nel Database sottostante, con tutto il suo contenuto informativo. ATTENZIONE: questo NON elimina l'articolo, la notizia o l'homepage associata!




Tags:

return:  true se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Page
access:  private


Parameters:

Page   $page   la pagina da cancellare.

[ Top ]

method dropPages [line 830]

mixed dropPages( )

Cancella le pagine di questo sito.

Cancella tutte le pagine memorizzate per questo sito, inclusi articoli, notizie e homepage. Questo metodo dovrebbe essere chiamato solo da un metodo che cancella anche questo sito.




Tags:

return:  true se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Page
access:  private


[ Top ]

method getArticles [line 306]

mixed getArticles( )

Ritorna gli articoli memorizzati in questo Database.

Ritorna un array contenente gli oggetti corrispondenti a tutti gli articoli contenuti in questo Database per questo sito.




Tags:

return:  un array contenente gli articoli in questo Database se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Article


[ Top ]

method getAuthor [line 872]

Author getAuthor( )

Ritorna l'autore fondatore di questo sito.

Ritorna un oggetto corrispondente all'autore principale di questo sito Permette di utilizzare il database in modo trasparente (è come se si usassero normali attributi di una classe).




Tags:

return:  l'autore a cui questa pagina appartiene.
see:  Author


[ Top ]

method getAuthors [line 898]

mixed getAuthors( )

Ritorna gli autori di questo sito.

Ritorna un array contenente gli autori di questo sito contenuti in questo Database.




Tags:

return:  un array contenente i siti in questo Database se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Author


[ Top ]

method getCategories [line 483]

mixed getCategories( )

Ritorna tutte le categorie di questo sito.

Ritorna un array contenente tutte le categorie del sito.




Tags:

return:  un array contenente le categorie (Category) se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Category


[ Top ]

method getCategoriesCount [line 505]

int getCategoriesCount( )

Ritorna il numero di categorie di questo sito.



Tags:

return:  il numero di categorie
see:  Category


[ Top ]

method getComponents [line 586]

mixed getComponents( )

Ritorna i componenti utilizzati in questo sito.

Ritorna un array contenente gli oggetti corrispondenti a tutti i componenti utilizzati in questo sito.




Tags:

return:  un array contenente gli componenti idi questo sito se l'operazione è andata a buon fine, altrimenti un DB_ERROR
see:  Component


[ Top ]

method getEngine [line 127]

int getEngine( )

Ritorna il motore sottostante a questo sito.

Solo le classi del package MCMS potrebbero avere bisogno di questo parametro, per le interrogazioni al Database.




Tags:

return:  l'ID del database sottostante
access:  protected


[ Top ]

method getHomepage [line 714]

mixed getHomepage( )

Getter per il campo Homepage dalla tabella Sito.

Ritorna l'homepage del sito.




Tags:

return:  l'homepage del sito (Homepage) se l'operazione è andata a buon fine, altrimenti un DB_ERROR


[ Top ]

method getID [line 113]

int getID( )

Ritorna l'ID di questo sito.

Solo le classi del package MCMS potrebbero avere bisogno di questo parametro, per le interrogazioni al Database.




Tags:

return:  l'ID del database sottostante
access:  protected


[ Top ]

method getNews [line 144]

mixed getNews( Category 0)

Ritorna le notizie memorizzate in questo Database.

Ritorna un array contenente gli oggetti corrispondenti a tutte le notizie contenute in questo Database per questo sito.




Tags:

return:  un array contenente le notizie in questo Database se l'operazione è andata a buon fine, altrimenti un DB_ERROR.
see:  News


Parameters:

Category   0   la categoria delle notizie da ritornare o NULL per tutte indistintamente.

[ Top ]

method getShortURL [line 666]

mixed getShortURL( )

Ritorna una versione "corta" dell'URL del sito.

Ritorna una versione "corta" dell'URL del sito, rimuovendo il protocollo ("http://"), l'host www se presente e tutto ciò che segue la prima barra rovesciata, se presente. Ad esempio dall'URL "http://www.moioli.net/index.html" si ottiene "moioli.net".




Tags:

return:  l'URL corta del sito (string) se l'operazione è andata a buon fine, un DB_ERROR se c'è un problema nel DB o l'URL completo se è impossibile accorciarlo ulteriormente


[ Top ]

method getURL [line 642]

mixed getURL( )

Getter per il campo URL dalla tabella Sito.

Ritorna l'URL di accesso alla homepage del sito.




Tags:

return:  l'URL del sito (string) se l'operazione è andata a buon fine, altrimenti un DB_ERROR


[ Top ]

method setURL [line 692]

mixed setURL( string $URL)

Setter per il campo URL dalla tabella Sito.

Cambia l'URL di accesso alla homepage del sito.




Tags:

return:  true se l'operazione è andata a buon fine, altrimenti un DB_ERROR


Parameters:

string   $URL   il nuovo URL del sito

[ Top ]


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