Documentation

FontOption extends SelectOption
in package

contrexx

class FontOption

Properties

$activeChoice : string: The text value of the option.
$choice : array<string|int, mixed>
$fonts : array<string|int, mixed>: List with Google Fonts
$humanName : string: The translated name of the option. If the active language isn't available english is used as a fallback. If this also isn't available the name of the option is used.
$localeCodes : array<string|int, mixed>: List of locale codes ordered by translation fallback order per Cx instance
$name : void: The identifying name of the option.
$nestingCount : int: Counts the nesting level of __call()
$stringRepresentationBlank : bool: Whether blank string representations are valid
$stringRepresentationFields : array<string|int, mixed>: List of fields that should be available in the string representation
$stringRepresentationFormat : string: Sprintf format for the string representation
$translations : array<string|int, mixed>: Array with translations for all available languages.
$validators : array<string|int, mixed>: Initialize this array as follows: array( 'columName' => Zend_Validate )
$virtual : bool: Defines if an entity is virtual and therefore not persistable.

Methods

__call() : mixed: Route methods like getName(), getType(), getDirectory(), etc.
__construct() : mixed
__get() : mixed: This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
__toString() : string: Returns this entity's identifying value
getComponentController() : SystemComponent: Returns the component controller for this component
getHumanName() : string: Get the translated name of the option
getKeyAsString() : string: Returns this entity's key
getName() : string: Get the name of the option.
getTranslatedFieldValue() : mixed: Returns the value of a translatable field using fallback mechanisms
getValue() : array<string|int, mixed>: Gets the current value of the option.
handleChange() : array<string|int, mixed>: Handle a change of the option.
initializeValidators() : mixed: Set $this->validators
isVirtual() : bool: Returns the virtuality of the entity
renderOptionField() : mixed: Render the option field in the backend.
renderTheme() : mixed: Render the option in the frontend.
setHumanName() : mixed: Set the human name.
setName() : mixed: Set the name of the option.
setVirtual() : mixed: Set the virtuality of the entity
validate() : mixed
yamlSerialize() : array<string|int, mixed>: Get the data in a serializable format.
getFallbackLocaleCodes() : array<string|int, mixed>: Returns a list of all locale codes ordered by fallback order
getStringRepresentationBlank() : bool: Whether blank string representations are valid
getStringRepresentationFields() : array<string|int, mixed>: Returns a list of fields available in the string representation
getStringRepresentationFormat() : string: Returns the sprintf() format for the string representation

$activeChoice

The text value of the option.


    protected
        string
    $activeChoice
     = ''

$choice


    protected
        array<string|int, mixed>
    $choice

$fonts

List with Google Fonts


    protected
        array<string|int, mixed>
    $fonts
     = array('ABeeZee' => array(), 'Abel' => array(), 'Abril Fatface' => array(), 'Aclonica' => array(), 'Acme' => array(), 'Actor' => array(), 'Adamina' => array(), 'Advent Pro' => array(), 'Aguafina Script' => array(), 'Akronim' => array(), 'Aladin' => array(), 'Aldrich' => array(), 'Alef' => array(), 'Alegreya' => array(), 'Alegreya SC' => array(), 'Alegreya Sans' => array(), 'Alegreya Sans SC' => array(), 'Alex Brush' => array(), 'Alfa Slab One' => array(), 'Alice' => array(), 'Alike' => array(), 'Alike Angular' => array(), 'Allan' => array(), 'Allerta' => array(), 'Allerta Stencil' => array(), 'Allura' => array(), 'Almendra' => array(), 'Almendra Display' => array(), 'Almendra SC' => array(), 'Amarante' => array(), 'Amaranth' => array(), 'Amatic SC' => array(), 'Amethysta' => array(), 'Amiri' => array(), 'Amita' => array(), 'Anaheim' => array(), 'Andada' => array(), 'Andika' => array(), 'Angkor' => array(), 'Annie Use Your Telescope' => array(), 'Anonymous Pro' => array(), 'Antic' => array(), 'Antic Didone' => array(), 'Antic Slab' => array(), 'Anton' => array(), 'Arapey' => array(), 'Arbutus' => array(), 'Arbutus Slab' => array(), 'Architects Daughter' => array(), 'Archivo Black' => array(), 'Archivo Narrow' => array(), 'Arial' => array(), 'Arimo' => array(), 'Arizonia' => array(), 'Armata' => array(), 'Artifika' => array(), 'Arvo' => array(), 'Arya' => array(), 'Asap' => array(), 'Asar' => array(), 'Asset' => array(), 'Astloch' => array(), 'Asul' => array(), 'Atomic Age' => array(), 'Aubrey' => array(), 'Audiowide' => array(), 'Autour One' => array(), 'Average' => array(), 'Average Sans' => array(), 'Averia Gruesa Libre' => array(), 'Averia Libre' => array(), 'Averia Sans Libre' => array(), 'Averia Serif Libre' => array(), 'Bad Script' => array(), 'Balthazar' => array(), 'Bangers' => array(), 'Basic' => array(), 'Battambang' => array(), 'Baumans' => array(), 'Bayon' => array(), 'Belgrano' => array(), 'Belleza' => array(), 'BenchNine' => array(), 'Bentham' => array(), 'Berkshire Swash' => array(), 'Bevan' => array(), 'Bigelow Rules' => array(), 'Bigshot One' => array(), 'Bilbo' => array(), 'Bilbo Swash Caps' => array(), 'Biryani' => array(), 'Bitter' => array(), 'Black Ops One' => array(), 'Bokor' => array(), 'Bonbon' => array(), 'Boogaloo' => array(), 'Bowlby One' => array(), 'Bowlby One SC' => array(), 'Brawler' => array(), 'Bree Serif' => array(), 'Bubblegum Sans' => array(), 'Bubbler One' => array(), 'Buda' => array(), 'Buenard' => array(), 'Butcherman' => array(), 'Butterfly Kids' => array(), 'Cabin' => array(), 'Cabin Condensed' => array(), 'Cabin Sketch' => array(), 'Caesar Dressing' => array(), 'Cagliostro' => array(), 'Calligraffitti' => array(), 'Cambay' => array(), 'Cambo' => array(), 'Candal' => array(), 'Cantarell' => array(), 'Cantata One' => array(), 'Cantora One' => array(), 'Capriola' => array(), 'Cardo' => array(), 'Carme' => array(), 'Carrois Gothic' => array(), 'Carrois Gothic SC' => array(), 'Carter One' => array(), 'Catamaran' => array(), 'Caudex' => array(), 'Caveat' => array(), 'Caveat Brush' => array(), 'Cedarville Cursive' => array(), 'Ceviche One' => array(), 'Changa One' => array(), 'Chango' => array(), 'Chau Philomene One' => array(), 'Chela One' => array(), 'Chelsea Market' => array(), 'Chenla' => array(), 'Cherry Cream Soda' => array(), 'Cherry Swash' => array(), 'Chewy' => array(), 'Chicle' => array(), 'Chivo' => array(), 'Chonburi' => array(), 'Cinzel' => array(), 'Cinzel Decorative' => array(), 'Clicker Script' => array(), 'Coda' => array(), 'Coda Caption' => array(), 'Codystar' => array(), 'Combo' => array(), 'Comfortaa' => array(), 'Coming Soon' => array(), 'Concert One' => array(), 'Condiment' => array(), 'Content' => array(), 'Contrail One' => array(), 'Convergence' => array(), 'Cookie' => array(), 'Copse' => array(), 'Corben' => array(), 'Courgette' => array(), 'Cousine' => array(), 'Coustard' => array(), 'Covered By Your Grace' => array(), 'Crafty Girls' => array(), 'Creepster' => array(), 'Crete Round' => array(), 'Crimson Text' => array(), 'Croissant One' => array(), 'Crushed' => array(), 'Cuprum' => array(), 'Cutive' => array(), 'Cutive Mono' => array(), 'Damion' => array(), 'Dancing Script' => array(), 'Dangrek' => array(), 'Dawning of a New Day' => array(), 'Days One' => array(), 'Dekko' => array(), 'Delius' => array(), 'Delius Swash Caps' => array(), 'Delius Unicase' => array(), 'Della Respira' => array(), 'Denk One' => array(), 'Devonshire' => array(), 'Dhurjati' => array(), 'Didact Gothic' => array(), 'Diplomata' => array(), 'Diplomata SC' => array(), 'Domine' => array(), 'Donegal One' => array(), 'Doppio One' => array(), 'Dorsa' => array(), 'Dosis' => array(), 'Dr Sugiyama' => array(), 'Droid Sans' => array(), 'Droid Sans Mono' => array(), 'Droid Serif' => array(), 'Duru Sans' => array(), 'Dynalight' => array(), 'EB Garamond' => array(), 'Eagle Lake' => array(), 'Eater' => array(), 'Economica' => array(), 'Eczar' => array(), 'Ek Mukta' => array(), 'Electrolize' => array(), 'Elsie' => array(), 'Elsie Swash Caps' => array(), 'Emblema One' => array(), 'Emilys Candy' => array(), 'Engagement' => array(), 'Englebert' => array(), 'Enriqueta' => array(), 'Erica One' => array(), 'Esteban' => array(), 'Euphoria Script' => array(), 'Ewert' => array(), 'Exo' => array(), 'Exo 2' => array(), 'Expletus Sans' => array(), 'Fanwood Text' => array(), 'Fascinate' => array(), 'Fascinate Inline' => array(), 'Faster One' => array(), 'Fasthand' => array(), 'Fauna One' => array(), 'Federant' => array(), 'Federo' => array(), 'Felipa' => array(), 'Fenix' => array(), 'Finger Paint' => array(), 'Fira Mono' => array(), 'Fira Sans' => array(), 'Fjalla One' => array(), 'Fjord One' => array(), 'Flamenco' => array(), 'Flavors' => array(), 'Fondamento' => array(), 'Fontdiner Swanky' => array(), 'Forum' => array(), 'Francois One' => array(), 'Freckle Face' => array(), 'Fredericka the Great' => array(), 'Fredoka One' => array(), 'Freehand' => array(), 'Fresca' => array(), 'Frijole' => array(), 'Fruktur' => array(), 'Fugaz One' => array(), 'GFS Didot' => array(), 'GFS Neohellenic' => array(), 'Gabriela' => array(), 'Gafata' => array(), 'Galdeano' => array(), 'Galindo' => array(), 'Gentium Basic' => array(), 'Gentium Book Basic' => array(), 'Geo' => array(), 'Geostar' => array(), 'Geostar Fill' => array(), 'Germania One' => array(), 'Gidugu' => array(), 'Gilda Display' => array(), 'Give You Glory' => array(), 'Glass Antiqua' => array(), 'Glegoo' => array(), 'Gloria Hallelujah' => array(), 'Goblin One' => array(), 'Gochi Hand' => array(), 'Gorditas' => array(), 'Goudy Bookletter 1911' => array(), 'Graduate' => array(), 'Grand Hotel' => array(), 'Gravitas One' => array(), 'Great Vibes' => array(), 'Griffy' => array(), 'Gruppo' => array(), 'Gudea' => array(), 'Gurajada' => array(), 'Habibi' => array(), 'Halant' => array(), 'Hammersmith One' => array(), 'Hanalei' => array(), 'Hanalei Fill' => array(), 'Handlee' => array(), 'Hanuman' => array(), 'Happy Monkey' => array(), 'Headland One' => array(), 'Henny Penny' => array(), 'Herr Von Muellerhoff' => array(), 'Hind' => array(), 'Hind Siliguri' => array(), 'Hind Vadodara' => array(), 'Holtwood One SC' => array(), 'Homemade Apple' => array(), 'Homenaje' => array(), 'IM Fell DW Pica' => array(), 'IM Fell DW Pica SC' => array(), 'IM Fell Double Pica' => array(), 'IM Fell Double Pica SC' => array(), 'IM Fell English' => array(), 'IM Fell English SC' => array(), 'IM Fell French Canon' => array(), 'IM Fell French Canon SC' => array(), 'IM Fell Great Primer' => array(), 'IM Fell Great Primer SC' => array(), 'Iceberg' => array(), 'Iceland' => array(), 'Imprima' => array(), 'Inconsolata' => array(), 'Inder' => array(), 'Indie Flower' => array(), 'Inika' => array(), 'Inknut Antiqua' => array(), 'Irish Grover' => array(), 'Istok Web' => array(), 'Italiana' => array(), 'Italianno' => array(), 'Itim' => array(), 'Jacques Francois' => array(), 'Jacques Francois Shadow' => array(), 'Jaldi' => array(), 'Jim Nightshade' => array(), 'Jockey One' => array(), 'Jolly Lodger' => array(), 'Josefin Sans' => array(), 'Josefin Slab' => array(), 'Joti One' => array(), 'Judson' => array(), 'Julee' => array(), 'Julius Sans One' => array(), 'Junge' => array(), 'Jura' => array(), 'Just Another Hand' => array(), 'Just Me Again Down Here' => array(), 'Kadwa' => array(), 'Kalam' => array(), 'Kameron' => array(), 'Kantumruy' => array(), 'Karla' => array(), 'Karma' => array(), 'Kaushan Script' => array(), 'Kavoon' => array(), 'Kdam Thmor' => array(), 'Keania One' => array(), 'Kelly Slab' => array(), 'Kenia' => array(), 'Khand' => array(), 'Khmer' => array(), 'Khula' => array(), 'Kite One' => array(), 'Knewave' => array(), 'Kotta One' => array(), 'Koulen' => array(), 'Kranky' => array(), 'Kreon' => array(), 'Kristi' => array(), 'Krona One' => array(), 'Kurale' => array(), 'La Belle Aurore' => array(), 'Laila' => array(), 'Lakki Reddy' => array(), 'Lancelot' => array(), 'Lateef' => array(), 'Lato' => array(), 'League Script' => array(), 'Leckerli One' => array(), 'Ledger' => array(), 'Lekton' => array(), 'Lemon' => array(), 'Libre Baskerville' => array(), 'Life Savers' => array(), 'Lilita One' => array(), 'Lily Script One' => array(), 'Limelight' => array(), 'Linden Hill' => array(), 'Lobster' => array(), 'Lobster Two' => array(), 'Londrina Outline' => array(), 'Londrina Shadow' => array(), 'Londrina Sketch' => array(), 'Londrina Solid' => array(), 'Lora' => array(), 'Love Ya Like A Sister' => array(), 'Loved by the King' => array(), 'Lovers Quarrel' => array(), 'Luckiest Guy' => array(), 'Lusitana' => array(), 'Lustria' => array(), 'Macondo' => array(), 'Macondo Swash Caps' => array(), 'Magra' => array(), 'Maiden Orange' => array(), 'Mako' => array(), 'Mallanna' => array(), 'Mandali' => array(), 'Marcellus' => array(), 'Marcellus SC' => array(), 'Marck Script' => array(), 'Margarine' => array(), 'Marko One' => array(), 'Marmelad' => array(), 'Martel' => array(), 'Martel Sans' => array(), 'Marvel' => array(), 'Mate' => array(), 'Mate SC' => array(), 'Maven Pro' => array(), 'McLaren' => array(), 'Meddon' => array(), 'MedievalSharp' => array(), 'Medula One' => array(), 'Megrim' => array(), 'Meie Script' => array(), 'Merienda' => array(), 'Merienda One' => array(), 'Merriweather' => array(), 'Merriweather Sans' => array(), 'Metal' => array(), 'Metal Mania' => array(), 'Metamorphous' => array(), 'Metrophobic' => array(), 'Michroma' => array(), 'Milonga' => array(), 'Miltonian' => array(), 'Miltonian Tattoo' => array(), 'Miniver' => array(), 'Miss Fajardose' => array(), 'Modak' => array(), 'Modern Antiqua' => array(), 'Molengo' => array(), 'Molle' => array(), 'Monda' => array(), 'Monofett' => array(), 'Monoton' => array(), 'Monsieur La Doulaise' => array(), 'Montaga' => array(), 'Montez' => array(), 'Montserrat' => array(), 'Montserrat Alternates' => array(), 'Montserrat Subrayada' => array(), 'Moul' => array(), 'Moulpali' => array(), 'Mountains of Christmas' => array(), 'Mouse Memoirs' => array(), 'Mr Bedfort' => array(), 'Mr Dafoe' => array(), 'Mr De Haviland' => array(), 'Mrs Saint Delafield' => array(), 'Mrs Sheppards' => array(), 'Muli' => array(), 'Mystery Quest' => array(), 'NTR' => array(), 'Neucha' => array(), 'Neuton' => array(), 'New Rocker' => array(), 'News Cycle' => array(), 'Niconne' => array(), 'Nixie One' => array(), 'Nobile' => array(), 'Nokora' => array(), 'Norican' => array(), 'Nosifer' => array(), 'Nothing You Could Do' => array(), 'Noticia Text' => array(), 'Noto Sans' => array(), 'Noto Serif' => array(), 'Nova Cut' => array(), 'Nova Flat' => array(), 'Nova Mono' => array(), 'Nova Oval' => array(), 'Nova Round' => array(), 'Nova Script' => array(), 'Nova Slim' => array(), 'Nova Square' => array(), 'Numans' => array(), 'Nunito' => array(), 'Odor Mean Chey' => array(), 'Offside' => array(), 'Old Standard TT' => array(), 'Oldenburg' => array(), 'Oleo Script' => array(), 'Oleo Script Swash Caps' => array(), 'Open Sans' => array(), 'Open Sans Condensed' => array(), 'Oranienbaum' => array(), 'Orbitron' => array(), 'Oregano' => array(), 'Orienta' => array(), 'Original Surfer' => array(), 'Oswald' => array(), 'Over the Rainbow' => array(), 'Overlock' => array(), 'Overlock SC' => array(), 'Ovo' => array(), 'Oxygen' => array(), 'Oxygen Mono' => array(), 'PT Mono' => array(), 'PT Sans' => array(), 'PT Sans Caption' => array(), 'PT Sans Narrow' => array(), 'PT Serif' => array(), 'PT Serif Caption' => array(), 'Pacifico' => array(), 'Palanquin' => array(), 'Palanquin Dark' => array(), 'Paprika' => array(), 'Parisienne' => array(), 'Passero One' => array(), 'Passion One' => array(), 'Pathway Gothic One' => array(), 'Patrick Hand' => array(), 'Patrick Hand SC' => array(), 'Patua One' => array(), 'Paytone One' => array(), 'Peddana' => array(), 'Peralta' => array(), 'Permanent Marker' => array(), 'Petit Formal Script' => array(), 'Petrona' => array(), 'Philosopher' => array(), 'Piedra' => array(), 'Pinyon Script' => array(), 'Pirata One' => array(), 'Plaster' => array(), 'Play' => array(), 'Playball' => array(), 'Playfair Display' => array(), 'Playfair Display SC' => array(), 'Podkova' => array(), 'Poiret One' => array(), 'Poller One' => array(), 'Poly' => array(), 'Pompiere' => array(), 'Pontano Sans' => array(), 'Poppins' => array(), 'Port Lligat Sans' => array(), 'Port Lligat Slab' => array(), 'Pragati Narrow' => array(), 'Prata' => array(), 'Preahvihear' => array(), 'Press Start 2P' => array(), 'Princess Sofia' => array(), 'Prociono' => array(), 'Prosto One' => array(), 'Puritan' => array(), 'Purple Purse' => array(), 'Quando' => array(), 'Quantico' => array(), 'Quattrocento' => array(), 'Quattrocento Sans' => array(), 'Questrial' => array(), 'Quicksand' => array(), 'Quintessential' => array(), 'Qwigley' => array(), 'Racing Sans One' => array(), 'Radley' => array(), 'Rajdhani' => array(), 'Raleway' => array(), 'Raleway Dots' => array(), 'Ramabhadra' => array(), 'Ramaraja' => array(), 'Rambla' => array(), 'Rammetto One' => array(), 'Ranchers' => array(), 'Rancho' => array(), 'Ranga' => array(), 'Rationale' => array(), 'Ravi Prakash' => array(), 'Redressed' => array(), 'Reenie Beanie' => array(), 'Revalia' => array(), 'Rhodium Libre' => array(), 'Ribeye' => array(), 'Ribeye Marrow' => array(), 'Righteous' => array(), 'Risque' => array(), 'Roboto' => array(), 'Roboto Condensed' => array(), 'Roboto Mono' => array(), 'Roboto Slab' => array(), 'Rochester' => array(), 'Rock Salt' => array(), 'Rokkitt' => array(), 'Romanesco' => array(), 'Ropa Sans' => array(), 'Rosario' => array(), 'Rosarivo' => array(), 'Rouge Script' => array(), 'Rozha One' => array(), 'Rubik' => array(), 'Rubik Mono One' => array(), 'Rubik One' => array(), 'Ruda' => array(), 'Rufina' => array(), 'Ruge Boogie' => array(), 'Ruluko' => array(), 'Rum Raisin' => array(), 'Ruslan Display' => array(), 'Russo One' => array(), 'Ruthie' => array(), 'Rye' => array(), 'Sacramento' => array(), 'Sahitya' => array(), 'Sail' => array(), 'Salsa' => array(), 'Sanchez' => array(), 'Sancreek' => array(), 'Sansita One' => array(), 'Sarala' => array(), 'Sarina' => array(), 'Sarpanch' => array(), 'Satisfy' => array(), 'Scada' => array(), 'Scheherazade' => array(), 'Schoolbell' => array(), 'Seaweed Script' => array(), 'Sevillana' => array(), 'Seymour One' => array(), 'Shadows Into Light' => array(), 'Shadows Into Light Two' => array(), 'Shanti' => array(), 'Share' => array(), 'Share Tech' => array(), 'Share Tech Mono' => array(), 'Shojumaru' => array(), 'Short Stack' => array(), 'Siemreap' => array(), 'Sigmar One' => array(), 'Signika' => array(), 'Signika Negative' => array(), 'Simonetta' => array(), 'Sintony' => array(), 'Sirin Stencil' => array(), 'Six Caps' => array(), 'Skranji' => array(), 'Slabo 13px' => array(), 'Slabo 27px' => array(), 'Slackey' => array(), 'Smokum' => array(), 'Smythe' => array(), 'Sniglet' => array(), 'Snippet' => array(), 'Snowburst One' => array(), 'Sofadi One' => array(), 'Sofia' => array(), 'Sonsie One' => array(), 'Sorts Mill Goudy' => array(), 'Source Code Pro' => array(), 'Source Sans Pro' => array(), 'Source Serif Pro' => array(), 'Special Elite' => array(), 'Spicy Rice' => array(), 'Spinnaker' => array(), 'Spirax' => array(), 'Squada One' => array(), 'Sree Krushnadevaraya' => array(), 'Stalemate' => array(), 'Stalinist One' => array(), 'Stardos Stencil' => array(), 'Stint Ultra Condensed' => array(), 'Stint Ultra Expanded' => array(), 'Stoke' => array(), 'Strait' => array(), 'Sue Ellen Francisco' => array(), 'Sumana' => array(), 'Sunshiney' => array(), 'Supermercado One' => array(), 'Sura' => array(), 'Suranna' => array(), 'Suravaram' => array(), 'Suwannaphum' => array(), 'Swanky and Moo Moo' => array(), 'Syncopate' => array(), 'Tangerine' => array(), 'Taprom' => array(), 'Tauri' => array(), 'Teko' => array(), 'Telex' => array(), 'Tenali Ramakrishna' => array(), 'Tenor Sans' => array(), 'Text Me One' => array(), 'The Girl Next Door' => array(), 'Tienne' => array(), 'Tillana' => array(), 'Timmana' => array(), 'Tinos' => array(), 'Titan One' => array(), 'Titillium Web' => array(), 'Trade Winds' => array(), 'Trocchi' => array(), 'Trochut' => array(), 'Trykker' => array(), 'Tulpen One' => array(), 'Ubuntu' => array(), 'Ubuntu Condensed' => array(), 'Ubuntu Mono' => array(), 'Ultra' => array(), 'Uncial Antiqua' => array(), 'Underdog' => array(), 'Unica One' => array(), 'UnifrakturCook' => array(), 'UnifrakturMaguntia' => array(), 'Unkempt' => array(), 'Unlock' => array(), 'Unna' => array(), 'VT323' => array(), 'Vampiro One' => array(), 'Varela' => array(), 'Varela Round' => array(), 'Vast Shadow' => array(), 'Vesper Libre' => array(), 'Vibur' => array(), 'Vidaloka' => array(), 'Viga' => array(), 'Voces' => array(), 'Volkhov' => array(), 'Vollkorn' => array(), 'Voltaire' => array(), 'Waiting for the Sunrise' => array(), 'Wallpoet' => array(), 'Walter Turncoat' => array(), 'Warnes' => array(), 'Wellfleet' => array(), 'Wendy One' => array(), 'Wire One' => array(), 'Work Sans' => array(), 'Yanone Kaffeesatz' => array(), 'Yantramanav' => array(), 'Yellowtail' => array(), 'Yeseva One' => array(), 'Yesteryear' => array(), 'Zeyada' => array())

$humanName

The translated name of the option. If the active language isn't available english is used as a fallback. If this also isn't available the name of the option is used.


    protected
        string
    $humanName

$localeCodes

List of locale codes ordered by translation fallback order per Cx instance


    protected
    static    array<string|int, mixed>
    $localeCodes
     = array()

Array in the form: array(<instanceId> => array(<localeCode>, ...))

$name

The identifying name of the option.


    protected
        void
    $name

$nestingCount

Counts the nesting level of __call()


    protected
    static    int
    $nestingCount
     = 0

$stringRepresentationBlank

Whether blank string representations are valid


    protected
        bool
    $stringRepresentationBlank
     = false

Whether blank string representations are valid

$stringRepresentationFields

List of fields that should be available in the string representation


    protected
        array<string|int, mixed>
    $stringRepresentationFields
     = array()

List of field names

$stringRepresentationFormat

Sprintf format for the string representation


    protected
        string
    $stringRepresentationFormat
     = ''

Sprintf format string

$translations

Array with translations for all available languages.


    protected
        array<string|int, mixed>
    $translations

The key of the array is the language id.

$validators

Initialize this array as follows: array( 'columName' => Zend_Validate )


    protected
        array<string|int, mixed>
    $validators
     = array()

$virtual

Defines if an entity is virtual and therefore not persistable.


    protected
        bool
    $virtual
     = false

Defaults to FALSE - not virtual.

__call()

Route methods like getName(), getType(), getDirectory(), etc.


    public
                    __call(string $methodName, array<string|int, mixed> $arguments) : mixed

Parameters

$methodName : string: Name of method to call
$arguments : array<string|int, mixed>: List of arguments for the method to call

Return values

mixed —

Return value of the method to call

__construct()


    public
                    __construct(string $name, array<string|int, mixed> $translations, array<string|int, mixed> $data) : mixed

Parameters

$name : string: Name of the option
$translations : array<string|int, mixed>: Array with translations for option.
$data : array<string|int, mixed>

__get()

This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.


    public
                    __get(mixed $name) : mixed

Parameters

$name : mixed

__toString()

Returns this entity's identifying value


    public
                    __toString() : string

By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.

Return values

string —

Identifying value for this entity

getComponentController()

Returns the component controller for this component


    public
                    getComponentController() : SystemComponent

Return values

SystemComponent

getHumanName()

Get the translated name of the option


    public
                    getHumanName() : string

Return values

string

getKeyAsString()

Returns this entity's key


    public
        final            getKeyAsString([string $separator = '/' ]) : string

If this entity has a composite key, the fields are separated by $separator.

Parameters

$separator : string = '/': (optional) Separator for composite key fields, default "/"

Return values

string —

Entity key as string

getName()

Get the name of the option.


    public
                    getName() : string

Return values

string

getTranslatedFieldValue()

Returns the value of a translatable field using fallback mechanisms


    public
                    getTranslatedFieldValue(string $fieldName) : mixed

If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):

Current locale
Default locale
All other locales

Parameters

$fieldName : string: Name of a translatable field

getValue()

Gets the current value of the option.


    public
    abstract                getValue() : array<string|int, mixed>

Return values

array<string|int, mixed>

handleChange()

Handle a change of the option.


    public
    abstract                handleChange(array<string|int, mixed> $data) : array<string|int, mixed>

Parameters

$data : array<string|int, mixed>: Data from frontend javascript

Return values

array<string|int, mixed> —

Changed data for the frontend javascript

initializeValidators()

Set $this->validators


    public
                    initializeValidators() : mixed

Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called

isVirtual()

Returns the virtuality of the entity


    public
                    isVirtual() : bool

Return values

bool —

TRUE if the entity is virtual, otherwise FALSE

renderOptionField()

Render the option field in the backend.


    public
    abstract                renderOptionField(Sigma $template) : mixed

Parameters

$template : Sigma: The template of the backend view.

renderTheme()

Render the option in the frontend.


    public
    abstract                renderTheme(Sigma $template) : mixed

Parameters

$template : Sigma: The frontend template.

setHumanName()

Set the human name.


    public
                    setHumanName(string $humanName) : mixed

Parameters

$humanName : string

setName()

Set the name of the option.


    public
                    setName(void $name) : mixed

Parameters

$name : void

setVirtual()

Set the virtuality of the entity


    public
                    setVirtual(bool $virtual) : mixed

Parameters

$virtual : bool: TRUE to set the entity as virtual or otherwise to FALSE

validate()


    public
                    validate() : mixed

yamlSerialize()

Get the data in a serializable format.


    public
                    yamlSerialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFallbackLocaleCodes()

Returns a list of all locale codes ordered by fallback order


    protected
                    getFallbackLocaleCodes() : array<string|int, mixed>

First entry is the current locale
Second entry is the default locale (if different from current, it's omitted otherwise)
Then all other locales follow (in no particular order)

Return values

array<string|int, mixed> —

List of locale codes

getStringRepresentationBlank()

Whether blank string representations are valid


    protected
                    getStringRepresentationBlank() : bool

Return values

bool —

Whether blank string representations are valid

getStringRepresentationFields()

Returns a list of fields available in the string representation


    protected
                    getStringRepresentationFields() : array<string|int, mixed>

Return values

array<string|int, mixed> —

List of field names

getStringRepresentationFormat()

Returns the sprintf() format for the string representation


    protected
                    getStringRepresentationFormat() : string

Return values

string —

sprintf() format string

FontOption extends SelectOption in package contrexx

Tags

Table of Contents

Properties

Methods

Properties

$activeChoice

$choice

$fonts

$humanName

$localeCodes

Tags

$name

$nestingCount

$stringRepresentationBlank

Tags

$stringRepresentationFields

Tags

$stringRepresentationFormat

Tags

$translations

$validators

$virtual

Methods

__call()

Parameters

Tags

Return values

__construct()

Parameters

__get()

Parameters

__toString()

Return values

getComponentController()

Return values

getHumanName()

Return values

getKeyAsString()

Parameters

Return values

getName()

Return values

getTranslatedFieldValue()

Parameters

getValue()

Return values

handleChange()

Parameters

Tags

Return values

initializeValidators()

isVirtual()

Return values

renderOptionField()

Parameters

renderTheme()

Parameters

setHumanName()

Parameters

setName()

Parameters

setVirtual()

Parameters

validate()

Tags

yamlSerialize()

Return values

getFallbackLocaleCodes()

Tags

Return values

getStringRepresentationBlank()

Return values

getStringRepresentationFields()

Return values

getStringRepresentationFormat()

Return values

FontOption extends SelectOption
in package

contrexx