How to include file inside class body

[larry1301]

I am trying to us an include inside a class body but get a unexpected T_INCLUDE, expecting T_FUNCTION error when I do so.

Here's what and why I am trying to do.

1. This is for a framing website and the class is about the matting used for framing.

2. The definitions and types of the mats used are in several mysql tables.

3. There are over 80 types of mats with a number of attribute tables (sizes, manufacturer, conservation type, etc) and over 2600 mats.
   4, The 80 or so types will be used to populate drop down lists based on some of the other criteria (If the request archival mats, one list is shown, textured mats, another list, etc).

4. These lists will be requested very often during a site visit.

5. Generating them directly from mysql is going to be slower than I want.

6. The mats and status (IsActive) will change often so I only want to have to change one source (the db)

7. I need a static class to access the mats and their attributes, not just for the generation of the lists but for other purposes.

8. The general structure of the class file will be

   <?php
   include_once( "MatLists.php" );   // created dynamically via a script
   
   class Mat
   {
   	include "MatArrays.php";   // also created dynamically via a script
   
   public static function GetMatDescription ( $MatNo ) 
   {
   	if ( array_key_exists ( $MatNo, self::$Mat) )
   		return self::$Mat [ $MatNo ] [ 4 ];
   }
   
   .... more access functions
   
   }
   ?>

   which when expanded will look like

   <?php
   define("MAT_ARCHIVAL",1);
   define("MAT_CONSERVATION",2);
   define("MAT_DECORATIVE",3);
   
   define("BAINBRIDGE",1);
   define("CRESECENT",2);
   
   define("MAT_4_PLY",4);
   define("MAT_8_PLY",8);
   define("MAT_12_PLY",12);
   
   define("MAT_32X40",1);
   define("MAT_40X60",2);
   
   define("MAT_ALPHARAG_100%_COTTON",1);
   define("MAT_ALPHARAG_NATURALS",2);
   define("MAT_ALPHARAG_ARTCARE",3);
   define("MAT_ALPHAMAT_ARTCARE_SOLIDS",4);
   define("MAT_ALPHAMAT_ARTCARE_SPECIALTIES_PRECIOUS_METALS",5);
   ... and more definitions
   class Mat
   {
   	public static $ConservationTypes = array {
   		MAT_ARCHIVAL => array { ALPHARAG_100%_COTTON,ALPHAMAT_ARTCARE_SPECIALTIES_HERITAGE,ALPHAMAT_ARTCARE_SPECIALTIES_TRACES,ALPHAMAT_ARTCARE_SPECIALTIES_AMERICAN_CLASSICS,ALPHAMAT_ARTCARE_SPECIALTIES_CLASSICOS,ALPHAMAT_ARTCARE_SPECIALTIES_PARCHMENTS,ALPHAMAT_ARTCARE_SPECIALTIES_ALPHA_LINENS,ALPHAMAT_ARTCARE_WASHED_LINEN,ALPHAMAT_ARTCARE_LEATHER,ALPHAMAT_ARTCARE_DENIMS,ALPHAMAT_ARTCARE_COLOR_CORE,ALPHAMAT_ARTCARE_NEW_THREADS,ALPHAMAT_ARTCARE_SUEDE,ALPHAMAT_ARTCARE_EMBOSSED_SUEDE,ALPHAMAT_ARTCARE_GRASSCLOTH,ALPHAMAT_ARTCARE_RICE_PAPER,ALPHAMAT_ARTCARE_METTALIC_RICE_PAPER,ALPHAMAT_ARTCARE_SILKENS,ALPHAMAT_ARTCARE_TATAMI_SILKENS,ALPHAMAT_ARTCARE_RAW_SILKS,RAGMAT_MUSEUM_SOLIDS,RAGMAT,RAGMAT_ANTIQUARIAN,RAGMAT_SPECIALTIES,RAGMAT_NOIR_BLACK_CORE,ELIZABETH_DOW_COLLECTION,MICHAEL_GRAVES_COLLECTION,RAGMAT_INTAGLIO},
   		MAT_CONSERVATION => array { SELECT,SELECT_ULTIBLACKS,ACCENTS,ULTIBLACK_FLORENTINES,SELECT_PALAZZOS,SELECT_BELGIQUES,SELECT_ULTIBLACK_BELGIQUES,MOORMAN_SUEDES,BLACK_CORE_MOORMAN_SUEDES,MOORMAN_NATURAL_LINENS,MOORMAN_LINENS,MOORMAN_LEATHER},
   		MAT_DECORATIVE => array { PEBBLE_PAPER_MATS,PAPER_MATS,PAPERMAT_FORMALS,PAPERMAT_FORMALS_BLACK_CORE,BLACK_BY_BAINBRIDGE_PAPERMAT,INTERNATION_WHITECORE,CRESCENT_INTERNATION_WHITECORE_FAUX_METALLIC,CRESCENT_INTERNATION_WHITECORE_FAUX_MARBLE,CRESCENT_INTERNATION_WHITECORE_FAUX_MARBLE_BLACK_CORE,INTERNATION_WHITECORE_CLASSICS_FAUX_LEATHER,INTERNATION_WHITECORE_CLASSICS_LIBRARY_LEATHER,PAPERMAT,BRITECORES_PAPERMAT,_FLANNEL_PAPERMAT,LINI_PAPERMAT,SILKI_PAPERMAT,PARCHMENT_PAPERMAT,CRESCENT_DENIM_PAPERMAT,NEOCLASSICS_PAPERMAT,PRECIOUS_METALS_PAPERMAT,ANCIENTS_PAPERMAT,FLORENTINE_METTALICS_PAPERMAT,BLACK_CORE_PRECIOUS_METALS_PAPERMAT,BLACK_CORE_PAPERMAT,BLACK_CORE_FLANNEL_PAPERMAT}
   	};
   
   public static $MatGroups = array {
   	ALPHARAG_100%_COTTON => array ( "B8605","B8606","B8607","B8614"},
   	ALPHARAG_NATURALS => array ( "B8626","B8627","B8628","B8629","B8689","B8690"},
   	...... more groups 80+ inall
   	BLACK_CORE_PRECIOUS_METALS_PAPERMAT => array ( "C63702","C63703","C63708","C63713"},
   	BLACK_CORE_FLANNEL_PAPERMAT => array ( "C63300","C63305","C63306","C63307","C63310","C63311"}
   };
   
   public static $Mat = array {
   	"B110" => array ( 1,3.43,"B110",1, "Off White & White Pebble"),
   	"B110L" => array ( 2,8.48,"B110L",1, "Off White & White Pebble"),
   	........   more mats - 2600 in all
   	"B4119L" => array ( 2,29.83,"B4119L",1, "Grappa"),
   	"B412" => array ( 1,3.92,"B412",1, "Tan"),
      );
   
   public static function GetMatDescription ( $MatNo ) 
   {
   	if ( array_key_exists ( $MatNo, self::$Mat) )
   		return self::$Mat [ $MatNo ] [ MAT_DESCRIPTION_COLUMN ];
   }
   ... more access functions
   }
   ?>

   Both of the include files are generated via a php script that will run daily via a cron job.The inclusion of first file MatLists.php, that includes defines generated from the db is not a problem as it is outside the class.

   The file that I wish to include inside the class is the problem. I can't find (a lot of googling seems to say it can't be done) a way to do this.

   I don't want to include the file outside the class. I prefer the structure of static class access as opposed to a bunch of global arrays.

   Plan A, if anyone can offer any suggestions, is figure out a way to overcome the include restrictions inside a class.

   Plan B, if I can't figure it out is to dynamically write the entire class, including all the functions dynamically.

   I use the same thing in other portions of the site. There will be over 200K products on the site. The menus are all dynamic (sortof) and will be structured by most the most popular viewed products (top artists, top subjects, top art styles, top items, etc). They menus are created via a daily cron jobs that creates top viewed lists from the hits tables, which are incremented anytime an item is viewed, which then define the menus. These are also in a static class which has only data, so I write the entire class dynamically for this one.

   Suggestions are welcome. Thanks in advance.

[Neumy]

It looks like you want to use an constructor. This way, when you create the Object, you run the include mentioned there.

<?php
include_once( "MatLists.php" );   // created dynamically via a script

class Mat
{
    public function __contruct()
    {
        include "MatArrays.php";   // also created dynamically via a script
    }

public static function GetMatDescription ( $MatNo )
{
    if ( array_key_exists ( $MatNo, self::$Mat) )
        return self::$Mat [ $MatNo ] [ 4 ];
}

.... more access functions

}
?> 

[mpb001]

He wants it static..

"5. These lists will be requested very often during a site visit.
6. Generating them directly from mysql is going to be slower than I want."

Though I would personally look into other things before premature optimizing it. 200000 is not much and a lot of things in the database are put into memory or automatically cache if setup right. Especially those things above.

They are pretty clever those database things and things should not be assumed without research.
http://dev.mysql.com/doc/refman/5.0/en/optimization.html

A potential plan should be planned for higher load in the future and be able to be swapped in easily. By that time you will have a choice of increased hardware for the same cost.

The proposed way is likely going to keep unloading and loading stuff the database would keep constantly in shared memory until restarted. The memory load in the PHP equivelent will not be shared memory and more subsceptable to peaks and increased compilation overhead. Plus if a cron job fails halfway through potentially the whole site goes down due to a compilation error.

Beware of the premature optimization
http://en.wikipedia.org/wiki/Optimization_(computer_science)

It might seem fun and flashy now but unless it is your own project someone else will have to live with it. Forever....

If it yours go as mad as you like, no pain no gain 😉

[Weedpacket]

And as it happens "MAT_ALPHARAG_100%_COTTON" isn't a legitimate constant name.

[larry1301]

Thanks for the great responses. Points taken. I don't know as much as I should about the tradeoffs between database/code and will be doing more reading and benchmarking. Both articles are good and will get more thought. BTW, the second link is truncated. Here is the full link for those interested.

http://en.wikipedia.org/wiki/Optimization_%28computer_science%29

BTW, All the defines shown are generated from the names in the tables.

The script changes

Alphamat Artcare Specialties Tuscany

to

ALPHAMAT_ARTCARE_SPECIALITIES_TUSCANY

Since the generated class hasn't been used yet, I didn't notice the 100% which is now 100 PERCENT. Good catch.

Since I can't use an include inside a class I have now generated the entire class via a script. The data needs to remain in the database. I will be doing some benchmarking as I implement portions of the site that use the data. Some may be via the class, other directly depending on the benchmarking. The items generated within the class may change as it progresses. The article on Premature Optimization suggests that I may be going about it a$$-backwards. I will find out if they are right. In either case the affected code will be localized to a class method or function. BTW, the primary access to the data will be via AJAX.

The database represents the know universe of mats and types for the manufacturers I use. Each type/mat has an IsActive flag in the record so when it comes time to decide on my final product set, I wil use the IsActive flag to set the offerred products. The product universe changes often with new types and items added and discontinued. Updating the database is far easier than via code.

BTW, the site is mine so I will have to be the one to live with the decisions I make. CRON failures will have an impact. I mentioned running this via a cron job. More likely I will run the script manually whenever I make changes to the database. My most popular menu selections will be via cron daily. That one I will have to keep an eye on.

[mpb001]

" I will find out if they are right. In either case the affected code will be localized to a class method or function".

That is the way. The art of the light foot. 😉

I have never used it for this but you could use the factory/abstract pattern to return an options object that can always use

toJSON()
toXML()
toHTML()

for example.

Either by a simple concrete class an array gets put into, from serialised form, or by abstract class/interface implementation etc as needed.

eg. OptionFactory::createMatTypes()->toJSON()

http://en.wikipedia.org/wiki/Factory_method_pattern
http://en.wikipedia.org/wiki/Abstract_factory_pattern

The iterator interface might also worth looking into so you can foreach the object.
http://ramikayyali.com/archives/2005/02/25/iterators

Except for the visual reference of the dynamic constants not sure of there point as they are an added complication to what seems to be only machine friendly data. ALPHAMAT_ARTCARE_SPECIALITIES_TUSCANY if used outside of the machine generated stuff will cause problems if deleted.

Storing serialized objects will be simpler. Also JSON is a lot faster than xml as it natively compiles javascript objects which can be looped through normally so well worth looking into if you haven't already.

On apache use Keep Alive etc. so the browser keeps a connection open as re-opening them has a time expense as well.

[larry1301]

More great references. I have used some of the design patterns in the past, most the singleton, but I take a closer look at these before I proceed. Thanks.

I didn't mention it before, but the development is in php 5.1, mySQL 5 and smarty. Stored Procedures are used for just about all database access.

BTW, the defines aren't used outside the class. They are only used so that I can visually inspect the results. Reading

	public static $ConservationTypes = array (
		MAT_ARCHIVAL => array ( ALPHARAG_100_PERCENT_COTTON,ALPHARAG_ARTCARE ),
		MAT_CONSERVATION => array ( SELECT ),
		MAT_DECORATIVE => array ( PAPERMAT )
	);

is a lot easier than

	public static $ConservationTypes = array (
		1 => array ( 1,2 ),
		2 => array ( 44),
		3 => array ( 66 )
	);

Will never be used outside the class. I expect to change to product set of mats with some frequency so I won't be using them anywhere outside the class.

The following is a reduced version of the generated class (class.Mat.php) as it exists right now. Everything, including the comments are generated via a script. There is a lot more data and methods than shown.

<?php
// Conservation Types
define("MAT_ARCHIVAL",1);
define("MAT_CONSERVATION",2);
define("MAT_DECORATIVE",3);

// Manufacturers
define("BAINBRIDGE",1);
define("CRESECENT",2);
define("LARSON-JUHL",3);

// Mat Thickness
define("MAT_4_PLY",4);
define("MAT_6_PLY",6);
define("MAT_8_PLY",8);

// Mat Size
define("MAT_32X40",1);
define("MAT_40X60",2);

// Mat Types
define("MAT_ALPHARAG_100_PERCENT_COTTON",1);
define("MAT_ALPHARAG_ARTCARE",3);
define("MAT_SELECT",44);
define("MAT_PAPERMAT",66);

class Mat 
{

public static $ConservationTypes = array (
	MAT_ARCHIVAL => array ( ALPHARAG_100_PERCENT_COTTON,ALPHARAG_ARTCARE ),
	MAT_CONSERVATION => array ( SELECT ),
	MAT_DECORATIVE => array ( PAPERMAT )
);

public static $MatGroups = array (
	ALPHARAG_100_PERCENT_COTTON => array ( "B8605","B8606","B8607","B8614"),
	ALPHARAG_ARTCARE => array ( "B8634","B863412P","B8634L","B8640","B86408P","B8640L","B8641","B8642"),
	SELECT => array ( "C89500","C89501","C89502","C89505","C89506","C89507","C89508","C89510","C89511"),
	PAPERMAT => array ( "C1000","C1001","C1002","C1007","C1008","C1009","C1013","C1014","C1015",)
);

public static $Mat = array (
	"B8605" => array ( "ffffff",MAT_32X40,8.17,"B8605",1,"White"),
	"B8605" => array ( "ffffff",MAT_32X40,8.17,"B8605",1,"White"),
	"B8606" => array ( "FFF4DA",MAT_32X40,8.17,"B8606",1,"Ivory"),
	... more mats
	"B8606" => array ( "FFF4DA",MAT_32X40,8.17,"B8606",1,"Ivory"),
	"B8607" => array ( "ffffff",MAT_32X40,18.14,"B8607",1,"White"),
	"B8607L" => array ( "ffffff",MAT_40X60,18.14,"B8607",1,"White")
);
public static function GetMatDescription ( $MatNo ) 
{
	if ( array_key_exists ( $MatNo, self::$Mat) )
		return self::$Mat [ $MatNo ] [ 4 ];
}

}
?>

Still a lot to do.

For example, lines like

return self::$Mat [ $MatNo ] [ 4 ];

will be replaced with an appropriate define like

return self::$Mat [ $MatNo ] [ COL_ DESCRIPTION ];

[Shrike]

I've only glanced through this thread, but really there is virtually never a need to generate code on the fly. Data is data, and code is code. Mixing the two up leads to confusion and hair loss. Leaving aside the fact that your class doesn't really need to be a class, what if you, or your successor want to extend the class? They write a generator for that too?

Premature optimization has already been mentioned, but that is clearly what you still have. Your class has become massively complex in the name of a speed optimization. Optimization should always come last - its far easier to spot the bottlenecks in a complete class, or even a complete application.

Make it work, make it right, make it fast.